WoW:API UIFrameFadeUpdate: Difference between revisions

Revision as of 02:51, 11 February 2021

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < UIFrameFadeUpdate

This function is implemented in Lua here FrameXML/UIParent.lua.

Manages the fading of frames that use UIFrameFadeIn and UIFrameFadeOut.

UIFrameFadeUpdate(elapsed)

Parameters

Arguments

elapsed (number) - The elapsed time in milliseconds

Returns

none

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.

Notes

In patch 3.1.0 (2009-04-14) UIFrameFadeUpdate was renamed to UIFrameFade_OnUpdate. Requires reference to specific frame before the elapsed argument.

@@ Line 1: / Line 1: @@
-<br>{{framexml}} __NOTOC__
+{{framexmlfunc|FrameXML/UIParent.lua}}
 Manages the fading of frames that use [[API UIFrameFadeIn|UIFrameFadeIn]] and [[API UIFrameFadeOut|UIFrameFadeOut]].
   UIFrameFadeUpdate(elapsed)
-== Arguments ==
+== Parameters ==
-:;elapsed : Number - The elapsed time in milliseconds
+=== Arguments ===
+* elapsed (number) - The elapsed time in milliseconds
+=== Returns ===
+: none
-== Returns ==
+== Details ==
-:nil
+Keeps a table of frames its currently fading.  Each frame in that table has a table of fadeInfo.
-== Details ==
-: Keeps a table of frames its currently fading.  Each frame in that table has a table of fadeInfo.
   Fading frame attribute listing
   ============================================================
@@ Line 24: / Line 25: @@
   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.
+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.
+== Notes ==
+* In patch 3.1.0 (2009-04-14) UIFrameFadeUpdate was renamed to UIFrameFade_OnUpdate. Requires reference to specific frame before the elapsed argument.

Navigation menu

Search