Skip to content

Return of Reckoning

Wiki

RoR Wiki

API:TextLogClear

From RoR Wiki

UI Lua API · TextLog functions
Version: WAR 1.4.8

Removes all entries from a text log.

TextLogClear(logName)

Arguments

logName
string – Name of the text log.

Returns

Nothing.

Details

  • The log itself, its filter types and its settings stay. Only the entries are removed.
  • The log's update event (see TextLogGetUpdateEventId) fires with SystemData.TextLogUpdate.CLEAR.
  • Works on the client's own logs too, for example "Chat".

Errors

  • Error in function call 'TextLogClear': Text Log %s does not exist

Example

From ea_helpwindow/source/editappealwindow.lua:

function EditAppealWindow.UpdateHelpLog(log)
    TextLogClear("AppealLog")
    ...
end

See also