Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
AnimationClipProvider
Inherits from: Instance → Object
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
AnimationClipassociated with an animation content ID from the Roblox website, regardless of the underlying type ofAnimationClip(KeyframeSequenceorCurveAnimation). - Generate a temporary ID to locally preview an animation.
- Fetch the content IDs of animations owned by a particular user.
Inherits from: Instance
Memory category: Animation
Tags: NotCreatable, Service, NotReplicated
Methods
| Name | Type / Returns | Description |
|---|---|---|
| AnimationClipProvider:GetAnimationClip | AnimationClip | Returns a AnimationClip from a given asset URL. |
| AnimationClipProvider:GetAnimationClipAsync | AnimationClip | Returns a AnimationClip based on the specified assetId asynchronously. |
| AnimationClipProvider:GetAnimationClipById | AnimationClip | Returns a AnimationClip from the supplied assetId. |
| AnimationClipProvider:GetAnimations | Instance | This function returns an InventoryPages object which can be used to iterate over animations owned by a specific user. |
| AnimationClipProvider:GetAnimationsAsync | Instance | This function returns an InventoryPages object which can be used to iterate over animations owned by a specific user. |
| AnimationClipProvider:GetClipEvaluatorAsync | ClipEvaluator | Returns a ClipEvaluator for the AnimationClip at the given content ID, loaded asynchronously. |
| AnimationClipProvider:RegisterActiveAnimationClip | ContentId | Generates a temporary asset ID from a AnimationClip that can be used for localized testing of an animation. |
| AnimationClipProvider:RegisterAnimationClip | ContentId | Generates a temporary asset ID from a AnimationClip that can be used for localized testing of an animation. Generates a hash. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |
AnimationClipProvider:GetAnimationClip
Deprecated. This function is deprecated and can lead to the game freezing until the animation is loaded. Developers are recommended to use GetAnimationClipAsync instead.
Returns a AnimationClip from a given asset URL.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| assetId | ContentId | The content ID of the animation. |
Returns
| Type | Description |
|---|---|
| AnimationClip | The AnimationClip found. |
| Field | Value |
|---|---|
| tags | ["Deprecated"] |
| security | PluginSecurity |
| thread safety | Unsafe |
| capabilities | ["Animation"] |
AnimationClipProvider:GetAnimationClipAsync
Fetches an AnimationClip based on the specified assetId. The assetId must correspond to an animation asset in Roblox. The function will yield until the AnimationClip is loaded from the website and should be wrapped in a pcall.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| assetId | ContentId | The content ID of the animation. |
Returns
| Type | Description |
|---|---|
| AnimationClip | The AnimationClip found. |
| Field | Value |
|---|---|
| tags | ["Yields"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["Animation"] |
AnimationClipProvider:GetAnimationClipById
Deprecated. This function is deprecated and can lead to the game freezing until the animation is loaded. Developers are recommended to use GetAnimationClipAsync instead.
Returns a AnimationClip from the supplied assetId. Can optionally cache to reduce unnecessary loading freezes.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| assetId | int64 | The content ID of the animation. | |
| useCache | boolean | True if a cached version can be returned. |
Returns
| Type | Description |
|---|---|
| AnimationClip | The AnimationClip found. |
| Field | Value |
|---|---|
| tags | ["Deprecated"] |
| security | PluginSecurity |
| thread safety | Unsafe |
| capabilities | ["Animation"] |
AnimationClipProvider:GetAnimations
Deprecated.
This function returns an InventoryPages object which can be used to iterate over animations owned by a specific user. It yields until the first page of results is loaded from the website. The userId must be a positive number; otherwise the call errors.
This function is deprecated. Use GetAnimationsAsync instead, which behaves identically.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| userId | User | The user ID of the user. |
Returns
| Type | Description |
|---|---|
| Instance | An InventoryPages of animations. |
| Field | Value |
|---|---|
| tags | ["Yields","Deprecated"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["Animation"] |
AnimationClipProvider:GetAnimationsAsync
This function returns an InventoryPages object which can be used to iterate over animations owned by a specific user.
This function has a number of potential uses, such as allowing users to browse and import animations into a custom animation plugin.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| userId | User | The user ID of the user. |
Returns
| Type | Description |
|---|---|
| Instance | An InventoryPages of animations. |
| Field | Value |
|---|---|
| tags | ["Yields"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["Animation"] |
AnimationClipProvider:GetClipEvaluatorAsync
Fetches the AnimationClip at the specified assetId and returns a ClipEvaluator that wraps it. A ClipEvaluator samples the clip at an arbitrary time to produce an animation pose, so you can read animation data directly instead of playing it back through an Animator.
The assetId must be an animation asset on Roblox. Yields until the clip is loaded and should be wrapped in a pcall. Loads through the same path as GetAnimationClipAsync, at the local player animation priority.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| assetId | ContentId | The content ID of the animation to load. |
Returns
| Type | Description |
|---|---|
| ClipEvaluator | A ClipEvaluator that can sample the loaded AnimationClip. |
| Field | Value |
|---|---|
| tags | ["Yields"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["Animation"] |
AnimationClipProvider:RegisterActiveAnimationClip
Generates a temporary asset ID from a AnimationClip that can be used for localized testing of an animation. This performs the same function as RegisterAnimationClip() but generates an active:// URL instead of a hash. The generated ID can be used as an 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 AnimationClip to Roblox.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| animationClip | AnimationClip | The AnimationClip to be used. |
Returns
| Type | Description |
|---|---|
| ContentId | A temporary asset ID generated for localized animation playback. |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Animation"] |
AnimationClipProvider:RegisterAnimationClip
Generates a temporary asset ID from a AnimationClip that can be used for localized testing of an animation.
This function performs the same function to RegisterActiveAnimationClip yet 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 AnimationClip to Roblox.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| animationClip | AnimationClip | The AnimationClip to be used. |
Returns
| Type | Description |
|---|---|
| ContentId | A temporary asset ID generated for localized animation playback. |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Animation"] |
Properties
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |
Events
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |