WoW:API UIFrameFadeUpdate: Difference between revisions
Jump to navigation
Jump to search
(Updated to match the current API boilerplate.) |
m (Move page script moved page API UIFrameFadeUpdate to API UIFrameFadeUpdate without leaving a redirect) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{framexmlfunc|FrameXML/UIParent.lua}} | ||
Manages the fading of frames that use [[API UIFrameFadeIn|UIFrameFadeIn]] and [[API UIFrameFadeOut|UIFrameFadeOut]]. | Manages the fading of frames that use [[API UIFrameFadeIn|UIFrameFadeIn]] and [[API UIFrameFadeOut|UIFrameFadeOut]]. | ||
UIFrameFadeUpdate(elapsed) | UIFrameFadeUpdate(elapsed) | ||
== Arguments == | == 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 | Fading frame attribute listing | ||
============================================================ | ============================================================ | ||
| Line 24: | Line 25: | ||
frame.finishedArg4 [ANYTHING] Argument to the finishedFunc | frame.finishedArg4 [ANYTHING] Argument to the finishedFunc | ||
frame.fadeHoldTime [Num] Time to hold the faded state | 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. | |||
Latest revision as of 04:47, 15 August 2023
This function is implemented in Lua here FrameXML/UIParent.lua.
Manages the fading of frames that use UIFrameFadeIn and UIFrameFadeOut.
UIFrameFadeUpdate(elapsed)
Parameters[edit]
Arguments[edit]
- elapsed (number) - The elapsed time in milliseconds
Returns[edit]
- none
Details[edit]
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[edit]
- In patch 3.1.0 (2009-04-14) UIFrameFadeUpdate was renamed to UIFrameFade_OnUpdate. Requires reference to specific frame before the elapsed argument.