Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:45:13Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Game}}
Returns the player's pending Tome of Knowledge alerts (new Tome entries).

<pre>
alerts = GetTomeAlertsData()
</pre>

== Arguments ==
None.

== Returns ==
;alerts : <code>table</code> – Array of alert tables, indexed from 1. Empty if there are no alerts.

Each alert table has these fields:
{| class="wikitable"
! Key !! Type !! Meaning
|-
| <code>id</code> || <code>number</code> || Alert id. The stock UI passes it to [[API:RemoveTomeAlert|RemoveTomeAlert]].
|-
| <code>alertType</code> || <code>number</code> || —
|-
| <code>section</code> || <code>number</code> || Tome section, compared with <code>GameData.Tome.SECTION_*</code> values.
|-
| <code>entry</code> || <code>number</code> || Entry within the section.
|-
| <code>subEntry</code> || <code>number</code> || Sub-entry within the entry.
|-
| <code>name</code> || <code>wstring</code> || Title of the alert.
|-
| <code>desc</code> || <code>wstring</code> || Description text.
|-
| <code>xp</code> || <code>number</code> || Experience reward.
|-
| <code>rewardType</code> || <code>number</code> || —
|-
| <code>rewardId</code> || <code>number</code> || —
|-
| <code>suppressPopup</code> || <code>boolean</code> || <code>true</code> if no pop-up should be shown for this alert.
|}

== Details ==
* The client holds up to 20 alerts. The list ends at the first empty slot, so the table has at most 20 entries.
* If there is no player object, or the Lua state is not available, the function returns nothing.
* A new table is built on every call. The stock UI caches it in <code>DataUtils.GetTomeAlerts()</code> (<code>easystem_utils/source/datautils.lua</code>) and rebuilds it only when <code>GameData.Player.tomeAlertsDirty</code> is set.

== Errors ==
None.

== Example ==
From <code>easystem_utils/source/datautils.lua</code>:
<pre>
function DataUtils.GetTomeAlerts()
if( GameData.Player.tomeAlertsDirty ) then
DataUtilsData.tomeAlerts = GetTomeAlertsData()
GameData.Player.tomeAlertsDirty = false
end
return DataUtilsData.tomeAlerts
end
</pre>

Using the fields, from <code>ea_tomealertwindow/source/tomealertwindow.lua</code>:
<pre>
local alert = NewAlertData( tomeAlerts[1].section,
tomeAlerts[1].entry,
tomeAlerts[1].subEntry,
tomeAlerts[1].name,
tomeAlerts[1].desc,
tomeAlerts[1].xp )

-- Don't queue the alert for invalid sections or if the suppression flag is set
if( tomeAlerts[1].section ~= 0 and tomeAlerts[1].suppressPopup == false )
then
TomeAlertWindow.QueueAlert( alert )
end
</pre>

== See also ==
* [[API:RemoveTomeAlert|RemoveTomeAlert]]

API:GetTomeAlertsData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)