Defined Methods
- duration = Animation:GetDuration() - Returns the time for the animation to progress from start to finish
- elapsed = Animation:GetElapsed() - Returns the amount of time since the animation began playing
- delay = Animation:GetEndDelay() - Returns the amount of time the animation delays after finishing
- framerate = Animation:GetMaxFramerate() - Returns the maximum number of times per second that the animation will update its progress
- order = Animation:GetOrder() - Returns the order of the animation within its parent group
- progress = Animation:GetProgress() - Returns the progress of an animation, ignoring smoothing effects
- progress = Animation:GetProgressWithDelay() - Returns the progress of the animation and associated delays
- region = Animation:GetRegionParent() - Returns the `Region` object on which the animation operates
- progress = Animation:GetSmoothProgress() - Returns the progress of the animation (ignoring start and end delay)
- smoothType = Animation:GetSmoothing() - Returns the smoothing type for the animation
- delay = Animation:GetStartDelay() - Returns the amount of time the animation delays before its progress begins
- delaying = Animation:IsDelaying() - Returns whether the animation is currently in the middle of a start or end delay
- done = Animation:IsDone() - Returns whether the animation has finished playing
- paused = Animation:IsPaused() - Returns whether the animation is currently paused
- playing = Animation:IsPlaying() - Returns whether the animation is currently playing
- stopped = Animation:IsStopped() - Returns whether the animation is currently stopped
- Animation:Pause() - Pauses the animation
- Animation:Play() - Plays the animation
- Animation:SetDuration(duration) - Sets the time for the animation to progress from start to finish
- Animation:SetEndDelay(delay) - Sets the amount of time for the animation to delay after finishing
- Animation:SetMaxFramerate(framerate) - Sets the maximum number of times per second for the animation to update its progress
- Animation:SetOrder(order) - Sets the order for the animation to play within its parent group
- Animation:SetParent(animGroup) or Animation:SetParent("animGroupName") - Sets the parent for the animation
- Animation:SetSmoothProgress() - This function is not yet documented
- Animation:SetSmoothing("smoothType") - Sets the smoothing type for the animation
- Animation:SetStartDelay(delay) - Sets the amount of time for the animation to delay before its progress begins
- Animation:Stop() - Stops the animation
Inherited Methods
- name = Animation:GetName() - Returns the widget object's name
- type = Animation:GetObjectType() - Returns the object's widget type
- parent = Animation:GetParent() - Returns the object's parent object
- handler = Animation:GetScript("scriptType") - Returns the widget's handler function for a script
- hasScript = Animation:HasScript("scriptType") - Returns whether the widget supports a script handler
- Animation:HookScript("scriptType", handler) - Securely hooks a script handler
- isType = Animation:IsObjectType("type") - Returns whether the object belongs to a given widget type
- Animation:SetScript("scriptType", handler) - Sets the widget's handler function for a script
Script Handlers
- OnEvent(self, "event", ...) - Run whenever an [[docs/events|event]] fires for which the frame is registered
- 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