Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

AnimationMode.SampleAnimationClip

Other Versions
Leave feedback
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 method SampleAnimationClip(gameObject: GameObject, clip: AnimationClip, time: float): void;
public static void SampleAnimationClip(GameObject gameObject, AnimationClip clip, float time);

Description

Samples an AnimationClip on the object and also records any modified properties in AnimationMode.

This function must always be surrounded by BeginSampling and EndSampling. When a property is no longer sampled (through SampleAnimationClip or AddPropertyModification) between BeginSampling and EndSampling it will automatically revert to the original value when EndSampling is called.

AnimationMode.BeginSample();
AnimationMode.SampleAnimationClip(gameObject, clip, 0.3F);
AnimationMode.EndSample();

Did you find this page useful? Please give it a rating:

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2018 Unity Technologies. Publication: 2018.1-002N. Built: 2018-12-04.
TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information