UIFrameFade:OnUpdate()

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

→ FrameXML Funcs

→ FrameXML Docs

This function is implemented in :OnUpdate FrameXML/UIParent.lua.

Manages the fading of frames that use UIFrameFade, UIFrameFadeIn and UIFrameFadeOut.

UIFrameFade_OnUpdate(self, elapsed)

Arguments

self

UIObject - Reference to the frame being updated

elapsed

number - The elapsed time in milliseconds

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.

Patch changes

• Patch 3.1.0 (2009-04-14): UIFrameFadeUpdate() renamed UIFrameFade_OnUpdate() with new self argument inserted in first position.