Skip to Content
Kinemium

Animator

Own and blend animation tracks for a rigged MeshPart.

Animator is the object that actually loads and blends animation tracks. Humanoid and AnimationController create one and delegate to it.

Getting started

local animator = Instance.new("Animator")
animator.MeshPart = rig
animator.Parent = rig

local track = animator:LoadAnimation(animation)
track:Play(0.2, 1, 1)

Properties

PropertyTypeAccessDefaultDescription
MeshPartMeshPart?Read/writeDiscovered from ancestryRig that receives the animations.
PreferLodEnabledbooleanRead/writetruePrefer lower-detail animation evaluation when available.
EvaluationThrottledbooleanRead-onlyfalseAlways reports false.
AnimationPlayedsignalRead-onlyFires with each track when playback starts.

MeshPart accepts a MeshPart or nil. When it's nil, the animator looks for a rigged mesh in its ancestors. Assigning another instance type is ignored, and changing the mesh releases existing native tracks.

Methods

SignatureDescription
LoadAnimation(animation: Animation): AnimationTrackCreates a track on the rig.

LoadAnimation() raises an error when there's no ready rigged mesh, the mesh is already controlled by another animator, the clip can't be found, or the source keyframe sequence is empty.

Notes

  • A rig can have only one animator controlling its mesh.
  • EvaluationThrottled is a compatibility property and doesn't reflect real state.
  • PreferLodEnabled is a hint, not a guarantee.
  • Destroying the animator destroys its tracks.
  • Cloning copies PreferLodEnabled and the mesh reference, not the tracks.

See also

  • AnimationController and Humanoid for the hosts that create animators.
  • AnimationTrack for playback control.
  • Animation for clip definitions.

On this page