AnimationClipProvider¶
Not yet Class NotCreatable NotReplicated Service
Provides functions to load and preview AnimationClips.
Not implemented yet
This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.
0 Nova members · 17 modern Roblox members not implemented yet
Description¶
Provides functions to load and preview AnimationClips. It includes a number of functions that are useful when working with an Animation.
The AnimationClipProvider replaces the deprecated
KeyframeSequenceProvider that was used to download KeyframeSequences
by content ID.
The AnimationClipProvider has a number of uses.
- Download the AnimationClip associated with an animation content ID from the Roblox website, regardless of the underlying type of AnimationClip (KeyframeSequence or CurveAnimation).
- Generate a temporary ID to locally preview an animation.
- Fetch the content IDs of animations owned by a particular user.
Inheritance¶
Object → Instance → AnimationClipProvider
Methods¶
| Member | Signature | Summary |
|---|---|---|
GetAnimationClip |
AnimationClipProvider:GetAnimationClip(assetId: ContentId): AnimationClip |
Returns a AnimationClip from a given asset URL. |
GetAnimationClipAsync |
AnimationClipProvider:GetAnimationClipAsync(assetId: ContentId): AnimationClip |
Returns a AnimationClip based on the specified assetId asynchronously. |
GetAnimationClipById |
AnimationClipProvider:GetAnimationClipById(assetId: int64, useCache: bool): AnimationClip |
Returns a AnimationClip from the supplied assetId. |
GetAnimationNodeDefinition |
AnimationClipProvider:GetAnimationNodeDefinition(type: AnimationNodeType): Dictionary |
— |
GetAnimationNodeTypes |
AnimationClipProvider:GetAnimationNodeTypes(): Array |
— |
GetAnimations |
AnimationClipProvider:GetAnimations(userId: User): Instance |
This function returns an InventoryPages object which can be used to iterate over animations owned by a specific user. |
GetAnimationsAsync |
AnimationClipProvider:GetAnimationsAsync(userId: User): Instance |
This function returns an InventoryPages object which can be used to iterate over animations owned by a specific user. |
GetClipEvaluatorAsync |
AnimationClipProvider:GetClipEvaluatorAsync(assetId: ContentId): ClipEvaluator |
Returns a ClipEvaluator for the AnimationClip at the given content ID, loaded asynchronously. |
GetMemStats |
AnimationClipProvider:GetMemStats(): Dictionary |
— |
RegisterActiveAnimationClip |
AnimationClipProvider:RegisterActiveAnimationClip(animationClip: AnimationClip): ContentId |
Generates a temporary asset ID from a AnimationClip that can be used for localized testing of an animation. |
RegisterAnimationClip |
AnimationClipProvider:RegisterAnimationClip(animationClip: AnimationClip): ContentId |
Generates a temporary asset ID from a AnimationClip that can be used for localized testing of an animation. Generates a hash. |
Roblox reference: AnimationClipProvider
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.