Version: 2021.1
LanguageEnglish
  • C#

AnimationMode.SampleAnimationClip

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 void SampleAnimationClip(GameObject gameObject, AnimationClip clip, float time);

Parameters

gameObject The root GameObject for the animation.
clip The AnimationClip to sample.
time The time at which to sample.

Returns

void Returns true when the Editor is in Animation mode. Returns false otherwise.

Description

Samples the AnimationClip for the GameObject and also records modified properties when in Animation mode.

If this method returns true, you can use SampleAnimationClip to animate the attached object.

Note: The script example for AnimationMode demonstrates how to use InAnimationMode.