API:TomeGetSigilTOC
From RoR Wiki
UI Lua API · Tome functions
Version: WAR 1.4.8
Returns the list of sigils for the Tome of Knowledge Old World Armory, with the unlock state of each sigil fragment.
sigils = TomeGetSigilTOC()
Arguments
None.
Returns
- sigils
table– Array of sigil tables, indexed from 1.
Each sigil table:
| Key | Type | Meaning |
|---|---|---|
id |
number |
Sigil entry id, as used by TomeGetSigilEntry. |
name |
wstring |
Short name of the sigil; empty if the name table is not loaded. |
displayIndex |
number |
Position of the sigil in the stock UI's grid (the stock UI uses displayIndex - 1 as the cell number).
|
fragments |
table |
Array of the sigil's fragments (see below). |
Each fragment table in fragments:
| Key | Type | Meaning |
|---|---|---|
id |
number |
Fragment id. |
index |
number |
Position of the fragment within the sigil. |
iconNum |
number |
Icon id for GetIconData. |
isUnlocked |
boolean |
Whether the player has unlocked the fragment. |
Details
- All sigils are listed, locked or not.
Errors
None.
Example
From default/ea_tomeofknowledge/source/tomewindow_oldworldarmory_sigils.lua:
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 )