GetPlayingAnimationTracks

Deprecated

This item is deprecated. Do not use it for new work.

Unsafe

For thread safety, this property is not safe to read in an unsynchronized thread.

Function of:

AnimationController

Description:

Returns an array of all AnimationTrack|AnimationTracks that are currently being played by the AnimationController.

A typical use for this function is stopping currently playing tracks using AnimationTrack/Stop.

Note this function will not return AnimationTrack|AnimationTracks that have loaded but are not playing. If the developer wishes to track these they will need to index them manually. See below for one example of how this could be achieved:

local animationTracks = {}
local track = animationController:LoadTrack(animation)
table.insert(animationTracks, track)

Returns

Return Type	Summary
Return Type Array	Summary An array of playing `AnimationTrack`s.

Code Samples

Stop All Tracks

This sample contains a quick function to stop all playing AnimationTracks on an AnimationController or Humanoid.

			
				Stop All Tracks

				Expected Output
			
				Expand
				
			local function stopAllTracks(animationController)
	for _, track in pairs(animationController:GetPlayingAnimationTracks()) do
		track:Stop()
	end
end
		
				Copy Code
			
				Light Theme

GetPlayingAnimationTracks

Returns

Array

Code Samples

Stop All Tracks