WoW:API ScrollingMessageFrame SetTimeVisible: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
No edit summary
Line 1: Line 1:
{{API/Uncategorized}}
<center>'''ScrollingMessageFrame:SetTimeVisible''' ''-Documentation by Maldivia-''</center><br/><br/>
 
Set the time, lines added to a ScrollingMessageFrame are visible before they start to fade.
 
ScrollingMessageFrame:SetTimeVisible(seconds);
 
 
----
;''Arguments''
 
:(Number seconds)
 
:;seconds : The time, lines added to the ScrollingMessageFrame are visible, before they start to fade.
 
----
;''Returns''
 
:;nil
 
----
;''Example''
DEFAULT_CHAT_FRAME:SetTimeVisible(15);
 
;''Result''
Changes the visible time for lines added or updated to 15 seconds.
 
==Details==
:SetTimeVisible(seconds) doesn't affect already visible lines, unless these are updated.
:A way to update them is to call one of the Scroll methods.
:Settings a value of 0 or below, means lines begin to fade immediately.
:Calling this method has the same affect as setting the ScrollingMessageFrame XML attribute "displayDuration".
:See also [[API ScrollingMessageFrame EnableFading|ScrollingMessageFrame:EnableFading(&#91;isEnabled&#93;)]] and [[API ScrollingMessageFrame SetFadeDuration|ScrollingMessageFrame:SetFadeDuration(seconds)]].
----
{{Template:WoW API}}

Revision as of 04:51, 13 February 2006

ScrollingMessageFrame:SetTimeVisible -Documentation by Maldivia-



Set the time, lines added to a ScrollingMessageFrame are visible before they start to fade.

ScrollingMessageFrame:SetTimeVisible(seconds);



Arguments
(Number seconds)
seconds
The time, lines added to the ScrollingMessageFrame are visible, before they start to fade.

Returns
nil

Example
DEFAULT_CHAT_FRAME:SetTimeVisible(15);
Result
Changes the visible time for lines added or updated to 15 seconds.

Details

SetTimeVisible(seconds) doesn't affect already visible lines, unless these are updated.
A way to update them is to call one of the Scroll methods.
Settings a value of 0 or below, means lines begin to fade immediately.
Calling this method has the same affect as setting the ScrollingMessageFrame XML attribute "displayDuration".
See also ScrollingMessageFrame:EnableFading(&#91;isEnabled&#93;) and ScrollingMessageFrame:SetFadeDuration(seconds).

Template:WoW API