Class AnimatorController

constructor

• new AnimatorController(model): AnimatorController

• Parameters

  • model: AnimatorControllerModel

  Returns AnimatorController

Optional animator

model

normalizedStartOffset

activeState

• get activeState(): State

• Get the currently active state playing

  Returns State

  the currently active state or undefined if no state is active

context

• get context(): Context

• Get the context of the animator

  Returns Context

currentAction

• get currentAction(): AnimationAction

• Get the current action (shorthand for activeState.motion.action)

  Returns AnimationAction

  the current action that is playing. This is the action that is currently transitioning to or playing. If no action is playing null is returned.

mixer

• get mixer(): AnimationMixer

• Get the animation mixer that is used to play the animations

  Returns AnimationMixer

bind

• bind(animator): void

• Bind the animator to the controller. Only one animator can be bound to a controller at a time.

  Parameters

  • animator: Animator

  Returns void

clone

• clone(): AnimatorController

• Create a clone of the controller. This will clone the model but not the runtime state.

  Returns AnimatorController

dispose

• dispose(): void

• Clears the animation mixer and unregisters it from the context.

  Returns void

enumerateActions

• enumerateActions(): Generator<AnimationAction, void, unknown>

• Returns Generator<AnimationAction, void, unknown>

findState

• findState(name): State

• Parameters

  • name: string | number

  Returns State

getBool

• getBool(name): boolean

• Parameters

  • name: string | number

  Returns boolean

getCurrentStateInfo

• getCurrentStateInfo(): AnimatorStateInfo

• Get the current state info

  Returns AnimatorStateInfo

  the current state info or null if no state is active

getFloat

• getFloat(name): number

• Parameters

  • name: string | number

  Returns number

getInteger

• getInteger(name): number

• Parameters

  • name: string | number

  Returns number

getTrigger

• getTrigger(name): boolean

• Parameters

  • name: string | number

  Returns boolean

isInTransition

• isInTransition(): boolean

• Returns boolean

play

• play(name, layerIndex?, normalizedTime?, durationInSec?): void

• Parameters

  • name: string | number
  • layerIndex: number = -1
  • normalizedTime: number = Number.NEGATIVE_INFINITY
  • durationInSec: number = 0

  Returns void

reset

• reset(): void

• Returns void

resetTrigger

• resetTrigger(name): void

• Parameters

  • name: string | number

  Returns void

setBool

• setBool(name, value): void

• Parameters

  • name: string | number
  • value: boolean

  Returns void

setFloat

• setFloat(name, val): boolean

• Parameters

  • name: string | number
  • val: number

  Returns boolean

setInteger

• setInteger(name, val): void

• Parameters

  • name: string | number
  • val: number

  Returns void

setSpeed

• setSpeed(speed): void

• Set the speed of the animator controller. Larger values will make the animation play faster.

  Parameters

  • speed: number

  Returns void

setTrigger

• setTrigger(name): void

• Parameters

  • name: string | number

  Returns void

update

• update(weight): void

• Called by the animator. This will update the active states and transitions as well as the animation mixer.

  Parameters

  • weight: number

  Returns void

Static createFromClips

• createFromClips(clips, options?): AnimatorController

• Create an animatorcontroller. States are created from the clips array.

  Parameters

  • clips: AnimationClip[]

    the clips to assign to the controller
  • options: CreateAnimatorControllerOptions = ...

    options to control the creation of the controller.

  Returns AnimatorController

  the created animator controller