Records properties in a scene to tracks ready for use in a MovieMaker.MoviePlayer. You can use this for in-game demo recording of a whole scene, or only specific properties, configured using MovieMaker.MovieRecorderOptions.
You can manually call MovieMaker.MovieRecorder.Advance to move the recording time along, then MovieMaker.MovieRecorder.Capture to write all recorded properties to tracks. Alternatively, call MovieMaker.MovieRecorder.Start to automatically advance and capture every fixed update, and MovieMaker.MovieRecorder.Stop to finish recording.
Convert the recording to a MovieMaker.Compiled.MovieClip by calling MovieMaker.MovieRecorder.ToClip. This clip can then be played back immediately, or serialized to later use.
| MovieRecorder | Create a new Sandbox.MovieMaker.MovieRecorder, recording the given <paramref name="scene" /> with the given <paramref name="options" />. |
| Binder | Maps tracks to objects and properties in the scene. |
| Options | Configuration deciding which properties are captured, and at what sample rate. |
| RecordedThisFrame | Which Sandbox.MovieMaker.IMovieTrackRecorders recorded anything during the last call to Sandbox.MovieMaker.MovieRecorder.Capture. |
| Scene | Scene we're recording. Will match Sandbox.MovieMaker.TrackBinder.Scene. |
| Time | Current recording time, increased by calling Sandbox.MovieMaker.MovieRecorder.Advance(Sandbox.MovieMaker.MovieTime). |
| TimeRange | Recorded time range, spanning from the first capture to the current value of Sandbox.MovieMaker.MovieRecorder.Time. |
| Advance | Moves recording ahead by the given <paramref name="deltaTime" />. This will happen automatically if you've called Sandbox.MovieMaker.MovieRecorder.Start. |
| Capture | Runs all actions in Sandbox.MovieMaker.MovieRecorderOptions.CaptureActions. This will happen automatically if you've called Sandbox.MovieMaker.MovieRecorder.Start. |
| GetTrackRecorder | Gets a Sandbox.MovieMaker.IMovieTrackRecorder for the given <paramref name="gameObject" />, creating one if it doesn't exist. If Sandbox.MovieMaker.MovieRecorderOptions.Filters reject this game object, returns null instead. |
| Start | Starts recording the scene. Stop recording by calling Sandbox.MovieMaker.MovieRecorder.Stop, or disposing the returned object. Recording will automatically stop when the recorded scene is being destroyed. |
| Stop | Stop recording the scene. Does nothing if you haven't called Sandbox.MovieMaker.MovieRecorder.Start. |
| ToClip | Convert the current recording to a Sandbox.MovieMaker.Compiled.MovieClip that can be serialized or played back. |
| ToResource | Convert the current recording to a Sandbox.MovieMaker.IMovieResource that can be saved as a .movie asset. |