AnimationClipProvider

Show Deprecated

Not Creatable

Service

Not Replicated

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.

Summary

Properties

Properties inherited from Instance

Methods

GetMemStats(): table

Returns a Lua table with memory usage for all animations stored in the cache.

RegisterActiveAnimationClip(animationClip: AnimationClip): Content

Generates a temporary asset ID from a AnimationClip that can be used for localized testing of an animation. Generates an active:// URL.

RegisterAnimationClip(animationClip: AnimationClip): Content

Generates a temporary asset ID from a AnimationClip that can be used for localized testing of an animation. Generates a hash.

GetAnimationClipAsync(assetId: Content): AnimationClip YIELDS

Returns a AnimationClip based on the specified assetId asynchronously.

GetAnimations(userId: number): Instance YIELDS

This function returns an InventoryPages object which can be used to iterate over animations owned by a specific user.

Methods inherited from Instance

Events

Events inherited from Instance

Properties

Properties inherited from Instance

Methods

GetMemStats

table

Roblox Script Security

Returns a Lua table with memory usage for all animations stored in the cache. The memory reported is a summation of all of the memory used in any of the animation caches stored by the AnimationClipProvider.

Returns

table

A Lua table with key storing the animation names and value returning the amount of memory used by that animation.

RegisterActiveAnimationClip

Content

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 RegisterAnimationClip yet generates an active:// URL instead of a hash.

The ID generated can be used in an AnimationClip's 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

animationClip: AnimationClip

The AnimationClip to be used.

Returns

Content

A temporary asset ID generated for localized animation playback.

RegisterAnimationClip

Content

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 an active:// URL instead of a hash.

The ID generated can be used for the Animation.AnimationId property to test animations.

Parameters

animationClip: AnimationClip

The AnimationClip to be used.

Returns

Content

A temporary asset ID generated for localized animation playback.

GetAnimationClipAsync

AnimationClip

Yields

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.