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.

AnimationMode.SampleAnimationClip

static function SampleAnimationClip(gameObject: GameObject, clip: AnimationClip, time: float): void;
static void SampleAnimationClip(GameObject gameObject, AnimationClip clip, float time);
static def SampleAnimationClip(gameObject as GameObject, clip as AnimationClip, time as float) as void

Description

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

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

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