Version: 2021.2
LanguageEnglish
  • C#

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

Declaration

public static bool InAnimationMode();

Declaration

public static bool InAnimationMode(AnimationModeDriver driver);

Parameters

driver An AnimationModeDriver object that tests if AnimationMode has been locked specifically for this driver.

Description

Checks whether the Editor is in Animation mode.

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 animate the attached object.

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