Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:50:19Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Tome}}
Returns the table of contents of the Tome of Knowledge bestiary: every creature type with its subtypes.

<pre>
types = TomeGetBestiaryTOC()
</pre>

== Arguments ==
None.

== Returns ==
;types : <code>table</code> – Array of creature types. The stock UI sorts it by name itself.

Each type table:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Type id.
|-
| <code>name</code> || <code>wstring</code> || Type name.
|-
| <code>subtypes</code> || <code>table</code> || Array of the type's subtypes (see below).
|}

Each subtype table in <code>subtypes</code>:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Subtype id, as used by [[API:TomeGetBestiarySubTypeData|TomeGetBestiarySubTypeData]].
|-
| <code>name</code> || <code>wstring</code> || Subtype name.
|-
| <code>isUnlocked</code> || <code>boolean</code> || <code>true</code> if at least one species of the subtype is unlocked (see [[API:TomeIsBestiarySubTypeUnlocked|TomeIsBestiarySubTypeUnlocked]]).
|-
| <code>killCount</code> || <code>number</code> || The player's kill count for the subtype.
|}

== Details ==
* All types and subtypes are listed, including locked ones. Names are filled in for locked subtypes too.
* If the name tables are not loaded, names are empty wide strings.

== Errors ==
None.

== Example ==
From <code>ea_tomeofknowledge/source/tomewindow_bestiary.lua</code>:
<pre>
TomeWindow.Bestiary.TOCData = TomeGetBestiaryTOC()
...
for typeIndex, typeData in ipairs( TomeWindow.Bestiary.TOCData ) do
...
for subTypeIndex, subTypeData in ipairs( typeData.subtypes ) do
local killText = L""..subTypeData.killCount
TomeWindow.SetTOCItemText( subTypeWindowName, subTypeData.id, subTypeData.name, killText )
ButtonSetDisabledFlag( subTypeWindowName.."Text", subTypeData.isUnlocked == false )
end
end
</pre>

== See also ==
* [[API:TomeGetBestiarySubTypeData|TomeGetBestiarySubTypeData]]
* [[API:TomeIsBestiarySubTypeUnlocked|TomeIsBestiarySubTypeUnlocked]]
* [[API:TomeGetBestiarySpeciesData|TomeGetBestiarySpeciesData]]

API:TomeGetBestiaryTOC - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)