Version: 5.5 (switch to 5.6b)
LanguageEnglish
  • C#
  • JS

Script language

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

AnimationMode.InAnimationMode

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 static function InAnimationMode(): bool;
public static bool InAnimationMode();

Description

Are we currently in AnimationMode?

InAnimationMode returns a value of true or false, indicating whether the animation is being controlled by AnimationMode. If InAnimationMode returns true then SampleAnimationClip can be used to animated the attached object.

Note: The script example at AnimationMode shows how InAnimationMode can be used.