Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AnimationClip

Represents all types of animation data that the Roblox animation system can consume.

This class is not creatable. Instances of this class cannot be created with Instance.new.
Tags: [NotCreatable]

Member index 5

HistoryMember
731Length: float
731Loop: bool
731Priority: AnimationPriority
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: 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
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Description

The non-creatable AnimationClip instance type represents abstract animation data that can be fed to the Roblox animation system. KeyframeSequence and CurveAnimation are two current instance types that inherit from AnimationClip.

There are different ways to represent animation data. To simplify the use of Roblox's animation system, all such representations are their own instance types but inherit from the AnimationClip instance. Animation clips published to Roblox via the Animation Editor can be loaded into the Roblox Engine using an Animation instance.

History 20

Members 5

Length

TypeDefault
float
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 5

Tags: [ReadOnly, NotReplicated]

Loop

TypeDefault
bool

Determines whether the animation stored in this AnimationClip is intended to loop. When set to true, the animation will continuously repeat each time it finishes.

Note that AnimationTrack instances internally load an AnimationClip when an Animation is requested via its AnimationId, and the AnimationTrack.Looped property will default to the original AnimationClip value. Note also that this value can be overwritten.

History 4

Priority

TypeDefault
AnimationPriority

Determines which clip takes priority when multiple animations are playing simultaneously. Multiple playing animations look to this property to figure out which Keyframe poses should be played over one another.

Note that AnimationTrack instances internally load an AnimationClip when an Animation is requested via its AnimationId, and the AnimationTrack.Priority property will default to the original AnimationClip value. Note also that this value can be overwritten.

History 4

Settings