Version: 5.5 (switch to 5.6b)
LanguageEnglish
  • C#
  • JS

Script language

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

AnimationMode.BeginSampling

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 function BeginSampling(): void;
public static void BeginSampling();

Description

Initialise the start of the animation clip sampling.

BeginSampling arranges for the ::SampleAnimationClip to operate correctly. Not calling BeginSampling prevents the animation data to be sampled. This function must be called immediately before the SampleAnimationClip is called. See the script example on the AnimationMode page to see this behaviour.