class in UnityEngine
/
Inherits from:ScriptableObject
/
Implemented in:UnityEngine.AnimationModule
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 failedFor 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 Your name Your email Suggestion* DescriptionStateMachineBehaviour is a component that can be added to a state machine state. It's the base class any script on a state must derive from.
State machines can have up to three different active states at the same time: the current state, the next state and the interrupted state.
The state machine always has a current state. When the state machine transitions to a new state, a "next state" is added. Once the transition is complete, the current state is terminated and the next state becomes the new current state.
If an ongoing transition is interrupted by a transition to a new state, then the next state becomes the interrupted state and the state targeted by the new transition is now the next state. The current state will remain the same until all interrupted transitions have completed. Once the last transition is complete and there are no more interruptions, the current and interrupted states are terminated, and the next state becomes the new current state.
StateMachineBehaviour has some predefined state-related messages that you can implement:OnStateEnter, OnStateExit, OnStateIK, OnStateMove, OnStateUpdate.
StateMachineBehaviour also has some predefined messages related to transitions in and out of state machines:
Layer considerations:
Additional considerations:
using UnityEngine;Public Methods Method Description 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. OnStateMachineExit Invoked on the last update frame when taking a transition out of a StateMachine. Implement this message to influence the exit transition out of the sub-state machine Messages Message Description OnStateEnter Invoked on the first update frame when a state machine evaluates this state. Implement this message to react to a new state starting. OnStateExit Invoked on the last update frame when a state machine evaluates this state. Implement this message to react to a state ending. OnStateIK Invoked during the Animator IK pass. Implement this message to modify the result of the animation after the evaluation of the state machine on a state by state basis. OnStateMove Invoked during the Animator Root Motion pass. Implement this message to modify the result of the animation root motion on a state by state basis. OnStateUpdate Invoked on each update frame except for the first and last frame. Implement this message to execute custom logic on a state by state basis. Inherited Members Properties Property Description hideFlags Should the object be hidden, saved with the Scene or modifiable by the user? name The name of the object. Public Methods Method Description GetInstanceID Gets the instance ID of the object. ToString Returns the name of the object. Static Methods Method Description Destroy Removes a GameObject, component or asset. DestroyImmediate Destroys the object obj immediately. You are strongly recommended to use Destroy instead. DontDestroyOnLoad Do not destroy the target Object when loading a new Scene. FindAnyObjectByType Retrieves any active loaded object of Type type. FindFirstObjectByType Retrieves the first active loaded object of Type type. FindObjectsByType Retrieves a list of all loaded objects of Type type. Instantiate Clones the object original and returns the clone. InstantiateAsync Captures a snapshot of the original object (that must be related to some GameObject) and returns the AsyncInstantiateOperation. CreateInstance Creates an instance of a scriptable object. Operators Operator Description bool Does the object exist? operator != Compares if two objects refer to a different object. operator == Compares two object references to see if they refer to the same object. Messages Message Description Awake Called when an instance of ScriptableObject is created. OnDestroy This function is called when the scriptable object will be destroyed. OnDisable This function is called when the scriptable object goes out of scope. OnEnable This function is called when the object is loaded. OnValidate Editor-only function that Unity calls when the script is loaded or a value changes in the Inspector. Reset Reset to default values.public class AttackBehaviour : StateMachineBehaviour { public GameObject particle; public float radius; public float power;
protected GameObject clone;
override public void OnStateEnter(Animator animator, AnimatorStateInfo stateInfo, int layerIndex) { clone = Instantiate(particle, animator.rootPosition, Quaternion.identity) as GameObject; Rigidbody rb = clone.GetComponent<Rigidbody>(); rb.AddExplosionForce(power, animator.rootPosition, radius, 3.0f); }
override public void OnStateExit(Animator animator, AnimatorStateInfo stateInfo, int layerIndex) { Destroy(clone); }
override public void OnStateUpdate(Animator animator, AnimatorStateInfo stateInfo, int layerIndex) { Debug.Log("On Attack Update "); }
override public void OnStateMove(Animator animator, AnimatorStateInfo stateInfo, int layerIndex) { Debug.Log("On Attack Move "); }
override public void OnStateIK(Animator animator, AnimatorStateInfo stateInfo, int layerIndex) { Debug.Log("On Attack IK "); } }
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4