API:LogDisplayGetShowFilterName

UI Lua API · LogDisplay functions
Version: WAR 1.4.8

Returns whether a LogDisplay window prints the filter type's name in front of each line.

show = LogDisplayGetShowFilterName(displayName)

Arguments

displayName

string – Name of a LogDisplay window.

Returns

show

boolean – The value set by LogDisplaySetShowFilterName.

Details

• Unlike the other LogDisplay functions, this one does not check that the window is a LogDisplay. For any other kind of window it returns a meaningless value instead of raising an error.
• The error message names TextLogSetShowFilterName and ends with a line break.
• The stock UI never calls this function.

Errors

• Error in function call 'TextLogSetShowFilterName': TextLogDisplay %s does not exist. (when no window has that name)

Example

A minimal example built from the documented signature:

local showsFilterName = LogDisplayGetShowFilterName( "MyLogDisplay" )

See also

• LogDisplaySetShowFilterName