WoW:API UIFrameFadeUpdate: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(woohoo, some info)
 
(Updated to match the current API boilerplate.)
Line 1: Line 1:
{{framexml}}
{{framexml}} __NOTOC__


{{stub/api}}
Manages the fading of frames that use [[API UIFrameFadeIn|UIFrameFadeIn]] and [[API UIFrameFadeOut|UIFrameFadeOut]].
UIFrameFadeUpdate(elapsed)


UIFrameFadeUpdate(elapsed)
== Arguments ==
:;elapsed : Number - The elapsed time in milliseconds


Used by the UI to fade frames in and out.  Keeps a table of frames its currently fading.  Each frame in that table has a table of fadeInfo.
 
== Returns ==
:nil
 
 
== Details ==
: Keeps a table of frames its currently fading.  Each frame in that table has a table of fadeInfo.
  Fading frame attribute listing
  Fading frame attribute listing
  ============================================================
  ============================================================
Line 16: Line 24:
  frame.finishedArg4 [ANYTHING] Argument to the finishedFunc
  frame.finishedArg4 [ANYTHING] Argument to the finishedFunc
  frame.fadeHoldTime [Num] Time to hold the faded state
  frame.fadeHoldTime [Num] Time to hold the faded state
all of the finished* entries must be set for each individual fade, and are used by UIFrameFlashUpdate (and related) to reverse/restart fade direction when something is flashing.
: All of the entries starting with the word "finished" must be set for each individual fade, and are used by UIFrameFlashUpdate (and related) to reverse/restart fade direction when something is flashing.

Revision as of 15:01, 27 June 2007

WoW API < UIFrameFadeUpdate

Manages the fading of frames that use UIFrameFadeIn and UIFrameFadeOut.

UIFrameFadeUpdate(elapsed)

Arguments

elapsed
Number - The elapsed time in milliseconds


Returns

nil


Details

Keeps a table of frames its currently fading. Each frame in that table has a table of fadeInfo.
Fading frame attribute listing
============================================================
frame.timeToFade  [Num]		Time it takes to fade the frame in or out
frame.mode  ["IN", "OUT"]	Fade mode
frame.finishedFunc [func()]	Function that is called when fading is finished
frame.finishedArg1 [ANYTHING]	Argument to the finishedFunc
frame.finishedArg2 [ANYTHING]	Argument to the finishedFunc
frame.finishedArg3 [ANYTHING]	Argument to the finishedFunc
frame.finishedArg4 [ANYTHING]	Argument to the finishedFunc
frame.fadeHoldTime [Num]	Time to hold the faded state
All of the entries starting with the word "finished" must be set for each individual fade, and are used by UIFrameFlashUpdate (and related) to reverse/restart fade direction when something is flashing.