Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:46:53Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=LogDisplay}}
Stops a LogDisplay window from showing a text log.

<pre>
LogDisplayRemoveLog(displayName, logName)
</pre>

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

== Returns ==
Nothing.

== Details ==
* The log's lines are removed from the display and the display stops receiving its new entries. The text log itself is not changed.
* The display forgets the filter states and colours it had for this log. Adding the log again with [[API:LogDisplayAddLog|LogDisplayAddLog]] starts with all filter types enabled and white.
* If the log is not shown in the display, the call does nothing. The ''is not being displayed'' error is only raised while the client's <code>"UiLog"</code> text log exists and is enabled.
* The function needs at least two arguments and only reads the last two. Any extra arguments placed in front of them are ignored.
* The stock UI never calls this function.

== Errors ==
* <code>Error in function call 'TextLogDisplayRemoveLog': Window %s does not exist</code>
* <code>Error in function call 'TextLogDisplayRemoveLog': Window %s is not a TextLogDisplay</code>
* <code>Error in function call 'TextLogDisplayRemoveLog': Log %s is not being displayed in %s</code> (only when <code>"UiLog"</code> is enabled)

== Example ==
A minimal example built from the documented signature:
<pre>
LogDisplayRemoveLog( "MyAddonLogDisplay", "Combat" )
</pre>

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

API:LogDisplayRemoveLog - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)