Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AnimationClipProvider

Provides functions to load and preview AnimationClips.

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Memory categoryAnimation
Tags: [NotCreatable, Service, NotReplicated]

Member index 11

HistoryMember
726GetAnimationClip(assetId: ContentId): AnimationClip
645GetAnimationClipAsync(assetId: ContentId): AnimationClip
726GetAnimationClipById(assetId: int64, useCache: bool): AnimationClip
697GetAnimationNodeDefinition(type: AnimationNodeType): Dictionary
697GetAnimationNodeTypes(): Array
726GetAnimations(userId: User): Instance
725GetAnimationsAsync(userId: User): Instance
645GetClipEvaluatorAsync(assetId: ContentId): ClipEvaluator
502GetMemStats(): Dictionary
645RegisterActiveAnimationClip(animationClip: AnimationClip): ContentId
645RegisterAnimationClip(animationClip: AnimationClip): ContentId
inherited from Instance
726Archivable: bool
726Capabilities: SecurityCapabilities
726IsInSandbox: bool
726Name: string
726Parent: Instance
726PredictionMode: PredictionMode
726Sandboxed: bool
726UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
726children(): Instances
726clone(): Instance
726destroy(): null
726findFirstChild(name: string, recursive: bool = false): Instance
726getChildren(): Instances
726isDescendantOf(ancestor: Instance): bool
726remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
726childAdded(child: Instance)
inherited from Object
726ClassName: string
726className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
726isA(className: string): bool
647Changed(property: string)

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.

History 32

Members 11

GetAnimationClip

Parameters (1)
assetIdContentId
Returns (1)
AnimationClip

Returns a AnimationClip from a given asset URL.

This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
SecurityPluginSecurity
Thread safetyUnsafe

History 4

Tags: [Deprecated]

GetAnimationClipAsync

Parameters (1)
assetIdContentId
Returns (1)
AnimationClip

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.

This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 2

Tags: [Yields]

GetAnimationClipById

Parameters (2)
assetIdint64
useCachebool
Returns (1)
AnimationClip

Returns a AnimationClip from the supplied assetId. Can optionally cache to reduce unnecessary loading freezes.

This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
SecurityPluginSecurity
Thread safetyUnsafe

History 3

Tags: [Deprecated]

GetAnimationNodeDefinition

Parameters (1)
typeAnimationNodeType
Returns (1)
Dictionary
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

GetAnimationNodeTypes

Parameters (0)
No parameters.
Returns (1)
Array
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

GetAnimations

Parameters (1)
userIdUser
Returns (1)
Instance
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 9

Tags: [Yields, Deprecated]

GetAnimationsAsync

Parameters (1)
userIdUser
Returns (1)
Instance

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.

This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 4

Tags: [Yields]

GetClipEvaluatorAsync

Parameters (1)
assetIdContentId
Returns (1)
ClipEvaluator
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 2

Tags: [Yields]

GetMemStats

Parameters (0)
No parameters.
Returns (1)
Dictionary
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

RegisterActiveAnimationClip

Parameters (1)
animationClipAnimationClip
Returns (1)
ContentId

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.

Thread safetyUnsafe

History 2

RegisterAnimationClip

Parameters (1)
animationClipAnimationClip
Returns (1)
ContentId

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.

Thread safetyUnsafe

History 2

Settings