API:LogDisplayGetShowLogName

UI Lua API · LogDisplay functions
Version: WAR 1.4.8

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

show = LogDisplayGetShowLogName(displayName)

Arguments

displayName

string – Name of a LogDisplay window.

Returns

show

boolean – The value set by LogDisplaySetShowLogName.

Details

• The stock UI never calls this function.

Errors

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

Example

A minimal example built from the documented signature:

local showsLogName = LogDisplayGetShowLogName( "MyLogDisplay" )

See also

• LogDisplaySetShowLogName