Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:50:07Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=TextLog}}
Returns the ID of the event that fires when a text log changes.

<pre>
eventId = TextLogGetUpdateEventId(logName)
</pre>

== Arguments ==
;logName : <code>string</code> – Name of the text log.

== Returns ==
;eventId : <code>number</code> – Event ID to pass to <code>RegisterEventHandler</code>.

== Details ==
* Every text log gets its own event ID when it is created.
* The handler receives two arguments: <code>updateType</code> and <code>filterType</code>.
** <code>updateType</code> is one of <code>SystemData.TextLogUpdate.ADDED</code> (0), <code>REMOVED</code> (1) or <code>CLEAR</code> (2).
** An entry added with [[API:TextLogAddEntry|TextLogAddEntry]] fires <code>ADDED</code> with the entry's filter type. [[API:TextLogClear|TextLogClear]] fires <code>CLEAR</code>.
* Entries dropped because the log is disabled do not fire the event.

== Errors ==
* <code>Error in function call 'TextLogGetUpdateEventId': Text Log %s does not exist</code>

== Example ==
Flashing chat tabs on new text, from <code>ea_chatwindow/source/chatwindow.lua</code>:
<pre>
local function RegisterTextLogUpdate( textLog )
-- Register text log update events so we can flash tabs
local chatLogEventId = TextLogGetUpdateEventId( textLog )
RegisterEventHandler( chatLogEventId, "EA_ChatWindow.OnTextLogUpdated" )
end

function EA_ChatWindow.OnTextLogUpdated( updateType, filterType )
if( updateType ~= SystemData.TextLogUpdate.ADDED )
then
return
end
...
end
</pre>

== See also ==
* [[API:TextLogAddEntry|TextLogAddEntry]]
* [[API:TextLogClear|TextLogClear]]

API:TextLogGetUpdateEventId - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)