View source for API:LogDisplaySetTextFadeTime

{{LuaApi|group=LogDisplay}}
Sets how long lines stay visible in a LogDisplay window before they fade out.

<pre>
LogDisplaySetTextFadeTime(displayName, fadeTime)
</pre>

== Arguments ==
;displayName : <code>string</code> – Name of a LogDisplay window.
;fadeTime : <code>number</code> – Time before a line fades. <code>0</code> turns fading off.

== Returns ==
Nothing.

== Details ==
* If the value changes, all lines are made fully visible again and their fade starts over (as with [[API:LogDisplayResetLineFadeTime|LogDisplayResetLineFadeTime]]).
* With a fade time of 0 the display is not updated for fading, and [[API:LogDisplayResetLineFadeTime|LogDisplayResetLineFadeTime]] does nothing.
* The stock chat window passes the player's <code>SystemData.Settings.Chat.visibleTime</code> setting, or <code>300</code> when text fading is switched off in the settings.
* The function needs at least two arguments and only reads the last two. Any extra arguments placed in front of them are ignored.

== Errors ==
* <code>Error in function call 'TextLogSetTextFadeTime': Window %s does not exist</code>
* <code>Error in function call 'TextLogSetTextFadeTime': Window %s is not a TextLogDisplay</code>

== Example ==
From <code>ea_chatwindow/source/chatwindow.lua</code>:
<pre>
-- text fade time
local visibleTime = 300
if( SystemData.Settings.Chat.fadeText ) then
    visibleTime = SystemData.Settings.Chat.visibleTime
end
LogDisplaySetTextFadeTime( tabLogDisplayName, visibleTime )
</pre>

== See also ==
* [[API:LogDisplayGetTextFadeTime|LogDisplayGetTextFadeTime]]
* [[API:LogDisplayResetLineFadeTime|LogDisplayResetLineFadeTime]]