AnimationTrack

Show Deprecated
Not Creatable

Controls the playback of an animation on an Animator. This object cannot be created, instead it is returned by the Animator:LoadAnimation() method.

Summary

Properties

  • Animation:Animation
    Read Only
    Not Replicated
    Read Parallel

    The Animation object that was used to create this AnimationTrack.

  • IsPlaying:boolean
    Read Only
    Not Replicated
    Read Parallel

    A read-only property that returns true when the AnimationTrack is playing.

  • Length:number
    Read Only
    Not Replicated
    Read Parallel

    A read-only property that returns the length (in seconds) of an AnimationTrack. This will return 0 until the animation has fully loaded and thus may not be immediately available.

  • Looped:boolean
    Read Parallel

    Sets whether the animation will repeat after finishing. If it is changed while playing the result will take effect after the animation finishes.

  • Priority:Enum.AnimationPriority
    Read Parallel

    Sets 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:number
    Read Only
    Not Replicated
    Read Parallel

    Read-only property that gives the current playback speed of the AnimationTrack.

  • TimePosition:number
    Not Replicated
    Read Parallel

    Returns the position in time in seconds that an AnimationTrack is through playing its source animation. Can be set to make the track jump to a specific moment in the animation.

  • WeightCurrent:number
    Read Only
    Not Replicated
    Read Parallel

    Read-only property that gives the current weight of the AnimationTrack.

  • WeightTarget:number
    Read Only
    Not Replicated
    Read Parallel

    Read-only property that gives the current weight of the AnimationTrack.

View all inherited from Instance
View all inherited from Object

Methods

View all inherited from Instance
View all inherited from Object

Events

View all inherited from Instance
View all inherited from Object

Properties

Animation

Animation
Read Only
Not Replicated
Read Parallel

Code Samples

Listen For New Animations
local humanoid = script.Parent:WaitForChild("Humanoid")

local animator = humanoid:WaitForChild("Animator")



animator.AnimationPlayed:Connect(function(animationTrack)

	local animationName = animationTrack.Animation.Name

	print("Animation playing " .. animationName)

end)

IsPlaying

boolean
Read Only
Not Replicated
Read Parallel

Code Samples

AnimationTrack IsPlaying
local function playOrAdjust(animationTrack, fadeTime, weight, speed)

	if not animationTrack.IsPlaying then

		animationTrack:Play(fadeTime, weight, speed)

	else

		animationTrack:AdjustSpeed(speed)

		animationTrack:AdjustWeight(weight, fadeTime)

	end

end



local animation = Instance.new("Animation")

animation.AnimationId = "rbxassetid://507765644"



local humanoid = script.Parent:WaitForChild("Humanoid")

local animator = humanoid:WaitForChild("Animator")

local animationTrack = animator:LoadAnimation(animation)



playOrAdjust(animationTrack, 1, 0.6, 1)

Length

number
Read Only
Not Replicated
Read Parallel

Code Samples

Playing Animation for a Specific Duration
local function playAnimationForDuration(animationTrack, duration)

	local speed = animationTrack.Length / duration

	animationTrack:Play()

	animationTrack:AdjustSpeed(speed)

end



local animation = Instance.new("Animation")

animation.AnimationId = "rbxassetid://507765000"



local humanoid = script.Parent:WaitForChild("Humanoid")

local animator = humanoid:WaitForChild("Animator")



local animationTrack = animator:LoadAnimation(animation)



playAnimationForDuration(animationTrack, 3)

Looped

boolean
Read Parallel

Code Samples

Animation Looping
local Players = game:GetService("Players")



local localPlayer = Players.LocalPlayer



while not localPlayer.Character do

	task.wait()

end



local character = localPlayer.Character

local humanoid = character:WaitForChild("Humanoid")

local animator = humanoid:WaitForChild("Animator")



local animation = Instance.new("Animation")

animation.AnimationId = "rbxassetid://507770453"



local animationTrack = animator:LoadAnimation(animation)

animationTrack.Looped = false

task.wait(3)

animationTrack:Play()

task.wait(4)

animationTrack.Looped = true

animationTrack:Play()
Play AnimationTrack for a Number of Loops
local function playForNumberLoops(animationTrack, number)

	animationTrack.Looped = true

	animationTrack:Play()

	local numberOfLoops = 0

	local connection = nil

	connection = animationTrack.DidLoop:Connect(function()

		numberOfLoops = numberOfLoops + 1

		print("loop: ", numberOfLoops)

		if numberOfLoops >= number then

			animationTrack:Stop()

			connection:Disconnect() -- it's important to disconnect connections when they are no longer needed

		end

	end)

end



local animation = Instance.new("Animation")

animation.AnimationId = "rbxassetid://507765644"



local humanoid = script.Parent:WaitForChild("Humanoid")

local animator = humanoid:WaitForChild("Animator")

local animationTrack = animator:LoadAnimation(animation)



playForNumberLoops(animationTrack, 5)

Priority

Enum.AnimationPriority
Read Parallel

Speed

number
Read Only
Not Replicated
Read Parallel

Code Samples

Animation Speed
local ContentProvider = game:GetService("ContentProvider")

local Players = game:GetService("Players")



local localPlayer = Players.LocalPlayer

while not localPlayer.Character do

	task.wait()

end

local character = localPlayer.Character

local humanoid = character:WaitForChild("Humanoid")

local animator = humanoid:WaitForChild("Animator")

local animation = Instance.new("Animation")

animation.AnimationId = "rbxassetid://507770453"



ContentProvider:PreloadAsync({ animation })



local animationTrack = animator:LoadAnimation(animation)



local normalSpeedTime = animationTrack.Length / animationTrack.Speed

animationTrack:AdjustSpeed(3)

local fastSpeedTime = animationTrack.Length / animationTrack.Speed



print("At normal speed the animation will play for", normalSpeedTime, "seconds")

print("At 3x speed the animation will play for", fastSpeedTime, "seconds")
Playing Animation for a Specific Duration
local function playAnimationForDuration(animationTrack, duration)

	local speed = animationTrack.Length / duration

	animationTrack:Play()

	animationTrack:AdjustSpeed(speed)

end



local animation = Instance.new("Animation")

animation.AnimationId = "rbxassetid://507765000"



local humanoid = script.Parent:WaitForChild("Humanoid")

local animator = humanoid:WaitForChild("Animator")



local animationTrack = animator:LoadAnimation(animation)



playAnimationForDuration(animationTrack, 3)

TimePosition

number
Not Replicated
Read Parallel

Code Samples

Freeze Animation at Position
function freezeAnimationAtTime(animationTrack, timePosition)

	if not animationTrack.IsPlaying then

		-- Play the animation if it is not playing

		animationTrack:Play()

	end

	-- Set the speed to 0 to freeze the animation

	animationTrack:AdjustSpeed(0)

	-- Jump to the desired TimePosition

	animationTrack.TimePosition = timePosition

end



function freezeAnimationAtPercent(animationTrack, percentagePosition)

	if not animationTrack.IsPlaying then

		-- Play the animation if it is not playing

		animationTrack:Play()

	end

	-- Set the speed to 0 to freeze the animation

	animationTrack:AdjustSpeed(0)

	-- Jump to the desired TimePosition

	animationTrack.TimePosition = (percentagePosition / 100) * animationTrack.Length

end



local animation = Instance.new("Animation")

animation.AnimationId = "rbxassetid://507765644"



local humanoid = script.Parent:WaitForChild("Humanoid")

local animator = humanoid:WaitForChild("Animator")

local animationTrack = animator:LoadAnimation(animation)



freezeAnimationAtTime(animationTrack, 0.5)

freezeAnimationAtPercent(animationTrack, 50)

WeightCurrent

number
Read Only
Not Replicated
Read Parallel

Code Samples

WeightCurrent and WeightTarget
local Players = game:GetService("Players")



local localPlayer = Players.LocalPlayer



while not localPlayer.Character do

	task.wait()

end

local character = localPlayer.Character



local humanoid = character:WaitForChild("Humanoid")

local animator = humanoid:WaitForChild("Animator")



local animation1 = Instance.new("Animation")

animation1.AnimationId = "rbxassetid://507770453"



local animation2 = Instance.new("Animation")

animation2.AnimationId = "rbxassetid://507771019"



task.wait(3) -- arbitrary wait time to allow the character to fall into place



local animationTrack1 = animator:LoadAnimation(animation1)

local animationTrack2 = animator:LoadAnimation(animation2)



animationTrack1.Priority = Enum.AnimationPriority.Movement

animationTrack2.Priority = Enum.AnimationPriority.Action



animationTrack1:Play(0.1, 5, 1)

animationTrack2:Play(10, 3, 1)



local done = false

while not done and task.wait(0.1) do

	if math.abs(animationTrack2.WeightCurrent - animationTrack2.WeightTarget) < 0.001 then

		print("got there")

		done = true

	end

end

WeightTarget

number
Read Only
Not Replicated
Read Parallel

Code Samples

WeightCurrent and WeightTarget
local Players = game:GetService("Players")



local localPlayer = Players.LocalPlayer



while not localPlayer.Character do

	task.wait()

end

local character = localPlayer.Character



local humanoid = character:WaitForChild("Humanoid")

local animator = humanoid:WaitForChild("Animator")



local animation1 = Instance.new("Animation")

animation1.AnimationId = "rbxassetid://507770453"



local animation2 = Instance.new("Animation")

animation2.AnimationId = "rbxassetid://507771019"



task.wait(3) -- arbitrary wait time to allow the character to fall into place



local animationTrack1 = animator:LoadAnimation(animation1)

local animationTrack2 = animator:LoadAnimation(animation2)



animationTrack1.Priority = Enum.AnimationPriority.Movement

animationTrack2.Priority = Enum.AnimationPriority.Action



animationTrack1:Play(0.1, 5, 1)

animationTrack2:Play(10, 3, 1)



local done = false

while not done and task.wait(0.1) do

	if math.abs(animationTrack2.WeightCurrent - animationTrack2.WeightTarget) < 0.001 then

		print("got there")

		done = true

	end

end
View all inherited from Instance
View all inherited from Object

Methods

AdjustSpeed

()

Parameters

speed: number
Default Value: 1

Returns

()

Code Samples

Playing Animation for a Specific Duration
local function playAnimationForDuration(animationTrack, duration)

	local speed = animationTrack.Length / duration

	animationTrack:Play()

	animationTrack:AdjustSpeed(speed)

end



local animation = Instance.new("Animation")

animation.AnimationId = "rbxassetid://507765000"



local humanoid = script.Parent:WaitForChild("Humanoid")

local animator = humanoid:WaitForChild("Animator")



local animationTrack = animator:LoadAnimation(animation)



playAnimationForDuration(animationTrack, 3)
Animation Speed
local ContentProvider = game:GetService("ContentProvider")

local Players = game:GetService("Players")



local localPlayer = Players.LocalPlayer

while not localPlayer.Character do

	task.wait()

end

local character = localPlayer.Character

local humanoid = character:WaitForChild("Humanoid")

local animator = humanoid:WaitForChild("Animator")

local animation = Instance.new("Animation")

animation.AnimationId = "rbxassetid://507770453"



ContentProvider:PreloadAsync({ animation })



local animationTrack = animator:LoadAnimation(animation)



local normalSpeedTime = animationTrack.Length / animationTrack.Speed

animationTrack:AdjustSpeed(3)

local fastSpeedTime = animationTrack.Length / animationTrack.Speed



print("At normal speed the animation will play for", normalSpeedTime, "seconds")

print("At 3x speed the animation will play for", fastSpeedTime, "seconds")

AdjustWeight

()

Parameters

weight: number
Default Value: 1
fadeTime: number
Default Value: 0.100000001

Returns

()

Code Samples

AnimationTrack Change Weight
local function changeWeight(animationTrack, weight, fadeTime)

	animationTrack:AdjustWeight(weight, fadeTime)

	local startTime = tick()

	while math.abs(animationTrack.WeightCurrent - weight) > 0.001 do

		task.wait()

	end

	print("Time taken to change weight " .. tostring(tick() - startTime))

end



local animation = Instance.new("Animation")

animation.AnimationId = "rbxassetid://507765644"



local humanoid = script.Parent:WaitForChild("Humanoid")

local animator = humanoid:WaitForChild("Animator")

local animationTrack = animator:LoadAnimation(animation)



changeWeight(animationTrack, 0.6, 1)

GetMarkerReachedSignal

RBXScriptSignal

Parameters

name: string

Returns

RBXScriptSignal

Code Samples

Listening to Keyframe Markers
local Players = game:GetService("Players")



local player = Players.LocalPlayer

local character = player.Character or player.Character:Wait()

local humanoid = character:WaitForChild("Humanoid")



-- Create new "Animation" instance

local kickAnimation = Instance.new("Animation")

-- Set its "AnimationId" to the corresponding animation asset ID

kickAnimation.AnimationId = "rbxassetid://2515090838"



-- Load animation onto the humanoid

local kickAnimationTrack = humanoid:LoadAnimation(kickAnimation)



-- Play animation track

kickAnimationTrack:Play()



-- If a named event was defined for the animation, connect it to "GetMarkerReachedSignal()"

kickAnimationTrack:GetMarkerReachedSignal("KickEnd"):Connect(function(paramString)

	print(paramString)

end)

GetTargetInstance

Instance

Parameters

name: string

Returns

Instance

GetTargetNames

Array

Returns

Array

GetTimeOfKeyframe

number

Parameters

keyframeName: string

Returns

number

Code Samples

Jump To Keyframe
local function jumpToKeyframe(animationTrack, keyframeName)

	local timePosition = animationTrack:GetTimeOfKeyframe(keyframeName)

	if not animationTrack.IsPlaying then

		animationTrack:Play()

	end

	animationTrack.TimePosition = timePosition

end



local ANIMATION_ID = 0

local KEYFRAME_NAME = "Test"



local animation = Instance.new("Animation")

animation.AnimationId = "rbxassetid://" .. ANIMATION_ID



local humanoid = script.Parent:WaitForChild("Humanoid")

local animator = humanoid:WaitForChild("Animator")

local animationTrack = animator:LoadAnimation(animation)



jumpToKeyframe(animationTrack, KEYFRAME_NAME)

Play

()

Parameters

fadeTime: number
Default Value: 0.100000001
weight: number
Default Value: 1
speed: number
Default Value: 1

Returns

()

Code Samples

Playing Animation for a Specific Duration
local function playAnimationForDuration(animationTrack, duration)

	local speed = animationTrack.Length / duration

	animationTrack:Play()

	animationTrack:AdjustSpeed(speed)

end



local animation = Instance.new("Animation")

animation.AnimationId = "rbxassetid://507765000"



local humanoid = script.Parent:WaitForChild("Humanoid")

local animator = humanoid:WaitForChild("Animator")



local animationTrack = animator:LoadAnimation(animation)



playAnimationForDuration(animationTrack, 3)
Freeze Animation at Position
function freezeAnimationAtTime(animationTrack, timePosition)

	if not animationTrack.IsPlaying then

		-- Play the animation if it is not playing

		animationTrack:Play()

	end

	-- Set the speed to 0 to freeze the animation

	animationTrack:AdjustSpeed(0)

	-- Jump to the desired TimePosition

	animationTrack.TimePosition = timePosition

end



function freezeAnimationAtPercent(animationTrack, percentagePosition)

	if not animationTrack.IsPlaying then

		-- Play the animation if it is not playing

		animationTrack:Play()

	end

	-- Set the speed to 0 to freeze the animation

	animationTrack:AdjustSpeed(0)

	-- Jump to the desired TimePosition

	animationTrack.TimePosition = (percentagePosition / 100) * animationTrack.Length

end



local animation = Instance.new("Animation")

animation.AnimationId = "rbxassetid://507765644"



local humanoid = script.Parent:WaitForChild("Humanoid")

local animator = humanoid:WaitForChild("Animator")

local animationTrack = animator:LoadAnimation(animation)



freezeAnimationAtTime(animationTrack, 0.5)

freezeAnimationAtPercent(animationTrack, 50)

SetTargetInstance

()

Parameters

name: string
target: Instance

Returns

()

Stop

()

Parameters

fadeTime: number
Default Value: 0.100000001

Returns

()

Code Samples

AnimationTrack Stop
local function fadeOut(animationTrack, fadeTime)

	animationTrack:Stop(fadeTime)

	local startTime = tick()

	while animationTrack.WeightCurrent > 0 do

		task.wait()

	end

	local timeTaken = tick() - startTime

	print("Time taken for weight to reset: " .. tostring(timeTaken))

end



local animation = Instance.new("Animation")

animation.AnimationId = "rbxassetid://507765644"



local humanoid = script.Parent:WaitForChild("Humanoid")

local animator = humanoid:WaitForChild("Animator")

local animationTrack = animator:LoadAnimation(animation)



animationTrack:Play()



fadeOut(animationTrack, 1)
View all inherited from Instance
View all inherited from Object

Events

DidLoop


Code Samples

Play AnimationTrack for a Number of Loops
local function playForNumberLoops(animationTrack, number)

	animationTrack.Looped = true

	animationTrack:Play()

	local numberOfLoops = 0

	local connection = nil

	connection = animationTrack.DidLoop:Connect(function()

		numberOfLoops = numberOfLoops + 1

		print("loop: ", numberOfLoops)

		if numberOfLoops >= number then

			animationTrack:Stop()

			connection:Disconnect() -- it's important to disconnect connections when they are no longer needed

		end

	end)

end



local animation = Instance.new("Animation")

animation.AnimationId = "rbxassetid://507765644"



local humanoid = script.Parent:WaitForChild("Humanoid")

local animator = humanoid:WaitForChild("Animator")

local animationTrack = animator:LoadAnimation(animation)



playForNumberLoops(animationTrack, 5)

Ended


Code Samples

AnimationTrack Ended
local InsertService = game:GetService("InsertService")

local Players = game:GetService("Players")



-- Create an NPC model to animate.

local npcModel = Players:CreateHumanoidModelFromUserId(129687796)

npcModel.Name = "JoeNPC"

npcModel.Parent = workspace

npcModel:MoveTo(Vector3.new(0, 15, 4))

local humanoid = npcModel:WaitForChild("Humanoid")



-- Load an animation.

local animationModel = InsertService:LoadAsset(2510238627)

local animation = animationModel:FindFirstChildWhichIsA("Animation", true)

local animator = humanoid:WaitForChild("Animator")

local animationTrack = animator:LoadAnimation(animation)



-- Connect to Stopped event. This fires when animation stops of

-- it's own accord, or we explicitly call Stop.

animationTrack.Stopped:Connect(function()

	print("Animation stopped")

end)



-- Connect to Ended event. This fires when when animation is completely

-- finished affecting the world. In this case it will fire 3 seconds

-- after we call animationTrack:Stop because we pass in a 3

-- second fadeOut.

animationTrack.Ended:Connect(function()

	print("Animation ended")

	animationTrack:Destroy()

end)



-- Run, give it a bit to play, then stop.

print("Calling Play")

animationTrack:Play()

task.wait(10)

print("Calling Stop")

animationTrack:Stop(3)

KeyframeReached

Parameters

keyframeName: string

Stopped


Code Samples

AnimationTrack Stopped
local function yieldPlayAnimation(animationTrack, fadeTime, weight, speed)

	animationTrack:Play(fadeTime, weight, speed)

	animationTrack.Stopped:Wait()

	print("Animation has stopped")

end



local animation = Instance.new("Animation")

animation.AnimationId = "rbxassetid://507765644"



local humanoid = script.Parent:WaitForChild("Humanoid")

local animator = humanoid:WaitForChild("Animator")

local animationTrack = animator:LoadAnimation(animation)



yieldPlayAnimation(animationTrack, 1, 0.6, 1)
View all inherited from Instance
View all inherited from Object