Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:50:12Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=TextLog}}
Turns on or off writing each new entry of a text log to a file.

<pre>
TextLogSetIncrementalSaving(logName, enabled, fileName)
</pre>

== Arguments ==
;logName : <code>string</code> – Name of the text log.
;enabled : <code>boolean</code> – <code>true</code> to write new entries to the file.
;fileName : <code>wstring</code> – Path of the log file, for example <code>L"logs/uilog.log"</code>.

== Returns ==
Nothing.

== Details ==
* When <code>fileName</code> differs from the file the log already uses, the client opens the new file:
** The path must be inside the client's log directory. Otherwise the ''is not in the log directory'' error is raised.
** If the file already exists, it must be a UTF-16 file that starts with a byte-order mark. Otherwise the ''already exists and is not a unicode log file'' error is raised and the file is left alone.
* Calling again with the same file name does not reopen the file.
* The file is opened even when <code>enabled</code> is <code>false</code>. Entries are written only while <code>enabled</code> is <code>true</code> and the log itself is enabled ([[API:TextLogSetEnabled|TextLogSetEnabled]]).
* Each entry is written as one line: <code>[YY/MM/DD][HH:MM:SS] </code> followed by the filter name and the text, with nothing between them, ended by a carriage return and line feed. The filter name is the name given with [[API:TextLogAddFilterType|TextLogAddFilterType]], or nothing.
* Only entries added after this call are written. Existing entries are not saved.
* <code>enabled</code> must be a real boolean.

== Errors ==
* <code>Error in function call 'TextLogSetIncrementalSaving': Text Log %s does not exist</code>
* <code>Error in function call 'TextLogSetIncrementalSaving': File '%s' is not in the log directory '%s'.</code>
* <code>Error in function call 'TextLogSetIncrementalSaving': File '%s' already exists and is not a unicode log file. You may not write to this file.</code>

== Example ==
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:TextLogGetIncrementalSaving|TextLogGetIncrementalSaving]]
* [[API:TextLogLoadFromFile|TextLogLoadFromFile]]
* [[API:TextLogSaveLog|TextLogSaveLog]]

API:TextLogSetIncrementalSaving - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)