API:LogDisplaySetShowFilterName

UI Lua API · LogDisplay functions
Version: WAR 1.4.8

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

LogDisplaySetShowFilterName(displayName, show)

Arguments

displayName

string – Name of a LogDisplay window.

show

boolean – true to show the filter name.

Returns

Nothing.

Details

• The filter name is the display name given to the entry's filter type with TextLogAddFilterType. It is printed after the time stamp and log name, directly in front of the text.
• Like LogDisplaySetShowLogName, this call does not rebuild the display. Lines already shown keep their layout.
• show must be a real boolean.
• The function needs at least two arguments and only reads the last two. Any extra arguments placed in front of them are ignored.

Errors

• Error in function call 'TextLogSetShowFilterType': Window %s does not exist
• Error in function call 'TextLogSetShowFilterType': Window %s is not a TextLogDisplay

The messages name TextLogSetShowFilterType.

Example

From ea_uidebugtools/source/debugwindow.lua:

LogDisplaySetShowTimestamp( "DebugWindowText", false )
LogDisplaySetShowLogName( "DebugWindowText", true )
LogDisplaySetShowFilterName( "DebugWindowText", true )

See also

• LogDisplayGetShowFilterName
• TextLogAddFilterType
• LogDisplaySetShowLogName