API:LogDisplayRemoveLog

UI Lua API · LogDisplay functions
Version: WAR 1.4.8

Stops a LogDisplay window from showing a text log.

LogDisplayRemoveLog(displayName, logName)

Arguments

displayName

string – Name of a LogDisplay window.

logName

string – 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 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 "UiLog" 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

• Error in function call 'TextLogDisplayRemoveLog': Window %s does not exist
• Error in function call 'TextLogDisplayRemoveLog': Window %s is not a TextLogDisplay
• Error in function call 'TextLogDisplayRemoveLog': Log %s is not being displayed in %s (only when "UiLog" is enabled)

Example

A minimal example built from the documented signature:

LogDisplayRemoveLog( "MyAddonLogDisplay", "Combat" )

See also

• LogDisplayAddLog