Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:49:55Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=TextLog}}
Adds a line of text to a text log.

<pre>
TextLogAddEntry(logName, filterType, text)
</pre>

== Arguments ==
;logName : <code>string</code> – Name of the text log, for example <code>"Chat"</code>.
;filterType : <code>number</code> – Filter type of the entry. Cut to a whole number. For the chat logs these are the values in <code>SystemData.ChatLogFilters</code>.
;text : <code>wstring</code> – The text. It must be a wide string.

== Returns ==
Nothing.

== Details ==
* Nothing is added if the log is disabled ([[API:TextLogSetEnabled|TextLogSetEnabled]]) or if the entry's filter type is switched off in the log.
* If the log already holds as many entries as its entry limit, the oldest entries are removed first. A log with an entry limit of 0 stores nothing.
* In the text, <code><BR></code> and <code><br></code> become a line break and <code><P></code> and <code><p></code> become two line breaks.
* The entry is stamped with the local time (shown by [[API:LogDisplaySetShowTimestamp|LogDisplaySetShowTimestamp]] and returned by [[API:TextLogGetEntry|TextLogGetEntry]]).
* If incremental saving is on (see [[API:TextLogSetIncrementalSaving|TextLogSetIncrementalSaving]]), the entry is also written to the log file as <code>[YY/MM/DD][HH:MM:SS] </code> followed by the filter name and the text, with nothing between them.
* The log's update event (see [[API:TextLogGetUpdateEventId|TextLogGetUpdateEventId]]) fires with <code>SystemData.TextLogUpdate.ADDED</code> and the filter type.
* Every LogDisplay that shows the log picks up the new entry.

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

== Example ==
Printing a message to the chat window, from <code>easystem_utils/source/mailutils.lua</code>:
<pre>
TextLogAddEntry( "Chat", SystemData.ChatLogFilters.MISC, displayString )
</pre>

Filling an addon-created log, from <code>interfacecore/source/eularocwindow.lua</code>:
<pre>
for index = 0, #StringTables.EULAROC
do
TextLogAddEntry( "EULAROCLog", 1, GetStringFromTable( "EULAROC", index ) )
end
</pre>

== See also ==
* [[API:TextLogAddSingleByteEntry|TextLogAddSingleByteEntry]]
* [[API:TextLogAddFilterType|TextLogAddFilterType]]
* [[API:TextLogGetEntry|TextLogGetEntry]]
* [[API:TextLogClear|TextLogClear]]

API:TextLogAddEntry - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)