Animation
object type36 methodsavailable in: camelot
It has every method of Object, plus 36 of its own.
Inherits from
- Animation · 36
- Object · 5
- FrameScriptObject · 21
The number is each type's own documented methods. A Animation has all of them.
Methods
In the emulator: 23 implemented, 13 guessed.
| method | what it does | status |
|---|---|---|
GetDuration | Returns the animation's duration in seconds. · by wowlua(): number | implemented |
GetElapsed | Returns how long the animation has been playing, in seconds. · by wowlua(): number | guessed |
GetEndDelay | Returns the delay after the animation ends, in seconds. · by wowlua(): number | guessed |
GetOrder | Returns the animation's place in its group's order. · by wowlua(): number | guessed |
GetProgress | Returns how far the animation has played, from 0 to 1. · by wowlua(): number | guessed |
GetRegionParent | Returns the region the animation's group belongs to. · by wowlua(): CScriptObject | guessed |
GetScript | Returns the animation's handler for the script type. · by wowlua(scriptTypeName: ScriptTypeName, bindingType: ScriptBindingType): LuaFunctionReference | implemented |
GetSmoothProgress | Returns how far the animation has played, from 0 to 1, with its smoothing applied. · by wowlua(): number | guessed |
GetSmoothing | Returns the smoothing the animation applies to its progress. · by wowlua(): SmoothingType | guessed |
GetStartDelay | Returns the delay before the animation starts, in seconds. · by wowlua(): number | guessed |
GetTarget | Returns the region or object the animation acts on. · by wowlua(): CScriptObject | guessed |
HasScript | Whether the animation supports the script type. · by wowlua(scriptName: string): boolean | implemented |
HookScript | Adds a handler that runs after the animation's existing handler for the script type. · by wowlua(scriptTypeName: ScriptTypeName, script: LuaFunctionReference, bindingType: ScriptBindingType): boolean | implemented |
IsDelaying | Whether the animation is in its start or end delay. · by wowlua(): boolean | implemented |
IsDone | Whether the animation has finished playing. · by wowlua(): boolean | implemented |
IsPaused | Whether the animation is paused. · by wowlua(): boolean | implemented |
IsPlaying | Whether the animation is playing. · by wowlua(): boolean | implemented |
IsStopped | Whether the animation is stopped. · by wowlua(): boolean | implemented |
Pause | Pauses the animation. · by wowlua() | guessed |
Play | Plays the animation. · by wowlua() | guessed |
Restart | Plays the animation again from its start. · by wowlua() | guessed |
SetChildKey | Sets the animation's target to the child of its group's parent under the key. · by wowlua(childKey: string): boolean | implemented |
SetDuration | Sets the animation's duration in seconds. · by wowlua(durationSec: number, recomputeGroupDuration: boolean) | implemented |
SetEndDelay | Sets the delay after the animation ends, in seconds. · by wowlua(delaySec: number, recomputeGroupDuration: boolean) | implemented |
SetOrder | Sets the animation's place in its group's order. Animations with the same order play together. · by wowlua(newOrder: number) | implemented |
SetParent | Moves the animation into the animation group. · by wowlua(parent: AnimGroup, order: number?) | implemented |
SetPlaying | Plays or stops the animation. · by wowlua(play: boolean) | implemented |
SetScript | Sets the animation's handler for the script type, or clears it when script is nil. · by wowlua(scriptTypeName: ScriptTypeName, script: LuaFunctionReference?) | implemented |
SetSmoothProgress | Sets the smooth progress for an animation. · warcraft.wiki.gg ↗(durationSec: number) | implemented |
SetSmoothing | This method for animations allows you to specify how the animation's speed will change over time. · warcraft.wiki.gg ↗(weights: SmoothingType) | implemented |
SetStartDelay | Sets the delay before the animation starts, in seconds. · by wowlua(delaySec: number, recomputeGroupDuration: boolean) | implemented |
SetTarget | Sets the region or object the animation acts on. · by wowlua(target: CScriptObject): boolean | implemented |
SetTargetKey | Sets the animation's target to the child of its group's parent under the key. · by wowlua(key: string): boolean | implemented |
SetTargetName | Sets the animation's target to the region with the global name. · by wowlua(name: string): boolean | implemented |
SetTargetParent | Sets the animation's target to its group's parent. · by wowlua(): boolean | implemented |
Stop | Stops the animation. · by wowlua() | guessed |
sources
Methods and inheritance: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.