Open Asterune
AnimationTrack

AnimationTrack

Controls playback, speed, time, and weight of a loaded animation.

Behavior

AnimationTrack controls playback, speed, time, and weight of a loaded animation.

Summary

Members22
Properties11
Methods7
  • AdjustSpeed(speed: number?): ()

    Changes the playback speed multiplier.

  • AdjustWeight(weight: number?, fadeTime: number?): ()

    Changes the target blend weight over the supplied fade duration, in seconds.

  • Stops playback and releases this playback object.

  • Returns the signal for the named animation marker.

  • IsA(wanted: string): boolean

    Returns whether the value matches the supplied type name.

  • Play(fadeTime: number?, weight: number?, speed: number?): ()

    Starts playback with optional fade, weight, or speed parameters.

  • Stop(fadeTime: number?): ()

    Stops playback with an optional fade duration, in seconds.

Events4

Properties

Animation

AnimationTrack.Animation: Animation?

The Animation from which this track was loaded.

ClassName

AnimationTrack.ClassName: string

The runtime type name.

IsPlaying

AnimationTrack.IsPlaying: boolean

Whether playback is currently active.

Length

AnimationTrack.Length: number

The duration of the loaded animation, in seconds.

Looped

AnimationTrack.Looped: boolean

Whether playback repeats after reaching the end.

Name

AnimationTrack.Name: string

The runtime value name.

Priority

AnimationTrack.Priority: EnumItem

The animation priority used to resolve competing joint poses.

Speed

AnimationTrack.Speed: number

The playback speed multiplier.

TimePosition

AnimationTrack.TimePosition: number

The current playback position, in seconds.

WeightCurrent

AnimationTrack.WeightCurrent: number

The current blend weight.

WeightTarget

AnimationTrack.WeightTarget: number

The blend weight being approached.

Methods

AdjustSpeed

AnimationTrack:AdjustSpeed(speed: number?): ()

Changes the playback speed multiplier.

AdjustWeight

AnimationTrack:AdjustWeight(weight: number?, fadeTime: number?): ()

Changes the target blend weight over the supplied fade duration, in seconds.

Destroy

AnimationTrack:Destroy(): ()

Stops playback and releases this playback object.

GetMarkerReachedSignal

AnimationTrack:GetMarkerReachedSignal(name: string): AstScriptSignal<string>

Returns the signal for the named animation marker.

IsA

AnimationTrack:IsA(wanted: string): boolean

Returns whether the value matches the supplied type name.

Play

AnimationTrack:Play(fadeTime: number?, weight: number?, speed: number?): ()

Starts playback with optional fade, weight, or speed parameters.

Stop

AnimationTrack:Stop(fadeTime: number?): ()

Stops playback with an optional fade duration, in seconds.

Events

DidLoop

AnimationTrack.DidLoop: RBXScriptSignal

Fires when the track completes a loop.

Ended

AnimationTrack.Ended: RBXScriptSignal

Fires when playback and its influence on the pose have ended.

KeyframeReached

AnimationTrack.KeyframeReached: RBXScriptSignal

Fires when playback reaches a named keyframe.

Stopped

AnimationTrack.Stopped: RBXScriptSignal

Fires when playback stops.

Operators

__type

Used by

Animation · AnimationController · Animator · Humanoid