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.

Animator.StartRecording

Switch to Manual
StartRecording(frameCount: int): void;
void StartRecording(int frameCount);
def StartRecording(frameCount as int) as void

Parameters

frameCountThe number of frames (updates) that will be recorded. If frameCount is 0, the recording will continue until the user calls StopRecording. The maximum value for frameCount is 10000.

Description

Sets the animator in recording mode, and allocates a circular buffer of size frameCount.

After this call, the recorder starts collecting up to frameCount frames in the buffer. Note it is not possible to start playback until a call to StopRecording is made. See Also: StopRecording, recorderStartTime, recorderStopTime, StartPlayback, StopPlayback, playbackTime.