WoW:API UIFrameFadeIn: Difference between revisions

WoW:API UIFrameFadeIn (source)

239 bytes added , 27 June 2007

Updated to match the current API boilerplate.

Anonymous user

@@ 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.
-When the fade is finished...
+== Arguments ==
-  [frame].fadeInfo.finishedFunc(
+:(frame, timeToFade, startAlpha, endAlpha)
-    [frame].fadeInfo.finishedArg1,
+:;frame : [[Frame]] - The frame to fade
-    [frame].fadeInfo.finishedArg2,
+:;timeToFade : Number the time it takes to fade in or out (in seconds)
-    [frame].fadeInfo.finishedArg3,
+:;startAlpha : Number - The beginning alpha value (between 0 and 1)
-    [frame].fadeInfo.finishedArg4
+:;endAlpha : Number - The ending alpha value (between 0 and 1)
-  )
-...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
+  )