Skip to content

YaAnimationHandle

YaAnimationHandle is an interface to get information or control playing animation playables.

Functions

boolean IsLooping()

Returnsboolean
Checks if this animation playable is looping. If it has stopped, this function returns 0.

void SetLooping(boolean value)

SERVER ONLY 
Determines if this animation playable loops. If it has stopped, this function call will be invalid.
  • value boolean

number GetPlaybackRate()

Returnsplayback rate number
Returns this animation playable's playback rate. If it has stopped,this function returns 0.

void SetPlaybackRate(number value)

SERVER ONLY 
Sets this animation playable's playback rate, ranging from 0 to 3. If it has stopped, this function call will be invalid.
  • value playback rate number

number GetLength()

Returnsanimation playable length number
Returns the length of this animation playable. If it has stopped,this function returns 0.

boolean IsPlaying()

Returnsboolean
Checks if this animation playable is still playing.

string GetName()

Returnsanimation playable name string
Returns this animation playable's name. If it has stopped, this function returns an empty string.

void Stop()

SERVER ONLY 
Stops this animation playable.