Skip to content

AnimationController

Supported Class Animation & Avatar

Allows animations to be loaded and applied to a character or model in place of a Humanoid.

Description

An object which allows animations to be loaded and applied to a character or model in place of a Humanoid. Creates an Animator and loads animations to update Motor6Ds of said character to react in the way that is described within the animation asset referenced by an Animation object.

Note that the LoadAnimation() method of this class has been deprecated. Instead, you should call Animator.LoadAnimation() directly from an Animator which can be created manually in Studio and directly referenced in scripts. When the deprecated method is called from an AnimationController, the controller itself does nothing regarding the animation intended to be loaded, except to automatically generate an Animator, onto which the loading call and animation ID are transferred. In this way, the AnimationController can be thought of as nothing more than an empty shell for a child Animator object which handles any actual functionality regarding animations.

Inheritance

Object → Instance → AnimationController

Nova inheritance: Instance → AnimationController

Methods

GetPlayingAnimationTracks Supported Function Deprecated Returns an array of all AnimationTracks that are currently being played by the AnimationController.
AnimationController:GetPlayingAnimationTracks(): Array

Returns an array of all 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 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:

Roblox documentation

LoadAnimation Supported Function Deprecated Loads an Animation onto an AnimationController, returning an AnimationTrack that can be used for playback.
AnimationController:LoadAnimation(Instance animation): Instance

This function loads an Animation onto an AnimationController, returning an AnimationTrack that can be used for playback.

Roblox reference signature
AnimationController:LoadAnimation(animation: Animation): AnimationTrack

Roblox documentation

Events

AnimationPlayed Supported Event Deprecated Fires whenever the AnimationController begins playing an animation. It returns the AnimationTrack playing.
AnimationPlayed(Instance animationTrack)

This event fires whenever the AnimationController begins playing an animation. It returns the AnimationTrack playing.

The AnimationTrack can be used to access the animation's playback functions and events. It will only fire for animations playing on the specific AnimationController.

See Humanoid.AnimationPlayed for the Humanoid variant of this function.

Roblox reference signature
AnimationPlayed(animationTrack: AnimationTrack)

Roblox documentation

Inherited members

Inherited from Instance: 8 properties, 36 methods, 7 events. They are documented on the base class page.

Roblox reference: AnimationController

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.