Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

Sample(): void;
void Sample();
def Sample() as void

Description

Samples animations at the current state.

This is useful when you explicitly want to set up some animation state, and sample it once.

	// Set up some state;
	animation["MyClip"].time = 2.0;
	animation["MyClip"].enabled = true;
	// Sample animations now.
	animation.Sample();

animation["MyClip"].enabled = false;

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    void Example() {
        animation["MyClip"].time = 2.0F;
        animation["MyClip"].enabled = true;
        animation.Sample();
        animation["MyClip"].enabled = false;
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def Example() as void:
		animation['MyClip'].time = 2.0F
		animation['MyClip'].enabled = true
		animation.Sample()
		animation['MyClip'].enabled = false