Changes: API UIFrameFadeIn

Revision as of 14:56, 27 June 2007

This function is implemented in FrameXML/UIParent.lua.

Convenience functions for managing the fading in and out of a frame.

UIFrameFadeIn(frame, timeToFade, startAlpha, endAlpha)
UIFrameFadeOut(frame, timeToFade, startAlpha, endAlpha)

Arguments

(frame, timeToFade, startAlpha, endAlpha)

frame: Frame - The frame to fade
timeToFade: Number the time it takes to fade in or out (in seconds)
startAlpha: Number - The beginning alpha value (between 0 and 1)
endAlpha: Number - The ending alpha value (between 0 and 1)

Returns

nil

Details

When the fade is finished frame.fadeInfo.finishedFunc will be called then set to nil.

frame.fadeInfo.finishedFunc(
  frame.fadeInfo.finishedArg1, 
  frame.fadeInfo.finishedArg2, 
  frame.fadeInfo.finishedArg3, 
  frame.fadeInfo.finishedArg4
)

@@ Line 1: / Line 1: @@
-{{framexmlfunc|FrameXML/UIParent.lua}}
+{{framexmlfunc|FrameXML/UIParent.lua}} __NOTOC__
-{{stub/api}}
+Convenience functions for managing the fading in and out of a frame.
  UIFrameFadeIn(frame, timeToFade, startAlpha, endAlpha)
  UIFrameFadeOut(frame, timeToFade, startAlpha, endAlpha)
-timeToFade in seconds, alpha from 0 to 1.  Convenience functions to set up a given frame and have it faded in and out by UIFrameFadeUpdate.
+== Arguments ==
-When the fade is finished...
+:(frame, timeToFade, startAlpha, endAlpha)
- [frame].fadeInfo.finishedFunc(
+:;frame : [[Frame]] - The frame to fade
-   [frame].fadeInfo.finishedArg1,
+:;timeToFade : Number the time it takes to fade in or out (in seconds)
-   [frame].fadeInfo.finishedArg2,
+:;startAlpha : Number - The beginning alpha value (between 0 and 1)
-   [frame].fadeInfo.finishedArg3,
+:;endAlpha : Number - The ending alpha value (between 0 and 1)
-   [frame].fadeInfo.finishedArg4
- )
-...will be called, and then [frame].fadeInfo.finishedFunc is set to nil
+== Returns ==
+:nil
+== Details ==
+: When the fade is finished frame.fadeInfo.finishedFunc will be called then set to nil.
+ frame.fadeInfo.finishedFunc(
+   frame.fadeInfo.finishedArg1,
+   frame.fadeInfo.finishedArg2,
+   frame.fadeInfo.finishedArg3,
+   frame.fadeInfo.finishedArg4
+ )