API:Class/AnimationTrack

Filtered-inheritance mode: While this class technically inherits all Instance class members, some (if not all) have been hidden because they serve no purpose for this object.

Animation icon.pngAnimationTrack : Object Icon.pngInstance

Controls the playback of an animation on a Humanoid or AnimationController. This object cannot be created, rather it is returned by the LoadAnimation method.

Properties

Properties [toggle]

Ref<Animation>Animation [readonly]

The animation object that was used to create this track.

|RMD member="API:Class/AnimationTrack/Animation"|The animation object that was used to create this track.|/RMD|
boolIsPlaying [readonly]

This property will return true when the animation is playing.

|RMD member="API:Class/AnimationTrack/IsPlaying"|This property will return true when the animation is playing.|/RMD|
floatLength [readonly]

The length of the animation from which this track was defined (in seconds).

|RMD member="API:Class/AnimationTrack/Length"|The length of the animation from which this track was defined (in seconds).|/RMD|
boolLooped

Sets whether the animation will repeat after finishing.

|RMD member="API:Class/AnimationTrack/Looped"|Sets whether the animation will repeat after finishing.|/RMD|
AnimationPriorityPriority

The priority of an AnimationTrack. Depending on what this is set to, playing multiple animations at once will look to this property to figure out which KeyFrame Poses should be played over one another.

|RMD member="API:Class/AnimationTrack/Priority"|The priority of an AnimationTrack. Depending on what this is set to, playing multiple animations at once will look to this property to figure out which KeyFrame Poses should be played over one another.|/RMD|
floatSpeed [readonly]

Current playback speed of the AnimationTrack.

|RMD member="API:Class/AnimationTrack/Speed"|Current playback speed of the AnimationTrack.|/RMD|
floatTimePosition

The position in time in seconds that this track is through its source animation. Can be set to make the track jump to a specific moment in the animation.

|RMD member="API:Class/AnimationTrack/TimePosition"|The position in time in seconds that this track is through its source animation. Can be set to make the track jump to a specific moment in the animation.|/RMD|
floatWeightCurrent [readonly]

The current weight of the AnimationTrack.

|RMD member="API:Class/AnimationTrack/WeightCurrent"|The current weight of the AnimationTrack.|/RMD|
floatWeightTarget [readonly]

The target weight of the AnimationTrack.

|RMD member="API:Class/AnimationTrack/WeightTarget"|The target weight of the AnimationTrack.|/RMD|
Animation [readonly]
The animation object that was used to create this track.
IsPlaying [readonly]
This property will return true when the animation is playing.
Length [readonly]
The length of the animation from which this track was defined (in seconds).
Sets whether the animation will repeat after finishing.
The priority of an AnimationTrack. Depending on what this is set to, playing multiple animations at once will look to this property to figure out which KeyFrame Poses should be played over one another.
Speed [readonly]
Current playback speed of the AnimationTrack.
The position in time in seconds that this track is through its source animation. Can be set to make the track jump to a specific moment in the animation.
WeightCurrent [readonly]
The current weight of the AnimationTrack.
WeightTarget [readonly]
The target weight of the AnimationTrack.

Functions

Functions [toggle]

voidAdjustSpeed ( float speed = 1 )

Changes the speed of an animation.

|RMD member="API:Class/AnimationTrack/AdjustSpeed"|Changes the speed of an animation.|/RMD|
voidAdjustWeight ( float weight = 1, float fadeTime = 0.100000001 )

Changes the weight of an animation.

|RMD member="API:Class/AnimationTrack/AdjustWeight"|Changes the weight of an animation.|/RMD|
doubleGetTimeOfKeyframe ( string keyframeName )

Returns the time of the first keyframe of the given name.

|RMD member="API:Class/AnimationTrack/GetTimeOfKeyframe"|Returns the time of the first keyframe of the given name.|/RMD|
voidPlay ( float fadeTime = 0.100000001, float weight = 1, float speed = 1 )

Plays the AnimationTrack.

|RMD member="API:Class/AnimationTrack/Play"|Plays the AnimationTrack.|/RMD|
voidStop ( float fadeTime = 0.100000001 )

Stops the animation.

|RMD member="API:Class/AnimationTrack/Stop"|Stops the animation.|/RMD|
AdjustSpeed ( float speed = 1 )
Changes the speed of an animation.
AdjustWeight ( float weight = 1, float fadeTime = 0.100000001 )
Changes the weight of an animation.
GetTimeOfKeyframe ( string keyframeName )
Returns the time of the first keyframe of the given name.
Play ( float fadeTime = 0.100000001, float weight = 1, float speed = 1 )
Plays the AnimationTrack.
Stop ( float fadeTime = 0.100000001 )
Stops the animation.
Inherited from Object Icon.pngInstance:
voidDestroy ( )

Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.

|RMD member="API:Class/Instance/Destroy"|Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.|/RMD|
RBXScriptSignalGetPropertyChangedSignal ( string property )

Returns a signal that is fired when the specified property is changed on this object.

|RMD member="API:Class/Instance/GetPropertyChangedSignal"|Returns a signal that is fired when the specified property is changed on this object.|/RMD|
Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.
Returns a signal that is fired when the specified property is changed on this object.


Events

Events [toggle]

DidLoop ( )

Fires when the animation track goes through a loop.

|RMD member="API:Class/AnimationTrack/DidLoop"|Fires when the animation track goes through a loop.|/RMD|
KeyframeReached ( string keyframeName )

Fires every time the animation reaches a new keyframe. Important: Keyframes that are named "Keyframe" (the default) will not fire this event. For instructions regarding keyframe naming, please view this page.

|RMD member="API:Class/AnimationTrack/KeyframeReached"|Fires every time the animation reaches a new keyframe.

Important: Keyframes that are named "Keyframe" (the default) will not fire this event. For instructions regarding keyframe naming, please view this page.|/RMD|

Stopped ( )

Fires whenever the AnimationTrack finishes playing.

|RMD member="API:Class/AnimationTrack/Stopped"|Fires whenever the AnimationTrack finishes playing.|/RMD|
Fires when the animation track goes through a loop.
KeyframeReached ( string keyframeName )
Fires every time the animation reaches a new keyframe. Important: Keyframes that are named "Keyframe" (the default) will not fire this event. For instructions regarding keyframe naming, please view this page.
Fires whenever the AnimationTrack finishes playing.
Inherited from Object Icon.pngInstance:
Changed ( string property )

Fires after a property of the object changes.

|RMD member="API:Class/Instance/Changed"|Fires after a property of the object changes.|/RMD|
Changed ( string property )
Fires after a property of the object changes.

|RMD member="API:Class/AnimationTrack"|Controls the playback of an animation on a Humanoid or AnimationController. This object cannot be created, rather it is returned by the LoadAnimation method. |/RMD|