Version: 2020.3
LanguageEnglish
  • C#

How do you use documentation throughout your workflow? Share your experience with us by taking this survey.

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 playing this state machine.
stateMachinePathHash The full path hash for this state machine.

Description

Called on the first Update frame when making a transition to a state machine. This is not called when making a transition into a state machine sub-state.

The evaluation flow must pass through an Entry node to call this method. Adding this callback prevents the multithreaded state machine evaluation because a script method needs to be called during the state machine evaluation. This method is called while the state machine is being evaluated which is a different execution order compared to most StateMachineBehaviour methods.