Legacy Documentation: Version 5.0
Language: English
  • C#
  • JS

Script language

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

AnimatorController.GetStateEffectiveMotion

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual
public function GetStateEffectiveMotion(state: Animations.AnimatorState): Motion;
public Motion GetStateEffectiveMotion(Animations.AnimatorState state);
public function GetStateEffectiveMotion(state: Animations.AnimatorState, layerIndex: int): Motion;
public Motion GetStateEffectiveMotion(Animations.AnimatorState state, int layerIndex);

Parameters

stateThe AnimatorState which we want the Motion.
layerIndexThe layer that is queried.

Description

Gets the effective Motion for the AnimatorState. The Motion is either stored in the AnimatorStateMachine or in the AnimatorLayer's ovverrides. Use this function to get the Motion that is effectively used.