Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:49:57Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=TextLog}}
Adds a line of text to a text log, taking the text as an ordinary Lua string.

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

== Arguments ==
;logName : <code>string</code> – Name of the text log.
;filterType : <code>number</code> – Filter type of the entry. Cut to a whole number.
;text : <code>string</code> – The text, as a plain Lua string (not a wide string).

== Returns ==
Nothing.

== Details ==
* This is [[API:TextLogAddEntry|TextLogAddEntry]] for single-byte text. Each byte of <code>text</code> becomes one character; there is no UTF-8 decoding, so only plain ASCII text comes out as written.
* The text is cut to 1023 characters.
* 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> </code> and <code> </code> become a line break and <code></code> and <code></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.
* The stock UI never calls this function.

== Errors ==
* <code>Error in function call 'TextLogAddEntry': Text Log %s does not exist</code> The message names <code>TextLogAddEntry</code>, not this function.

== Example ==
A minimal example built from the signature above:
<pre>
TextLogAddSingleByteEntry( "Chat", SystemData.ChatLogFilters.MISC, "Hello" )
</pre>

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

API:TextLogAddSingleByteEntry - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)