Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

StateMachineBehaviour.OnStateMachineEnter

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public 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.

Description

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.

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.