https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3ATomeGetWarJournalStorylineDataAPI:TomeGetWarJournalStorylineData - Revision history2026-10-25T15:59:54ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:TomeGetWarJournalStorylineData&diff=30827&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:50:47Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Tome}}<br />
Returns a War Journal storyline with its list of entries (chapters).<br />
<br />
<pre><br />
storylineData = TomeGetWarJournalStorylineData(storylineId)<br />
</pre><br />
<br />
== Arguments ==<br />
;storylineId : <code>number</code> – Storyline id, from [[API:TomeGetWarJournalAvailiableStorylines|TomeGetWarJournalAvailiableStorylines]].<br />
<br />
== Returns ==<br />
;storylineData : <code>table</code> – The storyline's data, or nothing if the id is invalid or the storyline is still locked.<br />
<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>id</code> || <code>number</code> || Storyline id.<br />
|-<br />
| <code>name</code> || <code>wstring</code> || Storyline name.<br />
|-<br />
| <code>summary</code> || <code>wstring</code> || Summary text.<br />
|-<br />
| <code>entries</code> || <code>table</code> || Array of the storyline's entries (see below).<br />
|}<br />
<br />
Each entry table in <code>entries</code>:<br />
{| class="wikitable"<br />
! Key !! Type !! Meaning<br />
|-<br />
| <code>id</code> || <code>number</code> || Entry id, for [[API:TomeGetWarJournalEntryData|TomeGetWarJournalEntryData]].<br />
|-<br />
| <code>unlocked</code> || <code>boolean</code> || Whether the player has unlocked the entry.<br />
|-<br />
| <code>title</code> || <code>wstring</code> || Entry title.<br />
|-<br />
| <code>name</code> || <code>wstring</code> || Entry name. A placeholder text while the entry is locked.<br />
|-<br />
| <code>influenceId</code> || <code>number</code> || Influence id of the entry; <code>0</code> while the entry is locked.<br />
|}<br />
<br />
== Details ==<br />
* Locked entries are listed too; note that the field is <code>unlocked</code> here, not <code>isUnlocked</code> as elsewhere in the Tome.<br />
* Entries whose <code>displayIndex</code> (see [[API:TomeGetWarJournalEntryData|TomeGetWarJournalEntryData]]) is <code>0</code> are not listed.<br />
* The argument check is shared with [[API:TomeIsWarJournalStorylineUnlocked|TomeIsWarJournalStorylineUnlocked]]: if the argument is missing or not a number, the ''Invalid Parameters'' message names that function.<br />
<br />
== Errors ==<br />
These are written to the UI log, and the function returns nothing.<br />
* <code>Error in function call 'TomeGetWarJournalStorylineData': %d is not a valid storyline id.</code><br />
* <code>Error in function call 'TomeGetWarJournalStorylineData': You have not yet unlocked storyline # %d.</code><br />
<br />
== Example ==<br />
From <code>ea_tomeofknowledge/source/tomewindow_warjournal.lua</code>:<br />
<pre><br />
local function CacheStorylineData( storyId )<br />
TomeWindow.WarJournal.StorylinesData[storyId] = TomeGetWarJournalStorylineData( storyId )<br />
...<br />
end<br />
</pre><br />
<br />
== See also ==<br />
* [[API:TomeGetWarJournalAvailiableStorylines|TomeGetWarJournalAvailiableStorylines]]<br />
* [[API:TomeGetWarJournalEntryData|TomeGetWarJournalEntryData]]<br />
* [[API:TomeIsWarJournalStorylineUnlocked|TomeIsWarJournalStorylineUnlocked]]</div>Maintenance script