newspaperAbout
infoAbout s&box newspaperLatest News published_with_changesChanges mapRoadmap monitoringMetrics
gamesGames
sports_esportsBrowse Games rocketDiscover Games
business_centerWorkshop
sports_esportsGames landscapeMaps chairModels textureMaterials apparelClothing constructionMore..
forumForum docsDocs
docsDocumentation dashboardApi Reference schoolTutorials
Api
Classes
MovieRecorder
chevron_left Classes
class
MovieRecorder

Constructors

functionsMovieRecorder

Properties

data_objectBinderdata_objectOptionsdata_objectRecordedThisFramedata_objectScenedata_objectTimedata_objectTimeRange

Methods

functionsAdvancefunctionsCapturefunctionsGetTrackRecorderfunctionsStartfunctionsStopfunctionsToClipfunctionsToResource
MovieRecorder
<para> Records properties in a scene to tracks ready for use in a Sandbox.MovieMaker.MoviePlayer. You can use this for in-game demo recording of a whole scene, or only specific properties, configured using Sandbox.MovieMaker.MovieRecorderOptions. </para><para> You can manually call Sandbox.MovieMaker.MovieRecorder.Advance(Sandbox.MovieMaker.MovieTime) to move the recording time along, then Sandbox.MovieMaker.MovieRecorder.Capture to write all recorded properties to tracks. Alternatively, call Sandbox.MovieMaker.MovieRecorder.Start to automatically advance and capture every fixed update, and Sandbox.MovieMaker.MovieRecorder.Stop to finish recording. </para><para> Convert the recording to a Sandbox.MovieMaker.Compiled.MovieClip by calling Sandbox.MovieMaker.MovieRecorder.ToClip. This clip can then be played back immediately, or serialized to later use. </para>
class Sandbox.MovieMaker .
sealedSandbox.Engine

build Constructors 1

MovieRecorder (scene, options)
Create a new Sandbox.MovieMaker.MovieRecorder, recording the given with the given .

data_object Properties 6

Binder
TrackBinder
Maps tracks to objects and properties in the scene.
Options
MovieRecorderOptions
Configuration deciding which properties are captured, and at what sample rate.
RecordedThisFrame
IEnumerable`1
Which Sandbox.MovieMaker.IMovieTrackRecorders recorded anything during the last call to Sandbox.MovieMaker.MovieRecorder.Capture.
Scene
Scene
Scene we're recording. Will match Sandbox.MovieMaker.TrackBinder.Scene.
Time
MovieTime
Current recording time, increased by calling Sandbox.MovieMaker.MovieRecorder.Advance(Sandbox.MovieMaker.MovieTime).
TimeRange
MovieTimeRange
Recorded time range, spanning from the first capture to the current value of Sandbox.MovieMaker.MovieRecorder.Time.

functions Methods 7

Advance (deltaTime)
Moves recording ahead by the given . 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 (gameObject)
IMovieTrackRecorder
Gets a Sandbox.MovieMaker.IMovieTrackRecorder for the given , creating one if it doesn't exist. If Sandbox.MovieMaker.MovieRecorderOptions.Filters reject this game object, returns null instead.
Start ()
IDisposable
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 ()
MovieClip
Convert the current recording to a Sandbox.MovieMaker.Compiled.MovieClip that can be serialized or played back.
ToResource ()
IMovieResource
Convert the current recording to a Sandbox.MovieMaker.IMovieResource that can be saved as a .movie asset.
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.