Animation
CreatorHub

References an animation asset which can be loaded by an AnimationController.

Memory category	Animation

Member index 2

History		Member
726		AnimationContent: Content
645		AnimationId: ContentId
60 members inherited from Instance
726		Archivable: bool
726		Capabilities: SecurityCapabilities
726		DataCost: int
726		IsInSandbox: bool
726		Name: string
726		Parent: Instance
726		PredictionMode: PredictionMode
726		RobloxLocked: bool
726		Sandboxed: bool
726		SourceAssetId: int64
726		UniqueId: UniqueId
726		archivable: bool
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
707		GetDescendants(): Instances
486		GetFullName(): string
706		GetStyled(name: string, selector: string?): Variant
657		GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
664		IsPropertyModified(property: string): bool
698		QueryDescendants(selector: string): Instances
573		Remove(): null
576		RemoveTag(tag: string): null
664		ResetPropertyToDefault(property: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
726		children(): Instances
726		clone(): Instance
726		destroy(): null
726		findFirstChild(name: string, recursive: bool = false): Instance
726		getChildren(): Instances
726		isDescendantOf(ancestor: Instance): bool
726		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
657		StyledPropertiesChanged()
726		childAdded(child: Instance)
6 members inherited from Object
726		ClassName: string
726		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
726		isA(className: string): bool
647		Changed(property: string)

Description

An object that references an animation asset (AnimationId) which can be loaded by an AnimationController.

Loading an Animation on Client or Server

In order for AnimationTracks to replicate correctly, it's important to know when they should be loaded on the client or on the server:

If an Animator is a descendant of a Humanoid or AnimationController in a player's Player.Character, animations started on that player's client will be replicated to the server and other clients.
If the Animator is not a descendant of a player character, its animations must be loaded and started on the server to replicate.

The Animator object must be initially created on the server and replicated to clients for animation replication to work at all. If an Animator is created locally, then AnimationTracks loaded with that Animator will not replicate.

See also Animation Editor and Using Animations to learn how to create and add pre-built or custom animations to your game.

History 8
Hide member changes

726 Change Default of AnimationContent from to
725 Add AnimationContent
645 Change ValueType of AnimationId from Content to ContentId
486 Change ThreadSafety of AnimationId from ReadOnly to ReadSafe
462 Change ThreadSafety of AnimationId from to ReadOnly
55 Change Tags of Animation from [preliminary] to []
47 Add AnimationId
47 Add Animation

Members 2

AnimationContent
CreatorHub

Type		Default
Content

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 2

726 Change Default of AnimationContent from to
725 Add AnimationContent

AnimationId
CreatorHub

Type		Default
ContentId

This property is the asset ID of the animation an Animation object is referencing. Once an animation has been created and uploaded to Roblox, the ID can be copied from the Creator Dashboard.

Note that the animation will need to be loaded onto an AnimationTrack in order to play it.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 4

645 Change ValueType of AnimationId from Content to ContentId
486 Change ThreadSafety of AnimationId from ReadOnly to ReadSafe
462 Change ThreadSafety of AnimationId from to ReadOnly
47 Add AnimationId

Reference API Roblox

Engine API

Website

Related