Skip to content

API

SequenceAnimator

Functions

.new

SequenceAnimator.new(model: Model): SequenceAnimatorInstance

Creates a new SequenceAnimatorInstance allowing for playing KeyframeSequences on a given Model.

SequenceAnimatorInstance

Functions

:LoadSequence

SequenceAnimatorInstance:LoadSequence(sequence: KeyframeSequence): SequenceTrack

This function loads the given KeyframeSequence onto this SequenceAnimatorInstance, returning a playable SequenceTrack.


:Destroy

SequenceAnimatorInstance:Destroy(): ()

SequenceTrack

Properties

Speed

SequenceTrack.Speed: number

When equal to 1, the amount of time an animation takes to complete is equal to Length, in seconds.

Changing this property while animation is being played won't result in it speeding up / slowing down, instead next time Play is called the new speed will be applied.


Length

SequenceTrack.Length: number

Length in seconds.

Warning

This property can be modified, but you shouldn't really have a reason to do so.


IsPlaying

SequenceTrack.IsPlaying: boolean

Returns true when SequenceTrack is playing an animation.


Looped

SequenceTrack.Looped: boolean

This property sets whether the animation will repeat after finishing.

Changing this property while animation is being played won't result in it looping once it reaches the end, instead next time Play is called the new change will be applied.


Ended

SequenceTrack.Ended: RBXScriptSignal

Fires when the SequenceTrack is completely done moving anything in the world, meaning the animation has finished playing.


DidLoop

SequenceTrack.DidLoop: RBXScriptSignal

This event fires whenever a looped SequenceTrack completes a loop.

Functions

:Play

SequenceTrack:Play(): ()

When called the animation will start playing.

Notice

Currently SequenceAnimator doesn't support fadeTime and weight unlike Robloxes AnimationTrack.


:Stop

SequenceTrack:Stop(): ()

Stops the current animation, if one is playing. Stopping an animation will not cause the pose to reset to its default state.

Notice

Currently SequenceAnimator doesn't support fadeTime and weight unlike Robloxes AnimationTrack.