Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AnimationController

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

Memory categoryAnimation

Member index 3

HistoryMember
553GetPlayingAnimationTracks(): Array
553LoadAnimation(animation: Animation): AnimationTrack
553AnimationPlayed(animationTrack: AnimationTrack)
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

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.

History 22

Members 3

AnimationPlayed

Parameters (1)
animationTrackAnimationTrack

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.

This event is deprecated. It exists only for backward compatibility, and should not be used for new work.
Thread safetyUnsafe

History 7

Tags: [Deprecated]

GetPlayingAnimationTracks

Parameters (0)
No parameters.
Returns (1)
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:

local animationTracks = {}
local track = animationController:LoadTrack(animation)
table.insert(animationTracks, track)
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
Thread safetyUnsafe

History 6

Tags: [Deprecated]

LoadAnimation

Parameters (1)
animationAnimation
Returns (1)
AnimationTrack

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

This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
Thread safetyUnsafe

History 8

Tags: [Deprecated]

Settings