Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:50:38Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Tome}}
Returns the Tome of Knowledge page of a sigil: its texts and its fragments with their tasks.

<pre>
sigilData = TomeGetSigilEntry(sigilEntryId)
</pre>

== Arguments ==
;sigilEntryId : <code>number</code> – Sigil entry id, as in [[API:TomeGetSigilTOC|TomeGetSigilTOC]]. Only the low 16 bits are used.

== Returns ==
;sigilData : <code>table</code> – The sigil's data, or nothing if the id is invalid or the player is not in the world.

{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Sigil entry id.
|-
| <code>fullname</code> || <code>wstring</code> || Full name of the sigil.
|-
| <code>description</code> || <code>wstring</code> || Description.
|-
| <code>fragmentsTitle</code> || <code>wstring</code> || Heading of the fragment list.
|-
| <code>fragmentsDescription</code> || <code>wstring</code> || Text of the fragment list.
|-
| <code>fragments</code> || <code>table</code> || Array of fragment tables (see below).
|}

Each fragment table in <code>fragments</code>:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Fragment id.
|-
| <code>index</code> || <code>number</code> || Position of the fragment within the sigil.
|-
| <code>numTasks</code> || <code>number</code> || Number of tasks of the fragment.
|-
| <code>iconNum</code> || <code>number</code> || Icon id for [[API:GetIconData|GetIconData]].
|-
| <code>isUnlocked</code> || <code>boolean</code> || Whether the player has unlocked the fragment.
|-
| <code>name</code> || <code>wstring</code> || Fragment name.
|-
| <code>taskDescription</code> || <code>wstring</code> || Text shown above the task list.
|-
| <code>tasks</code> || <code>table</code> || Array of task tables with <code>isCompleted</code> (<code>boolean</code>), <code>name</code> (<code>wstring</code>), <code>counterValue</code> and <code>counterMax</code> (<code>number</code>; both <code>0</code> for a task without a counter).
|}

== Details ==
* Texts come from the client's string tables; they are empty wide strings if a table is not loaded.
* Exactly one argument must be passed.

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

== Example ==
From <code>default/ea_tomeofknowledge/source/tomewindow_sigils.lua</code>:
<pre>
local sigilData = TomeGetSigilEntry( sigilEntryId )
if( not sigilData or not sigilData.id )
...
LabelSetText(PARENT_WINDOW.."SigilTitle", sigilData.fullname )
LabelSetText(PARENT_WINDOW.."SigilDesc", sigilData.description )
LabelSetText(PARENT_WINDOW.."FragmentsTitle", sigilData.fragmentsTitle )
LabelSetText(PARENT_WINDOW.."FragmentsDesc", sigilData.fragmentsDescription )
</pre>

From the same file, the task list of a fragment:
<pre>
for index, task in ipairs( fragment.tasks )
do
...
local taskText = task.name
if( task.counterMax > 0 )
then
taskText = GetStringFormat( StringTables.Default.LABEL_SIGIL_FRAGMENT_TASKNAME_AND_COUNTER, {taskText, task.counterValue, task.counterMax} )
end
...
ButtonSetPressedFlag( taskWindowName.."CompletedBtn", task.isCompleted )
</pre>

== See also ==
* [[API:TomeGetSigilTOC|TomeGetSigilTOC]]
* [[API:TomeGetSigilDisplayInfo|TomeGetSigilDisplayInfo]]

API:TomeGetSigilEntry - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)