API:TextLogGetIncrementalSaving
From RoR Wiki
UI Lua API · TextLog functions
Version: WAR 1.4.8
Returns whether a text log writes its new entries to a file.
saving = TextLogGetIncrementalSaving(logName)
Arguments
- logName
string– Name of the text log.
Returns
- saving
boolean– The flag set by TextLogSetIncrementalSaving.
Details
- This returns the flag only. It does not tell whether a file was opened successfully.
- The stock UI never calls this function.
Errors
Error in function call 'TextLogGetIncrementalSaving': Text Log %s does not exist
Example
A minimal example built from the documented signature:
if not TextLogGetIncrementalSaving( "UiLog" ) then
TextLogSetIncrementalSaving( "UiLog", true, L"logs/uilog.log" )
end