Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:50:31Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Tome}}
Returns the Noteworthy Persons page of a zone: its text and the list of entries.

<pre>
zoneData = TomeGetNoteworthyPersonsZoneData(zoneId)
</pre>

== Arguments ==
;zoneId : <code>number</code> – Zone id, as in the <code>zones</code> lists of [[API:TomeGetNoteworthyPersonsTOC|TomeGetNoteworthyPersonsTOC]].

== Returns ==
;zoneData : <code>table</code> – The zone's data, or nothing if the zone id is not valid.

{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Zone id.
|-
| <code>tierId</code> || <code>number</code> || Tier of the zone (1–4).
|-
| <code>name</code> || <code>wstring</code> || Zone name.
|-
| <code>text</code> || <code>wstring</code> || Introductory text of the zone; may be empty.
|-
| <code>entries</code> || <code>table</code> || Array of the zone's entries (see below).
|}

Each entry table in <code>entries</code>:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Entry id for [[API:TomeGetNoteworthyPersonsEntryData|TomeGetNoteworthyPersonsEntryData]]. <code>0</code> if the entry is locked.
|-
| <code>unlockEventId</code> || <code>number</code> || Only for unlocked entries: id of the unlock event. The stock UI uses it for the "bragging rights" context menu.
|-
| <code>name</code> || <code>wstring</code> || Entry name. Filled in for locked entries too.
|-
| <code>isUnlocked</code> || <code>boolean</code> || Whether the player has unlocked the entry.
|}

== Details ==
* Entries meant for the other realm are left out. Entries for both realms are always listed.
* Locked entries are listed with <code>id = 0</code> and no <code>unlockEventId</code>.

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

== Example ==
From <code>ea_tomeofknowledge/source/tomewindow_noteworthypersons.lua</code>:
<pre>
TomeWindow.NoteworthyPersons.curZoneData = TomeGetNoteworthyPersonsZoneData( zoneId )
if( TomeWindow.NoteworthyPersons.curZoneData == nil ) then
...
return
end
...
for entryIndex, entryData in ipairs( TomeWindow.NoteworthyPersons.curZoneData.entries ) do
...
end
</pre>

== See also ==
* [[API:TomeGetNoteworthyPersonsTOC|TomeGetNoteworthyPersonsTOC]]
* [[API:TomeGetNoteworthyPersonsEntryData|TomeGetNoteworthyPersonsEntryData]]
* [[API:TomeIsNoteworthyPersonsEntryUnlocked|TomeIsNoteworthyPersonsEntryUnlocked]]

API:TomeGetNoteworthyPersonsZoneData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)