Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

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

AnimationClip.SampleAnimation

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

Switch to Manual
public method SampleAnimation(go: GameObject, time: float): void;
public void SampleAnimation(GameObject go, float time);

Parameters

goThe animated game object.
timeThe time to sample an animation.

Description

Samples an animation at a given time for any animated properties.

It is recommended to use the Animation interface instead for performance reasons. This will sample animation at the given time. Any component properties that are animated in the clip will be replaced with the sampled value. Most of the time you want to use Animation.Play instead. SampleAnimation is useful when you need to jump between frames in an unordered way or based on some special input.

See Also: Animation.

// Plays an animation clip backwards by sampling it every frame.
 var clip : AnimationClip;
 function Update() {
     clip.SampleAnimation(gameObject, clip.length - Time.time);
}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { public AnimationClip clip; void Update() { clip.SampleAnimation(gameObject, clip.length - Time.time); } }