Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:50:10Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=TextLog}}
Turns a text log on or off.

<pre>
TextLogSetEnabled(logName, enabled)
</pre>

== Arguments ==
;logName : <code>string</code> – Name of the text log.
;enabled : <code>boolean</code> – <code>true</code> to accept new entries, <code>false</code> to drop them.

== Returns ==
Nothing.

== Details ==
* While a log is disabled, entries added to it are thrown away: they are not stored, not saved to file and do not fire the update event. Entries already in the log stay.
* Logs start enabled when created with [[API:TextLogCreate|TextLogCreate]].
* <code>enabled</code> must be a real boolean. Passing <code>nil</code> or a number raises an ''Invalid Parameters'' error.
* The function needs at least two arguments and only reads the last two. Any extra arguments placed in front of them are ignored.

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

== Example ==
From <code>interfacecore/interfacecore.lua</code>:
<pre>
TextLogSetEnabled( "System", true )
</pre>

Switching the UI debug log on together with file saving, from <code>ea_uidebugtools/source/debugwindow.lua</code>:
<pre>
TextLogSetIncrementalSaving( "UiLog", DebugWindow.Settings.logsOn, L"logs/uilog.log");
TextLogSetEnabled( "UiLog", DebugWindow.Settings.logsOn )
</pre>

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

API:TextLogSetEnabled - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)