Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


AnimatorState

States are the basic building blocks of a state machine. Each state contains a Motion ( AnimationClip or BlendTree) which will play while the character is in that state. When an event in the game triggers a state transition, the character will be left in a new state whose animation sequence will then take over.
Read time 5 minutesLast updated 2 days ago

Definition

[HelpURL("class-State")]public sealed class AnimatorState : Object

Properties

Property

Description

behavioursThe Behaviour list assigned to this state.
cycleOffsetOffset at which the animation loop starts. Useful for synchronizing looped animations. Units is normalized time.
cycleOffsetParameterThe animator controller parameter that drives the cycle offset value.
cycleOffsetParameterActiveDefine if the /cycle offset/ value is driven by an Animator controller parameter or by the value set in the editor.
iKOnFeetShould Foot IK be respected for this state.
mirrorWhether the animation state is mirrored.
mirrorParameterThe animator controller parameter that drives the mirror value.
mirrorParameterActiveDefine if the mirror value is driven by an Animator controller parameter or by the value set in the editor.
motionThe motion assigned to this state.
nameHashThe hashed name of the state.
speedThe default speed of the motion.
speedParameterThe animator controller parameter that drives the speed value.
speedParameterActiveDefine if the speed value is driven by an Animator controller parameter or by the value set in the editor.
tagA tag can be used to identify a state.
timeParameterIf timeParameterActive is true, the value of this Parameter will be used instead of normalized time.
timeParameterActiveIf true, use value of given Parameter as normalized time.
transitionsThe transitions that are going out of the state.
writeDefaultValuesWhether or not the AnimatorStates writes back the default values for properties that are not animated by its Motion.

Methods

Method

Description

AddExitTransitionUtility function to add an outgoing transition to the exit of the state's parent state machine.
AddStateMachineBehaviourNon-generic version of this method.
AddTransitionUtility function to add an outgoing transition to the destination state.
RemoveTransitionUtility function to remove a transition from the state.

Inheritance

Inherited Members

Operators

Operator

Description

operator ==Compares two object references to see if they refer to the same object.
boolDetermines whether the object exists.
operator !=Compares if two objects refer to a different object.