Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Play

Plays a state.
Read time 5 minutesLast updated 6 days ago

Definition

Play(string)

Plays a state.
public void Play(string stateName)

Parameters

stateName

The state name.

Remarks

When you specify a state name, or the string used to generate a hash, it should include the name of the parent layer. For example, if you have a
Run
state in the
Base Layer
, the name is
Base Layer.Run
. The
normalizedTime
parameter varies between 0 and 1. If this parameter is left at zero then AnimatorControllerPlayable.Play will operate as expected. A different starting point can be given. An example could be
normalizedTime
set to 0.5, which means the animation starts half way through. If the transition from one state switches to another it may or may not be blended. If the transition starts at 0.75 it will be blended with the other state. If no transition is set up then AnimatorControllerPlayable.Play will continue to 1.0 with no changes.

Play(string, int)

Plays a state.
public void Play(string stateName, int layer)

Parameters

stateName

The state name.

layer

The layer index. If layer is -1, it plays the first state with the given state name or hash.

Remarks

When you specify a state name, or the string used to generate a hash, it should include the name of the parent layer. For example, if you have a
Run
state in the
Base Layer
, the name is
Base Layer.Run
. The
normalizedTime
parameter varies between 0 and 1. If this parameter is left at zero then AnimatorControllerPlayable.Play will operate as expected. A different starting point can be given. An example could be
normalizedTime
set to 0.5, which means the animation starts half way through. If the transition from one state switches to another it may or may not be blended. If the transition starts at 0.75 it will be blended with the other state. If no transition is set up then AnimatorControllerPlayable.Play will continue to 1.0 with no changes.

Play(string, int, float)

Plays a state.
public void Play(string stateName, int layer, float normalizedTime)

Parameters

stateName

The state name.

layer

The layer index. If layer is -1, it plays the first state with the given state name or hash.

normalizedTime

The time offset between zero and one.

Remarks

When you specify a state name, or the string used to generate a hash, it should include the name of the parent layer. For example, if you have a
Run
state in the
Base Layer
, the name is
Base Layer.Run
. The
normalizedTime
parameter varies between 0 and 1. If this parameter is left at zero then AnimatorControllerPlayable.Play will operate as expected. A different starting point can be given. An example could be
normalizedTime
set to 0.5, which means the animation starts half way through. If the transition from one state switches to another it may or may not be blended. If the transition starts at 0.75 it will be blended with the other state. If no transition is set up then AnimatorControllerPlayable.Play will continue to 1.0 with no changes.

Play(int)

Plays a state.
public void Play(int stateNameHash)

Parameters

stateNameHash

The state hash name. If stateNameHash is 0, it changes the current state time.

Remarks

When you specify a state name, or the string used to generate a hash, it should include the name of the parent layer. For example, if you have a
Run
state in the
Base Layer
, the name is
Base Layer.Run
. The
normalizedTime
parameter varies between 0 and 1. If this parameter is left at zero then AnimatorControllerPlayable.Play will operate as expected. A different starting point can be given. An example could be
normalizedTime
set to 0.5, which means the animation starts half way through. If the transition from one state switches to another it may or may not be blended. If the transition starts at 0.75 it will be blended with the other state. If no transition is set up then AnimatorControllerPlayable.Play will continue to 1.0 with no changes.

Play(int, int)

Plays a state.
public void Play(int stateNameHash, int layer)

Parameters

stateNameHash

The state hash name. If stateNameHash is 0, it changes the current state time.

layer

The layer index. If layer is -1, it plays the first state with the given state name or hash.

Remarks

When you specify a state name, or the string used to generate a hash, it should include the name of the parent layer. For example, if you have a
Run
state in the
Base Layer
, the name is
Base Layer.Run
. The
normalizedTime
parameter varies between 0 and 1. If this parameter is left at zero then AnimatorControllerPlayable.Play will operate as expected. A different starting point can be given. An example could be
normalizedTime
set to 0.5, which means the animation starts half way through. If the transition from one state switches to another it may or may not be blended. If the transition starts at 0.75 it will be blended with the other state. If no transition is set up then AnimatorControllerPlayable.Play will continue to 1.0 with no changes.

Play(int, int, float)

Plays a state.
public void Play(int stateNameHash, int layer, float normalizedTime)

Parameters

stateNameHash

The state hash name. If stateNameHash is 0, it changes the current state time.

layer

The layer index. If layer is -1, it plays the first state with the given state name or hash.

normalizedTime

The time offset between zero and one.

Remarks

When you specify a state name, or the string used to generate a hash, it should include the name of the parent layer. For example, if you have a
Run
state in the
Base Layer
, the name is
Base Layer.Run
. The
normalizedTime
parameter varies between 0 and 1. If this parameter is left at zero then AnimatorControllerPlayable.Play will operate as expected. A different starting point can be given. An example could be
normalizedTime
set to 0.5, which means the animation starts half way through. If the transition from one state switches to another it may or may not be blended. If the transition starts at 0.75 it will be blended with the other state. If no transition is set up then AnimatorControllerPlayable.Play will continue to 1.0 with no changes.