KeyframeSequence¶
This object stores all of the Keyframes and other data for the animation.
Description¶
KeyframeSequence stores all the Keyframes for an Animation, determines if the animation will Loop, and determines its Priority against other animations. The last Keyframe in the sequence, meaning the Keyframe with the highest Time property, determines the length of an animation.
Although Priority and Loop save the priority and looped animation settings for the sequence, note that AnimationTrack properties can eventually overwrite these properties at playback time.
If you want to preview an Animation before uploading it to Roblox, you can generate a temporary hash ID using KeyframeSequenceProvider.RegisterKeyframeSequence() for localized animation testing.
Obtaining Sequences¶
In some cases you may wish to download the KeyframeSequence corresponding to an existing uploaded Animation. You can use AnimationClipProvider.GetAnimationClipAsync() to download an animation.
Inheritance¶
Object → Instance → AnimationClip → KeyframeSequence
Nova inheritance: Instance → KeyframeSequence
Properties¶
Loop Supported Property Determines whether the animation stored in this AnimationClip is intended to loop.
Determines whether the animation stored in this AnimationClip is intended to loop. When set to true, the animation will continuously repeat each time it finishes.
Note that AnimationTrack instances internally load an AnimationClip when an Animation is requested via its AnimationId, and the AnimationTrack.Looped property will default to the original AnimationClip value. Note also that this value can be overwritten.
Priority Supported Property Determines which clip takes priority when multiple animations are playing simultaneously.
Determines which clip takes priority when multiple animations are playing simultaneously. Multiple playing animations look to this property to figure out which Keyframe poses should be played over one another.
Note that AnimationTrack instances internally load an AnimationClip when an Animation is requested via its AnimationId, and the AnimationTrack.Priority property will default to the original AnimationClip value. Note also that this value can be overwritten.
Methods¶
AddKeyframe Supported Function Adds a Keyframe to the KeyframeSequence by parenting it to the KeyframeSequence.
This method adds a Keyframe to the KeyframeSequence by parenting it to the KeyframeSequence. It is functionally identical to setting the keyframe's Instance.Parent to the KeyframeSequence.
Note that this method will not error when called with an instance other
than a Keyframe as the keyframe parameter and will parent it
successfully.
GetKeyframes Supported Function Returns an array that contains all Keyframes contained in a KeyframeSequence.
Returns an array that contains all Keyframes contained in a KeyframeSequence.
This method returns an array that contains all Keyframes that have been added to a KeyframeSequence.
RemoveKeyframe Supported Function This method removes a Keyframe from the KeyframeSequence by setting its parent to nil.
This method removes a Keyframe from the KeyframeSequence
by setting its parent to nil. It is functionally identical to setting
the keyframe's parent to nil.
Note that while this sets the keyframe's parent to nil, it does not
destroy it. Provided another reference to the keyframe remains, it can be
re-parented later.
Also note that this method will not error when called with an Instance other than a Keyframe as the keyframe parameter.
Inherited members¶
Inherited from Instance: 8 properties, 36 methods, 7 events. They are documented on the base class page.
1 modern Roblox member(s) are not implemented yet — expand to inspect
Members declared by Roblox's KeyframeSequence class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.
Properties¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
Length |
Length: float |
Not yet | Inherited from AnimationClip. | ReadOnly, NotReplicated |
Roblox reference: KeyframeSequence
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.