Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


OnStateMachineEnter

Invoked on the first update frame when taking a transition into a state machine. Implement this message to influence the entry transition into the sub-state machine.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.AnimationModule

OnStateMachineEnter(Animator, int)

Invoked on the first update frame when taking a transition into a state machine. Implement this message to influence the entry transition into the sub-state machine.
public virtual void OnStateMachineEnter(Animator animator, int stateMachinePathHash)

Parameters

animator

The Animator evaluating the state machine.

stateMachinePathHash

The hash of the full path to the state machine.

Remarks

Notes:
  • This message will only be invoked when a State Machine entry transition is taken. It will not be invoked if a direct transition to a state machine sub-state is taken.
  • Since this message is invoked during the evaluation of the state machine and can influence the transitions taken, implementing this message in your state machine prevents multithreaded state machine evaluation and may be a performance concern.

OnStateMachineEnter(Animator, int, AnimatorControllerPlayable)

Invoked on the first update frame when taking a transition into a state machine. Implement this message to influence the entry transition into the sub-state machine.
public virtual void OnStateMachineEnter(Animator animator, int stateMachinePathHash, AnimatorControllerPlayable controller)

Parameters

animator

The Animator evaluating the state machine.

stateMachinePathHash

The hash of the full path to the state machine.

Remarks

Notes:
  • This message will only be invoked when a State Machine entry transition is taken. It will not be invoked if a direct transition to a state machine sub-state is taken.
  • Since this message is invoked during the evaluation of the state machine and can influence the transitions taken, implementing this message in your state machine prevents multithreaded state machine evaluation and may be a performance concern.