Legacy Documentation: Version 5.6 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

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

public function OnStateMachineEnter(animator: Animator, stateMachinePathHash: int): void;
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 StateMachine. This is not called when making a transition into a StateMachine sub-state.

The evaluation flow must pass by an Entry node to actually get this callback.