AnimationTrack

Missing API Documentation

This API Class does not have any or complete API documentation. Please add API documentation if possible.

Returned by a call to LoadAnimation. Controls the playback of an animation on a Humanoid.

Properties

Animation: Animation

Read-onlyThis property is capable of being read but not written.
Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:AnimationTrack/Animation.

Category: Data.
Serialization: cannot load or save.
Thread safety: read safe

IsPlaying: bool

Read-onlyThis property is capable of being read but not written.
Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:AnimationTrack/IsPlaying.

Category: Data.
Serialization: cannot load or save.
Thread safety: read safe

Length: float

Read-onlyThis property is capable of being read but not written.
Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:AnimationTrack/Length.

Category: Data.
Serialization: cannot load or save.
Thread safety: read safe

Looped: bool

This class member is missing documentation. Create or add to its subpage at Class:AnimationTrack/Looped.

Category: Data.
Serialization: cannot load or save.
Thread safety: read safe

Priority: AnimationPriority

This class member is missing documentation. Create or add to its subpage at Class:AnimationTrack/Priority.

Category: Data.
Serialization: can save and load.
Thread safety: read safe

Speed: float

Read-onlyThis property is capable of being read but not written.
Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:AnimationTrack/Speed.

Category: Data.
Serialization: cannot load or save.
Thread safety: read safe

TimePosition: float

Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:AnimationTrack/TimePosition.

Category: Data.
Serialization: can load only.
Thread safety: read safe

WeightCurrent: float

Read-onlyThis property is capable of being read but not written.
Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:AnimationTrack/WeightCurrent.

Category: Data.
Serialization: cannot load or save.
Thread safety: read safe

WeightTarget: float

Read-onlyThis property is capable of being read but not written.
Not replicatedThis member is not replicated across the network boundary.

This class member is missing documentation. Create or add to its subpage at Class:AnimationTrack/WeightTarget.

Category: Data.
Serialization: cannot load or save.
Thread safety: read safe

Methods

AdjustSpeed(`speed`: float = 1): null

Custom Lua stateThis member uses the Lua C API directly.

Parameters
Name	Type	Default
`speed`	float	1

Thread safety: unsafe

AdjustWeight(`weight`: float = 1, `fadeTime`: float = 0.100000001): null

Custom Lua stateThis member uses the Lua C API directly.

Parameters
Name	Type	Default
`weight`	float	1
`fadeTime`	float	0.100000001

Thread safety: unsafe

GetDebugData(): Dictionary

This class member is missing documentation. Create or add to its subpage at Class:AnimationTrack/GetDebugData.

Security: RobloxScriptSecurity.
Thread safety: unsafe

GetMarkerReachedSignal(`name`: string): RBXScriptSignal

Parameters
Name	Type
`name`	string

Thread safety: unsafe

GetParameter(`key`: string): Variant

This class member is missing documentation. Create or add to its subpage at Class:AnimationTrack/GetParameter.

Thread safety: unsafe

GetParameterDefaults(): Dictionary

This class member is missing documentation. Create or add to its subpage at Class:AnimationTrack/GetParameterDefaults.

Thread safety: unsafe

GetTargetInstance(`name`: string): Instance

This class member is missing documentation. Create or add to its subpage at Class:AnimationTrack/GetTargetInstance.

Thread safety: unsafe

GetTargetNames(): Array

This class member is missing documentation. Create or add to its subpage at Class:AnimationTrack/GetTargetNames.

Thread safety: unsafe

GetTimeOfKeyframe(`keyframeName`: string): double

Parameters
Name	Type
`keyframeName`	string

Thread safety: unsafe

Play(`fadeTime`: float = 0.100000001, `weight`: float = 1, `speed`: float = 1): null

Custom Lua stateThis member uses the Lua C API directly.

Parameters
Name	Type	Default
`fadeTime`	float	0.100000001
`weight`	float	1
`speed`	float	1

Thread safety: unsafe

SetParameter(`key`: string, `value`: Variant): null

This class member is missing documentation. Create or add to its subpage at Class:AnimationTrack/SetParameter.

Thread safety: unsafe

SetTargetInstance(`name`: string, `target`: Instance): null

This class member is missing documentation. Create or add to its subpage at Class:AnimationTrack/SetTargetInstance.

Thread safety: unsafe

Stop(`fadeTime`: float = 0.100000001): null

Custom Lua stateThis member uses the Lua C API directly.

Parameters
Name	Type	Default
`fadeTime`	float	0.100000001

Thread safety: unsafe

Events

DidLoop()

This class member is missing documentation. Create or add to its subpage at Class:AnimationTrack/DidLoop.

Thread safety: unsafe

Ended()

This class member is missing documentation. Create or add to its subpage at Class:AnimationTrack/Ended.

Thread safety: unsafe

KeyframeReached(`keyframeName`: string)

Parameters
Name	Type
`keyframeName`	string

Thread safety: unsafe

Stopped()

This class member is missing documentation. Create or add to its subpage at Class:AnimationTrack/Stopped.

Thread safety: unsafe

External links[]

AnimationTrack in the Roblox Creator Documentation
AnimationTrack in the Roblox API Reference