AnimationModule Overview
AnimationModule Overview
AnimationPlaybackController

AnimationPlaybackController

The AnimationPlaybackController class describes an animation playback controller asset.

Properties

PropertyDescription
identifier
(get) identifier: string
(set) (Not Available)


Unique identifier of this animation playback controller.
looping
(get) looping: BoolSignal
(set) looping: BoolSignal


A signal that controls whether this controller should loop or not.
Loops the playback controller. To be used in pair with the setPlaying method. If set to true, the animation will repeat infinitely.
name
(get) name: string
(set) (Not Available)


Name of this animation playback controller.
playing
(get) playing: BoolSignal
(set) playing: BoolSignal


A signal that controls wheher this playback controller is playing or not.
Plays or pauses the playback controller depending on the value entered.
speed
(get) speed: ScalarSignal
(set) speed: ScalarSignal


Scalar signal represents current speed of animation playback (1.0 being normal speed).
Sets the speed of the animation playback.

Methods

MethodDescription
getAnimationClip
getAnimationClip(): Promise<AnimationClip | null>


Get the animation clip that this controller is using.
reset
reset(): void


Resets the playback controller to the beginning. If the playback controller is currently playing then it will immediately re-start.
setAnimationClip
setAnimationClip(clip: AnimationClip | null): Promise<void>


Set the animation clip that this controller should use.

Was this article helpful?