# Animator

Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448).

- Inherits from, nearest first: [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md)
- Memory category: Instances
- HTML page: https://rapi.sleaze.dev/classes/Animator/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/Animator

Responsible for the playback and replication of `Animations`.

## Properties

### EvaluationThrottled

```luau
Animator.EvaluationThrottled: boolean = false
```

- Tags: Read only, Read capabilities: Animation

Indicates whether animation evaluation was throttled (skipped) this frame for this [`Animator`](https://rapi.sleaze.dev/classes/Animator.md).

### PreferLodEnabled

```luau
Animator.PreferLodEnabled: boolean = true
```

- Tags: Read capabilities: Animation

Controls whether animation LOD throttling is allowed for this [`Animator`](https://rapi.sleaze.dev/classes/Animator.md). When set to `false`, animations always evaluate at full fidelity.

### RootMotion

```luau
Animator.RootMotion: CFrame = CFrame.identity
```

- Tags: Not browsable, Read only, Read capabilities: Animation

### RootMotionWeight

```luau
Animator.RootMotionWeight: number = 0
```

- Tags: Not browsable, Read only, Read capabilities: Animation

### FacsReplicationData

```luau
Animator.FacsReplicationData: FacsReplicationData
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation

### AnimationId0

```luau
Animator.AnimationId0: number = -1
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimationId1

```luau
Animator.AnimationId1: number = -1
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimationId2

```luau
Animator.AnimationId2: number = -1
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimationId3

```luau
Animator.AnimationId3: number = -1
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimationId4

```luau
Animator.AnimationId4: number = -1
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimationId5

```luau
Animator.AnimationId5: number = -1
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimationId6

```luau
Animator.AnimationId6: number = -1
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimationId7

```luau
Animator.AnimationId7: number = -1
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimationId8

```luau
Animator.AnimationId8: number = -1
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimationId9

```luau
Animator.AnimationId9: number = -1
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimationId10

```luau
Animator.AnimationId10: number = -1
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimationId11

```luau
Animator.AnimationId11: number = -1
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimationId12

```luau
Animator.AnimationId12: number = -1
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimationId13

```luau
Animator.AnimationId13: number = -1
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimationId14

```luau
Animator.AnimationId14: number = -1
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimationId15

```luau
Animator.AnimationId15: number = -1
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackMetadata0

```luau
Animator.AnimTrackMetadata0: AnimTrackMetadata
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackMetadata1

```luau
Animator.AnimTrackMetadata1: AnimTrackMetadata
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackMetadata2

```luau
Animator.AnimTrackMetadata2: AnimTrackMetadata
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackMetadata3

```luau
Animator.AnimTrackMetadata3: AnimTrackMetadata
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackMetadata4

```luau
Animator.AnimTrackMetadata4: AnimTrackMetadata
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackMetadata5

```luau
Animator.AnimTrackMetadata5: AnimTrackMetadata
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackMetadata6

```luau
Animator.AnimTrackMetadata6: AnimTrackMetadata
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackMetadata7

```luau
Animator.AnimTrackMetadata7: AnimTrackMetadata
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackMetadata8

```luau
Animator.AnimTrackMetadata8: AnimTrackMetadata
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackMetadata9

```luau
Animator.AnimTrackMetadata9: AnimTrackMetadata
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackMetadata10

```luau
Animator.AnimTrackMetadata10: AnimTrackMetadata
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackMetadata11

```luau
Animator.AnimTrackMetadata11: AnimTrackMetadata
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackMetadata12

```luau
Animator.AnimTrackMetadata12: AnimTrackMetadata
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackMetadata13

```luau
Animator.AnimTrackMetadata13: AnimTrackMetadata
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackMetadata14

```luau
Animator.AnimTrackMetadata14: AnimTrackMetadata
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackMetadata15

```luau
Animator.AnimTrackMetadata15: AnimTrackMetadata
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackPlayState0

```luau
Animator.AnimTrackPlayState0: AnimTrackPlayState
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackPlayState1

```luau
Animator.AnimTrackPlayState1: AnimTrackPlayState
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackPlayState2

```luau
Animator.AnimTrackPlayState2: AnimTrackPlayState
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackPlayState3

```luau
Animator.AnimTrackPlayState3: AnimTrackPlayState
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackPlayState4

```luau
Animator.AnimTrackPlayState4: AnimTrackPlayState
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackPlayState5

```luau
Animator.AnimTrackPlayState5: AnimTrackPlayState
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackPlayState6

```luau
Animator.AnimTrackPlayState6: AnimTrackPlayState
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackPlayState7

```luau
Animator.AnimTrackPlayState7: AnimTrackPlayState
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackPlayState8

```luau
Animator.AnimTrackPlayState8: AnimTrackPlayState
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackPlayState9

```luau
Animator.AnimTrackPlayState9: AnimTrackPlayState
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackPlayState10

```luau
Animator.AnimTrackPlayState10: AnimTrackPlayState
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackPlayState11

```luau
Animator.AnimTrackPlayState11: AnimTrackPlayState
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackPlayState12

```luau
Animator.AnimTrackPlayState12: AnimTrackPlayState
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackPlayState13

```luau
Animator.AnimTrackPlayState13: AnimTrackPlayState
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackPlayState14

```luau
Animator.AnimTrackPlayState14: AnimTrackPlayState
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackPlayState15

```luau
Animator.AnimTrackPlayState15: AnimTrackPlayState
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackWeight0

```luau
Animator.AnimTrackWeight0: AnimTrackWeight
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackWeight1

```luau
Animator.AnimTrackWeight1: AnimTrackWeight
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackWeight2

```luau
Animator.AnimTrackWeight2: AnimTrackWeight
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackWeight3

```luau
Animator.AnimTrackWeight3: AnimTrackWeight
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackWeight4

```luau
Animator.AnimTrackWeight4: AnimTrackWeight
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackWeight5

```luau
Animator.AnimTrackWeight5: AnimTrackWeight
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackWeight6

```luau
Animator.AnimTrackWeight6: AnimTrackWeight
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackWeight7

```luau
Animator.AnimTrackWeight7: AnimTrackWeight
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackWeight8

```luau
Animator.AnimTrackWeight8: AnimTrackWeight
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackWeight9

```luau
Animator.AnimTrackWeight9: AnimTrackWeight
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackWeight10

```luau
Animator.AnimTrackWeight10: AnimTrackWeight
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackWeight11

```luau
Animator.AnimTrackWeight11: AnimTrackWeight
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackWeight12

```luau
Animator.AnimTrackWeight12: AnimTrackWeight
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackWeight13

```luau
Animator.AnimTrackWeight13: AnimTrackWeight
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackWeight14

```luau
Animator.AnimTrackWeight14: AnimTrackWeight
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

### AnimTrackWeight15

```luau
Animator.AnimTrackWeight15: AnimTrackWeight
```

- Tags: Hidden, Not scriptable, Roblox engine security, Read capabilities: Animation, Simulation access

## Methods

### ApplyJointVelocities

```luau
Animator:ApplyJointVelocities(motors: any)
```

- Tags: Capabilities: Animation

Computes relative velocities between parts and applies them to [`Motor6D.Part1`](https://rapi.sleaze.dev/classes/JointInstance.md).

Parameters:

- `motors`: An array of [`Motor6D`](https://rapi.sleaze.dev/classes/Motor6D.md) instances to compute and apply velocities for.

### GetPlayingAnimationTracks

```luau
Animator:GetPlayingAnimationTracks(): { any }
```

- Tags: Capabilities: Animation, Simulation access

Returns the list of currently active `AnimationTracks`.

Returns: An array of currently active `AnimationTracks` on this [`Animator`](https://rapi.sleaze.dev/classes/Animator.md), including tracks that are fading out.

### GetPlayingAnimationTracksCoreScript

```luau
Animator:GetPlayingAnimationTracksCoreScript(): { any }
```

- Tags: Roblox script security, Capabilities: Animation

### GetTrackByAnimationId

```luau
Animator:GetTrackByAnimationId(animationId: string): AnimationTrack
```

- Tags: Capabilities: Animation, Simulation access

Returns an existing [`AnimationTrack`](https://rapi.sleaze.dev/classes/AnimationTrack.md) on this [`Animator`](https://rapi.sleaze.dev/classes/Animator.md) that was loaded from an [`Animation`](https://rapi.sleaze.dev/classes/Animation.md) with the given animation ID. Unlike [`LoadAnimation()`](https://rapi.sleaze.dev/classes/Animator.md), this method does not create a new [`AnimationTrack`](https://rapi.sleaze.dev/classes/AnimationTrack.md) instance.

Parameters:

- `animationId`: The asset ID of the [`Animation`](https://rapi.sleaze.dev/classes/Animation.md) whose loaded track should be retrieved.

Returns: The first [`AnimationTrack`](https://rapi.sleaze.dev/classes/AnimationTrack.md) on this [`Animator`](https://rapi.sleaze.dev/classes/Animator.md) that was loaded from the given animation ID, or `nil` if none has been loaded.

### LoadAnimation

```luau
Animator:LoadAnimation(animation: Animation): AnimationTrack
```

- Tags: Capabilities: Animation, Simulation access

Loads an [`Animation`](https://rapi.sleaze.dev/classes/Animation.md) onto an [`Animator`](https://rapi.sleaze.dev/classes/Animator.md), returning an [`AnimationTrack`](https://rapi.sleaze.dev/classes/AnimationTrack.md).

Parameters:

- `animation`: The [`Animation`](https://rapi.sleaze.dev/classes/Animation.md) to be used.

Returns: A new [`AnimationTrack`](https://rapi.sleaze.dev/classes/AnimationTrack.md) linked to the given [`Animation`](https://rapi.sleaze.dev/classes/Animation.md).

### LoadAnimationCoreScript

```luau
Animator:LoadAnimationCoreScript(animation: Animation): AnimationTrack
```

- Tags: Roblox script security, Capabilities: Animation

### LoadStreamAnimation

```luau
Animator:LoadStreamAnimation(animation: TrackerStreamAnimation): AnimationStreamTrack
```

- Tags: Roblox script security, Capabilities: Animation

### LoadStreamAnimationForSelfieView_deprecated

```luau
Animator:LoadStreamAnimationForSelfieView_deprecated(animation: TrackerStreamAnimation, player: Player): AnimationStreamTrack
```

- Tags: Roblox script security, Capabilities: Animation

### LoadStreamAnimationV2

```luau
Animator:LoadStreamAnimationV2(animation: TrackerStreamAnimation, player: Player? = nil, shouldLookupPlayer: boolean? = true, shouldReplicate: boolean? = true): AnimationStreamTrack
```

- Tags: Roblox script security, Capabilities: Animation

### RegisterEvaluationParallelCallback

```luau
Animator:RegisterEvaluationParallelCallback(callback: (...any) -> ...any)
```

- Tags: Capabilities: Animation

### StepAnimations

```luau
Animator:StepAnimations(deltaTime: number)
```

- Tags: Capabilities: Animation + PluginOrOpenCloud

Increments the [`AnimationTrack.TimePosition`](https://rapi.sleaze.dev/classes/AnimationTrack.md) of all playing `AnimationTracks` that are loaded onto the [`Animator`](https://rapi.sleaze.dev/classes/Animator.md), applying the offsets to the model associated with the [`Animator`](https://rapi.sleaze.dev/classes/Animator.md). For use in the command bar or by plugins only.

Parameters:

- `deltaTime`: The amount of time in seconds animation playback is to be incremented. by.

### StepAnimationsInternal

```luau
Animator:StepAnimationsInternal(deltaTime: number, options: { [string]: any })
```

- Tags: Roblox script security, Capabilities: Animation

### SynchronizeWith

```luau
Animator:SynchronizeWith(otherAnimator: Animator)
```

- Tags: Roblox script security, Capabilities: Animation

## Events

### AnimationPlayed

```luau
Animator.AnimationPlayed: RBXScriptSignal<(animationTrack: AnimationTrack)>
```

- Tags: Capabilities: Animation

Fires when the [`Animator`](https://rapi.sleaze.dev/classes/Animator.md) starts playing an [`AnimationTrack`](https://rapi.sleaze.dev/classes/AnimationTrack.md).

### AnimationPlayedCoreScript

```luau
Animator.AnimationPlayedCoreScript: RBXScriptSignal<(animationTrack: AnimationTrack)>
```

- Tags: Roblox script security, Capabilities: Animation

### AnimationStreamTrackPlayed

```luau
Animator.AnimationStreamTrackPlayed: RBXScriptSignal<(animationTrack: AnimationStreamTrack)>
```

- Tags: Roblox script security, Capabilities: Animation

### OnCombinedUpdate

```luau
Animator.OnCombinedUpdate: RBXScriptSignal<(animation: string, playState: boolean, fadeTime: number, weight: number, speed: number, timePosition: number, priority: Enum.AnimationPriority, looping: boolean, valuesUpdated: number)>
```

- Tags: Hidden, Roblox engine security, Capabilities: Animation

### OnGraphParameterUpdate

```luau
Animator.OnGraphParameterUpdate: RBXScriptSignal<(animation: string, updatedParameters: { [string]: any })>
```

- Tags: Hidden, Roblox engine security, Capabilities: Animation

### OnStreamingUpdated2

```luau
Animator.OnStreamingUpdated2: RBXScriptSignal<(fadeTime: number, weight: number, priority: Enum.AnimationPriority, maskEnabled: boolean, valuesUpdated: number)>
```

- Tags: Hidden, Roblox engine security, Capabilities: Animation

### StreamSyncRequest

```luau
Animator.StreamSyncRequest: RBXScriptSignal<(player: Player)>
```

- Tags: Hidden, Roblox engine security, Capabilities: Animation

## Inherited members

- From [Instance](https://rapi.sleaze.dev/classes/Instance.md): `Archivable`, `archivable`, `Attributes`, `AttributesReplicate`, `AttributesSerialize`, `HistoryId`, `Name`, `Parent`, `PredictionMode`, `PropertyStatusStudio`, `RobloxLocked`, `SerializedOverrides`, `SourceAssetId`, `Tags`, `UniqueId`, `numExpectedDirectChildren`, `DataCost`, `Capabilities`, `DefinesCapabilities`, `IsInSandbox`, `Sandboxed`, `AddTag`, `ClearAllChildren`, `Clone`, `Destroy`, `FindFirstAncestor`, `FindFirstAncestorOfClass`, `FindFirstAncestorWhichIsA`, `FindFirstChild`, `FindFirstChildOfClass`, `FindFirstChildWhichIsA`, `FindFirstDescendant`, `GetActor`, `GetAttribute`, `GetAttributeChangedSignal`, `GetAttributes`, `GetChildren`, `GetDebugId`, `GetDescendants`, `GetFullName`, `GetStyled`, `GetStyledPropertyChangedSignal`, `GetTags`, `HasTag`, `IsAncestorOf`, `IsDescendantOf`, `IsPropertyModified`, `QueryDescendants`, `RemoveTag`, `ResetPropertyToDefault`, `SetAttribute`, `WaitForChild`, `Remove`, `children`, `clone`, `destroy`, `findFirstChild`, `getChildren`, `isDescendantOf`, `remove`, `AncestryChanged`, `AttributeChanged`, `ChildAdded`, `ChildRemoved`, `DescendantAdded`, `DescendantRemoving`, `Destroying`, `StyledPropertiesChanged`, `childAdded`
- From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`