Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:50:28Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Tome}}
Returns the table of contents of the Tome of Knowledge Noteworthy Persons section: the zone pairings, split into tiers, with their zones.

<pre>
pairings = TomeGetNoteworthyPersonsTOC()
</pre>

== Arguments ==
None.

== Returns ==
;pairings : <code>table</code> – Array of zone pairings.

Each pairing table:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Pairing id.
|-
| <code>name</code> || <code>wstring</code> || Pairing name.
|-
| <code>tiers</code> || <code>table</code> || Array of exactly four tier tables, for tiers 1 to 4. Each has one key, <code>zones</code>.
|}

Each zone table in <code>tiers[n].zones</code>:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Zone id, as used by [[API:TomeGetNoteworthyPersonsZoneData|TomeGetNoteworthyPersonsZoneData]].
|-
| <code>name</code> || <code>wstring</code> || Zone name.
|}

== Details ==
* All pairings and zones of the section are listed, whether or not the player has unlocked anything there.
* A tier with no zones has an empty <code>zones</code> table.
* If the name tables are not loaded, names are empty wide strings.

== Errors ==
None.

== Example ==
From <code>ea_tomeofknowledge/source/tomewindow_noteworthypersons.lua</code>:
<pre>
TomeWindow.NoteworthyPersons.TOCData = TomeGetNoteworthyPersonsTOC()

-- Sorth the pairing and zones lists by their names
for pairingIndex, pairingData in ipairs( TomeWindow.NoteworthyPersons.TOCData ) do
for tierIndex, tierData in ipairs( pairingData.tiers ) do
table.sort( tierData.zones, DataUtils.AlphabetizeByNames )
end
end
</pre>

== See also ==
* [[API:TomeGetNoteworthyPersonsZoneData|TomeGetNoteworthyPersonsZoneData]]
* [[API:TomeGetNoteworthyPersonsEntryData|TomeGetNoteworthyPersonsEntryData]]

API:TomeGetNoteworthyPersonsTOC - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)