Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:48:11Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Tome}}
Removes an entry from the player's list of recent Tome of Knowledge alerts.

<pre>
RemoveTomeAlert(alertId)
</pre>

== Arguments ==
;alertId : <code>number</code> – ID of the alert, as given in the tome alert data (<code>alertData.id</code> in the stock UI).

== Returns ==
Nothing.

== Details ==
* The client keeps the 20 most recent tome alerts. If <code>alertId</code> is in that list, it is removed and the later entries move up. If it is not in the list, nothing happens.
* When an alert is removed:
** the updated list is sent to the server;
** <code>GameData.Player.tomeAlertsDirty</code> is set to <code>true</code>;
** <code>SystemData.Events.TOME_ALERTS_UPDATED</code> is raised twice in a row.
* Nothing happens if the player object does not exist yet.
* Exactly one argument must be passed.

== Errors ==
None besides the generic ''Invalid Parameters'' message when the argument is missing or not a number.

== Example ==
Clearing all alerts, from <code>default/ea_tomeofknowledge/source/tomewindow_titlepage.lua</code>:
<pre>
-- Clear all of the Tome Alerts
for index, id in ipairs( ids )
do
RemoveTomeAlert( id )
end
</pre>

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

API:RemoveTomeAlert - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)