API:LogDisplayGetTextFadeTime

UI Lua API · LogDisplay functions
Version: WAR 1.4.8

Returns how long lines stay visible in a LogDisplay window before they fade out.

fadeTime = LogDisplayGetTextFadeTime(displayName)

Arguments

displayName

string – Name of a LogDisplay window.

Returns

fadeTime

number – The value set by LogDisplaySetTextFadeTime. 0 means fading is off.

Details

• The value is stored as a single-precision float, so it may differ slightly from the number that was set.
• The stock UI never calls this function.

Errors

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

Example

A minimal example built from the documented signature:

if LogDisplayGetTextFadeTime( "MyLogDisplay" ) ~= 0 then
    LogDisplayResetLineFadeTime( "MyLogDisplay" )
end

See also

• LogDisplaySetTextFadeTime