KeyframeSequenceProvider¶
Provides functions to load and preview KeyframeSequence.
Description¶
The KeyframeSequenceProvider service provides functions to load and preview KeyframeSequences. It includes a number of functions that are useful when working with Animations.
A KeyframeSequence stores a series of Poses that encode the hierarchy and motion of an animation. The animation data Roblox uses in the playback of an animation, referenced by the Animation.AnimationId property, can be constructed from a KeyframeSequence. KeyframeSequences are usually created by the Roblox Animation Editor but can be created through other plugins or even manually.
Inheritance¶
Object → Instance → KeyframeSequenceProvider
Nova inheritance: Instance → KeyframeSequenceProvider
Methods¶
GetAnimations Supported Function Deprecated This function returns an InventoryPages object which can be used to iterate over animations owned by a specific user.
This function returns an InventoryPages object which can be used to iterate over animations owned by a specific user.
GetKeyframeSequence Supported Function Deprecated Returns a KeyframeSequence from a given asset URL.
Returns a KeyframeSequence from a given asset URL.
Roblox reference signature
GetKeyframeSequenceById Supported Function Deprecated Returns a KeyframeSequence from the supplied assetId.
Returns a KeyframeSequence from the supplied assetId. Can optionally cache to reduce unnecessary loading freezes.
Roblox reference signature
RegisterActiveKeyframeSequence Supported Function Generates a temporary asset ID from a KeyframeSequence that can be used for localized testing of an animation. Generates an _active://_ URL.
Generates a temporary asset ID from a KeyframeSequence that can be used for localized testing of an animation.
This function performs the same function to KeyframeSequenceProvider.RegisterKeyframeSequence() however this function generates an active:// URL instead of a hash.
The ID generated can be used in an Animation.AnimationId property for testing.
The asset ID generated by this function is temporary and cannot be used outside of Studio. Developers wishing to generate an asset ID that can be used online should upload the KeyframeSequence to Roblox.
Roblox reference signature
RegisterKeyframeSequence Supported Function Generates a temporary asset ID from a KeyframeSequence that can be used for localized testing of an animation. Generates a hash.
Generates a temporary asset ID from a KeyframeSequence that can be used for localized testing of an animation.
This function performs the same function to KeyframeSequenceProvider.RegisterActiveKeyframeSequence() however this function generates a hash instead of an active:// URL.
The ID generated can be used for the Animation.AnimationId property to test animations.
The asset ID generated by this function is temporary and cannot be used outside of Studio. Developers wishing to generate an asset ID that can be used online should upload the KeyframeSequence to Roblox.
Roblox reference signature
Inherited members¶
Inherited from Instance: 8 properties, 36 methods, 7 events. They are documented on the base class page.
3 modern Roblox member(s) are not implemented yet — expand to inspect
Members declared by Roblox's KeyframeSequenceProvider 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.
Methods¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
GetAnimationsAsync |
KeyframeSequenceProvider:GetAnimationsAsync(userId: User): Instance |
Not yet | This function returns an InventoryPages object which can be used to iterate over animations owned by a specific user. | Yields |
GetKeyframeSequenceAsync |
KeyframeSequenceProvider:GetKeyframeSequenceAsync(assetId: ContentId): Instance |
Not yet | Returns a KeyframeSequence based on the specified assetId asynchronously. | Yields |
GetMemStats |
KeyframeSequenceProvider:GetMemStats(): Dictionary |
Not yet | — | RobloxScriptSecurity |
Roblox reference: KeyframeSequenceProvider
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.