Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:50:45Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Tome}}
Returns the full data of an unlocked War Journal entry: story texts, activities with their tasks, and glyph activities.

<pre>
entryData = TomeGetWarJournalEntryData(entryId)
</pre>

== Arguments ==
;entryId : <code>number</code> – Entry id, as in the <code>entries</code> list of [[API:TomeGetWarJournalStorylineData|TomeGetWarJournalStorylineData]].

== Returns ==
;entryData : <code>table</code> – The entry's data, or nothing if the id is invalid or the entry is still locked.

{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Entry id.
|-
| <code>storylineId</code> || <code>number</code> || Id of the storyline the entry belongs to.
|-
| <code>storylineName</code> || <code>wstring</code> || Storyline name (see Details).
|-
| <code>displayIndex</code> || <code>number</code> || Position of the entry within its storyline.
|-
| <code>title</code> || <code>wstring</code> || Entry title.
|-
| <code>name</code> || <code>wstring</code> || Entry name.
|-
| <code>npcName</code> || <code>wstring</code> || Name of the NPC of the entry.
|-
| <code>locationText</code> || <code>wstring</code> || Location text.
|-
| <code>storyText</code> || <code>wstring</code> || The story text.
|-
| <code>influenceId</code> || <code>number</code> || Influence id of the entry.
|-
| <code>zoneId</code> || <code>number</code> || Zone of the entry.
|-
| <code>zoneAreaId</code> || <code>number</code> || Zone area of the entry.
|-
| <code>activities</code> || <code>table</code> || Array of activities (see below).
|-
| <code>glyphActivities</code> || <code>table</code> || Array of glyph activities (see below).
|}

Each activity in <code>activities</code>:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Activity id.
|-
| <code>type</code> || <code>number</code> || Activity type.
|-
| <code>typeName</code> || <code>wstring</code> || Name of the activity type.
|-
| <code>zoneId</code>, <code>zoneAreaId</code> || <code>number</code> || Where the activity takes place.
|-
| <code>name</code> || <code>wstring</code> || Activity name.
|-
| <code>text</code> || <code>wstring</code> || Activity text.
|-
| <code>tasks</code> || <code>table</code> || Array of tasks, each with <code>isComplete</code> (<code>boolean</code>), <code>name</code> (<code>wstring</code>) and <code>text</code> (<code>wstring</code>). The name of a task that is not complete is a placeholder and its text is empty.
|}

Each glyph activity in <code>glyphActivities</code>:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Glyph activity id.
|-
| <code>name</code> || <code>wstring</code> || Name.
|-
| <code>text</code> || <code>wstring</code> || Text.
|-
| <code>glyphLines</code> || <code>table</code> || Array of glyph lines, each with <code>id</code> (<code>number</code>), <code>name</code> (<code>wstring</code>) and <code>glyphs</code> (<code>table</code>).
|}

Each glyph in <code>glyphLines[n].glyphs</code>:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Glyph id.
|-
| <code>name</code> || <code>wstring</code> || Glyph name.
|-
| <code>tooltipText</code> || <code>wstring</code> || Tooltip text.
|-
| <code>isUnlocked</code> || <code>boolean</code> || Whether the glyph is unlocked.
|-
| <code>textureName</code> || <code>string</code> || Name of the glyph's texture.
|-
| <code>tooltipItems</code> || <code>table</code> || Array of <code>wstring</code> lines for the tooltip. Missing when the client's tooltip text table is not loaded.
|}

== Details ==
* Check with [[API:TomeIsWarJournalEntryUnlocked|TomeIsWarJournalEntryUnlocked]] first, as the stock UI does.
* An activity is only listed once the player's progress flag for it is set. The same kind of flag, per task, gives each task's <code>isComplete</code>.
* <code>storylineName</code> is looked up in the storyline-name table with the '''entry''' id, not the storyline id, so it may not be the name of the entry's storyline. Use the <code>name</code> from [[API:TomeGetWarJournalStorylineData|TomeGetWarJournalStorylineData]] for <code>storylineId</code> instead.

== Errors ==
These are written to the UI log, and the function returns nothing.
* <code>Error in function call 'TomeGetWarJournalEntryData': %d is not a valid entry id.</code>
* <code>Error in function call 'TomeGetWarJournalEntryData': You have not yet unlocked entry # %d.</code>

== Example ==
From <code>ea_tomeofknowledge/source/tomewindow_warjournal.lua</code>:
<pre>
local entryData = TomeGetWarJournalEntryData( entryId )
-- If we are showing an entry that has a glyph activity have that be selected first
-- Instead of the story
if( entryData and
entryData.glyphActivities and
entryData.glyphActivities[1] )
then
glyphActivityId = entryData.glyphActivities[1].id
end
</pre>

The glyph display caches the result, from <code>easystem_glyphdisplay/source/glyphdisplay.lua</code>:
<pre>
local entryData = TomeGetWarJournalEntryData( entryId )
if entryData ~= nil
then
GlyphDisplay.cachedJournalEntries[entryId] = entryData
return entryData
end
</pre>

== See also ==
* [[API:TomeIsWarJournalEntryUnlocked|TomeIsWarJournalEntryUnlocked]]
* [[API:TomeGetWarJournalStorylineData|TomeGetWarJournalStorylineData]]
* [[API:TomeSetWarJournalEntryImage|TomeSetWarJournalEntryImage]]

API:TomeGetWarJournalEntryData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)