Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:46:41Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=LogDisplay}}
Makes a LogDisplay window show the entries of a text log.

<pre>
LogDisplayAddLog(displayName, logName, showExisting)
</pre>

== Arguments ==
;displayName : <code>string</code> – Name of a LogDisplay window.
;logName : <code>string</code> – Name of the text log, for example <code>"Chat"</code>.
;showExisting : <code>boolean</code> – <code>true</code> to also show the entries already in the log. With <code>false</code> only entries added afterwards appear.

== Returns ==
Nothing.

== Details ==
* A LogDisplay can show several logs at once; the chat tabs show <code>"Chat"</code>, <code>"Combat"</code> and <code>"System"</code> together.
* The display copies the log's filter types (see [[API:TextLogAddFilterType|TextLogAddFilterType]]) when the log is added. Each starts enabled and white. Set them with [[API:LogDisplaySetFilterState|LogDisplaySetFilterState]] and [[API:LogDisplaySetFilterColor|LogDisplaySetFilterColor]].
* When the display shows log names ([[API:LogDisplaySetShowLogName|LogDisplaySetShowLogName]]), the name appears as <code>[''logName'']</code>.
* The display keeps itself up to date: new entries in the log appear without further calls.
* If the log is already shown in this display, or the log does not exist, the call does nothing. The matching errors below are only raised while the client's <code>"UiLog"</code> text log exists and is enabled; otherwise the call fails silently.

== Errors ==
* <code>Error in function call 'TextLogDisplayAddLog': Window %s does not exist</code>
* <code>Error in function call 'TextLogDisplayAddLog': Window %s is not a TextLogDisplay</code>
* <code>Error in function call 'TextLogDisplayAddLog': Log %s is already being displayed in %s</code>
* <code>Error in function call 'TextLogDisplayAddLog': Log %s does not exist</code>
: The last two only when <code>"UiLog"</code> is enabled, see Details.

== Example ==
From <code>ea_chatwindow/source/chatwindow.lua</code>:
<pre>
-- add the Chat and Combat Log to the display
LogDisplayAddLog( tabLogDisplayName, "Chat", true )
LogDisplayAddLog( tabLogDisplayName, "Combat", true )
LogDisplayAddLog( tabLogDisplayName, "System", true )
</pre>

== See also ==
* [[API:LogDisplayRemoveLog|LogDisplayRemoveLog]]
* [[API:TextLogCreate|TextLogCreate]]
* [[API:LogDisplaySetFilterState|LogDisplaySetFilterState]]
* [[API:LogDisplaySetFilterColor|LogDisplaySetFilterColor]]

API:LogDisplayAddLog - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)