Class
AnimationClip
NotCreatable
Represents all types of animation data that the Roblox animation system can consume.
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.
Properties 3#
Lengthfloat | The length in seconds of this clip. Returns 0 until the animation has
fully loaded.ReadSafeReadOnlyNotReplicated |
Loopboolean | Determines whether the animation stored in this AnimationClip is
intended to loop.ReadSafe |
PriorityAnimationPriority | Determines which clip takes priority when multiple animations are playing simultaneously.ReadSafe |
Length: float#
ReadOnlyNotReplicatedReadSafe
The read-only length, in seconds, of this AnimationClip, computed
from the timing of the underlying animation data (its keyframes or
curves).
Because a clip's animation data may still be downloading when the property
is first accessed, Length returns 0 until the animation has fully
loaded. Poll for a non-zero value if you need the duration right away.
AnimationTrack instances load an AnimationClip when an
Animation is requested via its
AnimationId, and
AnimationTrack.Length reflects the underlying
AnimationClip value.
Loop: boolean#
ReadSafe
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.
Priority: AnimationPriority#
ReadSafe
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.
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild