Alpha

Alpha is a type of animation that automatically changes the transparency level of its attached region as it progresses. You can set the degree by which it will change the alpha as a fraction; for instance, a change of -1 will fade out a region completely.

Defined Methods

• change = Alpha:GetChange() - Returns the animation's amount of alpha (opacity) change
• Alpha:GetFromAlpha() - This function is not yet documented
• Alpha:GetToAlpha() - This function is not yet documented
• Alpha:SetChange(change) - Sets the animation's amount of alpha (opacity) change
• Alpha:SetFromAlpha() - This function is not yet documented
• Alpha:SetToAlpha() - This function is not yet documented

Inherited Methods

• duration = Alpha:GetDuration() - Returns the time for the animation to progress from start to finish
• elapsed = Alpha:GetElapsed() - Returns the amount of time since the animation began playing
• delay = Alpha:GetEndDelay() - Returns the amount of time the animation delays after finishing
• name = Alpha:GetName() - Returns the widget object's name
• type = Alpha:GetObjectType() - Returns the object's widget type
• order = Alpha:GetOrder() - Returns the order of the animation within its parent group
• parent = Alpha:GetParent() - Returns the object's parent object
• progress = Alpha:GetProgress() - Returns the progress of an animation, ignoring smoothing effects
• region = Alpha:GetRegionParent() - Returns the Region object on which the animation operates
• handler = Alpha:GetScript("scriptType") - Returns the widget's handler function for a script
• progress = Alpha:GetSmoothProgress() - Returns the progress of the animation (ignoring start and end delay)
• smoothType = Alpha:GetSmoothing() - Returns the smoothing type for the animation
• delay = Alpha:GetStartDelay() - Returns the amount of time the animation delays before its progress begins
• hasScript = Alpha:HasScript("scriptType") - Returns whether the widget supports a script handler
• Alpha:HookScript("scriptType", handler) - Securely hooks a script handler
• delaying = Alpha:IsDelaying() - Returns whether the animation is currently in the middle of a start or end delay
• done = Alpha:IsDone() - Returns whether the animation has finished playing
• Alpha:IsForbidden() - This function is not yet documented
• isType = Alpha:IsObjectType("type") - Returns whether the object belongs to a given widget type
• paused = Alpha:IsPaused() - Returns whether the animation is currently paused
• playing = Alpha:IsPlaying() - Returns whether the animation is currently playing
• stopped = Alpha:IsStopped() - Returns whether the animation is currently stopped
• Alpha:Pause() - Pauses the animation
• Alpha:Play() - Plays the animation
• Alpha:SetChildKey(key) - Sets the animation to manipulate a particular child member of its host frame
• Alpha:SetDuration(duration) - Sets the time for the animation to progress from start to finish
• Alpha:SetEndDelay(delay) - Sets the amount of time for the animation to delay after finishing
• Alpha:SetOrder(order) - Sets the order for the animation to play within its parent group
• Alpha:SetParent(animGroup) or Alpha:SetParent("animGroupName") - Sets the parent for the animation
• Alpha:SetScript("scriptType", handler) - Sets the widget's handler function for a script
• Alpha:SetSmoothProgress() - This function is not yet documented
• Alpha:SetSmoothing("smoothType") - Sets the smoothing type for the animation
• Alpha:SetStartDelay(delay) - Sets the amount of time for the animation to delay before its progress begins
• Alpha:SetTarget(region) - Sets the region affected by this animation
• Alpha:SetTargetKey(key) - Sets the animation to manipulate a particular child member of its target
• Alpha:Stop() - Stops the animation

Script Handlers

• OnFinished(self, requested) - Run when the animation (or animation group) finishes animating
• OnLoad(self) - Run when the frame is created
• OnPause(self) - Run when the animation (or animation group) is paused
• OnPlay(self) - Run when the animation (or animation group) begins to play
• OnStop(self, requested) - Run when the animation (or animation group) is stopped
• OnUpdate(self, elapsed) - Run each time the screen is drawn by the game engine