WoW:API UIFrameFadeIn: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (stupid typo)
(Updated to match the current API boilerplate.)
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)
  UIFrameFadeIn(frame, timeToFade, startAlpha, endAlpha)
  UIFrameFadeOut(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
  )

Revision as of 14:56, 27 June 2007

← WoW API < UIFrameFadeIn

"I" iconThis function is implemented in Lua here 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
)
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_UIFrameFadeIn&oldid=12179"