WoW:API UIFrameFadeIn: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
({{framexml}}, mark stub)
m (Move page script moved page API UIFrameFadeIn to API UIFrameFadeIn without leaving a redirect)
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{framexml}}
<br>{{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)


UIFrameFadeIn(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
)

Latest revision as of 04:47, 15 August 2023


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[edit]

(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[edit]

nil


Details[edit]

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
)