Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:50:39Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Tome}}
Returns the list of sigils for the Tome of Knowledge Old World Armory, with the unlock state of each sigil fragment.

<pre>
sigils = TomeGetSigilTOC()
</pre>

== Arguments ==
None.

== Returns ==
;sigils : <code>table</code> – Array of sigil tables, indexed from 1.

Each sigil table:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Sigil entry id, as used by [[API:TomeGetSigilEntry|TomeGetSigilEntry]].
|-
| <code>name</code> || <code>wstring</code> || Short name of the sigil; empty if the name table is not loaded.
|-
| <code>displayIndex</code> || <code>number</code> || Position of the sigil in the stock UI's grid (the stock UI uses <code>displayIndex - 1</code> as the cell number).
|-
| <code>fragments</code> || <code>table</code> || Array of the sigil's fragments (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>iconNum</code> || <code>number</code> || Icon id for [[API:GetIconData|GetIconData]].
|-
| <code>isUnlocked</code> || <code>boolean</code> || Whether the player has unlocked the fragment.
|}

== Details ==
* All sigils are listed, locked or not.

== Errors ==
None.

== Example ==
From <code>default/ea_tomeofknowledge/source/tomewindow_oldworldarmory_sigils.lua</code>:
<pre>
local sigilTOC = TomeGetSigilTOC()
...
local cellNum = sigilData.displayIndex - 1
...
WindowSetId( sigilEntryWindowName..index, sigilData.id )
LabelSetText( sigilEntryWindowName..index.."Name", sigilData.name )
...
for fragIndex, fragmentData in ipairs( sigilData.fragments )
do
local texture, x, y = GetIconData( fragmentData.iconNum )
DynamicImageSetTexture( fragmentWindow..fragmentData.index, texture, x, y )
...
if( fragmentData.isUnlocked )
</pre>

== See also ==
* [[API:TomeGetSigilEntry|TomeGetSigilEntry]]
* [[API:TomeGetSigilDisplayInfo|TomeGetSigilDisplayInfo]]
* [[API:TomeGetOldWorldArmoryTierTOC|TomeGetOldWorldArmoryTierTOC]]

API:TomeGetSigilTOC - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)