Home

Alpha

• change = Alpha:GetChange() - Returns the animation's amount of alpha (opacity) change
• 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
• Alpha:GetFromAlpha() - This function is not yet documented
• 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
• Alpha:GetToAlpha() - This function is not yet documented
• 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:SetChange(change) - Sets the animation's amount of alpha (opacity) change
• 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:SetFromAlpha() - This function is not yet documented
• 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:SetToAlpha() - This function is not yet documented
• Alpha:Stop() - Stops the animation

Animation

• 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
• name = Animation:GetName() - Returns the widget object's name
• type = Animation:GetObjectType() - Returns the object's widget type
• order = Animation:GetOrder() - Returns the order of the animation within its parent group
• parent = Animation:GetParent() - Returns the object's parent object
• progress = Animation:GetProgress() - Returns the progress of an animation, ignoring smoothing effects
• region = Animation:GetRegionParent() - Returns the Region object on which the animation operates
• handler = Animation:GetScript("scriptType") - Returns the widget's handler function for a script
• 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
• hasScript = Animation:HasScript("scriptType") - Returns whether the widget supports a script handler
• Animation:HookScript("scriptType", handler) - Securely hooks a script handler
• 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
• Animation:IsForbidden() - This function is not yet documented
• isType = Animation:IsObjectType("type") - Returns whether the object belongs to a given widget type
• 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:SetChildKey(key) - Sets the animation to manipulate a particular child member of its host frame
• 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: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:SetScript("scriptType", handler) - Sets the widget's handler function for a script
• Animation:SetSmoothProgress() - Sets the smooth progress for an animation.
• 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:SetTarget(region) - Sets the region affected by this animation
• Animation:SetTargetKey(key) - Sets the animation to manipulate a particular child member of its target
• Animation:Stop() - Stops the animation

AnimationGroup

• animation = AnimationGroup:CreateAnimation("animationType" [, "name" [, "inheritsFrom"]]) - Creates an Animation as a child of this group
• AnimationGroup:Finish() - Causes animations within the group to complete and stop
• ... = AnimationGroup:GetAnimations() - Returns a list of animations belonging to the group
• duration = AnimationGroup:GetDuration() - Returns the duration of a single loop cycle for the group, as determined by its child animations
• AnimationGroup:GetIgnoreFramerateThrottle() - This function is not yet documented
• loopState = AnimationGroup:GetLoopState() - Returns the current loop state of the group
• loopType = AnimationGroup:GetLooping() - Returns the looping behavior of the group
• maxOrder = AnimationGroup:GetMaxOrder() - Returns the highest order amongst the animations in the group
• name = AnimationGroup:GetName() - Returns the widget object's name
• type = AnimationGroup:GetObjectType() - Returns the object's widget type
• parent = AnimationGroup:GetParent() - Returns the object's parent object
• progress = AnimationGroup:GetProgress() - Returns the current state of the animation group's progress
• handler = AnimationGroup:GetScript("scriptType") - Returns the widget's handler function for a script
• hasScript = AnimationGroup:HasScript("scriptType") - Returns whether the widget supports a script handler
• AnimationGroup:HookScript("scriptType", handler) - Securely hooks a script handler
• done = AnimationGroup:IsDone() - Returns whether the group has finished playing
• AnimationGroup:IsForbidden() - This function is not yet documented
• isType = AnimationGroup:IsObjectType("type") - Returns whether the object belongs to a given widget type
• paused = AnimationGroup:IsPaused() - Returns whether the group is paused
• isPending = AnimationGroup:IsPendingFinish() - Returns whether or not the animation group is pending finish
• playing = AnimationGroup:IsPlaying() - Returns whether the group is playing
• AnimationGroup:IsSetToFinalAlpha() - This function is not yet documented
• AnimationGroup:Pause() - Pauses animation of the group
• AnimationGroup:Play() - Starts animating the group
• AnimationGroup:SetIgnoreFramerateThrottle() - This function is not yet documented
• AnimationGroup:SetLooping("loopType") - Sets the looping behavior of the group
• AnimationGroup:SetScript("scriptType", handler) - Sets the widget's handler function for a script
• AnimationGroup:SetToFinalAlpha() - This function is not yet documented
• AnimationGroup:Stop() - Stops animation of the group

ControlPoint

• name = ControlPoint:GetName() - Returns the widget object's name
• type = ControlPoint:GetObjectType() - Returns the object's widget type
• x, y = ControlPoint:GetOffset() - Returns the offset for the control point
• order = ControlPoint:GetOrder() - Returns the order of the control point in a path animation
• parent = ControlPoint:GetParent() - Returns the object's parent object
• ControlPoint:IsForbidden() - This function is not yet documented
• isType = ControlPoint:IsObjectType("type") - Returns whether the object belongs to a given widget type
• ControlPoint:SetOffset(x, y) - Sets the offset for the control point
• ControlPoint:SetOrder(order) - Sets the order of the control point in a path animation
• ControlPoint:SetParent([path [, order]]) or ControlPoint:SetParent(["path" [, order]]) - Sets a new path animation parent for a control point

Path

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

Rotation

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

Scale

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

Translation

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