s&box docs
API ReferenceSandbox.MovieMaker

MoviePlayerclass

Plays a `Sandbox.MovieMaker.IMovieClip` in a `Sandbox.Scene` to animate properties over time.

object→Component→MoviePlayer
Namespace
Sandbox.MovieMaker
Assembly
Sandbox.Engine
Declaration
public sealed class Sandbox.MovieMaker.MoviePlayer : Sandbox.Component

Constructors1

Showing 1 constructors

Methods5

Showing 5 methods

public bool IsCreatedTarget(Sandbox.IValid obj)PUBLIC

ParameterTypeDescription
objIValid—
Returns:bool—

public void UpdateTargets()PUBLICPER-FRAME

Forces the creation of any missing `Sandbox.GameObject`s or `Sandbox.Component`s for the current `Sandbox.MovieMaker.MoviePlayer.Clip` to target.

Returns:void—

Properties9

Showing 9 properties

public Sandbox.MovieMaker.TrackBinder Sandbox.MovieMaker.MoviePlayer.Binder { get; set; }PUBLICGETSET

Maps `Sandbox.MovieMaker.ITrack`s to game objects, components, and property `Sandbox.MovieMaker.ITrackTarget`s in the scene.

Returns:TrackBinder—

public bool Sandbox.MovieMaker.MoviePlayer.CreateTargets { get; set; }PUBLICGETSET

If true, creates any missing `Sandbox.GameObject`s and `Sandbox.Component`s for the current movie to target.

Returns:bool—

public bool Sandbox.MovieMaker.MoviePlayer.IsLooping { get; set; }PUBLICGETSET

Returns:bool—

public bool Sandbox.MovieMaker.MoviePlayer.IsPlaying { get; set; }PUBLICGETSET

Returns:bool—

public float Sandbox.MovieMaker.MoviePlayer.PositionSeconds { get; set; }PUBLICGETSET

Returns:float—

public Sandbox.MovieMaker.IMovieResource Sandbox.MovieMaker.MoviePlayer.Resource { get; set; }PUBLICGETSET

Contains a `Sandbox.MovieMaker.IMovieClip` to play. Can be a `Sandbox.MovieMaker.MovieResource` or `Sandbox.MovieMaker.EmbeddedMovieResource`.

Returns:IMovieResource—

public float Sandbox.MovieMaker.MoviePlayer.TimeScale { get; set; }PUBLICGETSET

Returns:float—

Related Guides

→Playback API→Recording API

Value

Previous Page

Binder

Next Page

On this page

Constructorspublic MoviePlayer()Methodspublic System.Boolean IsCreatedTarget(Sandbox.IValid obj)public System.Void Play()public System.Void Play(Sandbox.MovieMaker.IMovieClip clip)public System.Void Play(Sandbox.MovieMaker.MovieResource movie)public System.Void UpdateTargets()Propertiespublic Sandbox.MovieMaker.TrackBinder Sandbox.MovieMaker.MoviePlayer.Binder { get; set; }public Sandbox.MovieMaker.IMovieClip Sandbox.MovieMaker.MoviePlayer.Clip { get; set; }public System.Boolean Sandbox.MovieMaker.MoviePlayer.CreateTargets { get; set; }public System.Boolean Sandbox.MovieMaker.MoviePlayer.IsLooping { get; set; }public System.Boolean Sandbox.MovieMaker.MoviePlayer.IsPlaying { get; set; }public Sandbox.MovieMaker.MovieTime Sandbox.MovieMaker.MoviePlayer.Position { get; set; }public System.Single Sandbox.MovieMaker.MoviePlayer.PositionSeconds { get; set; }public Sandbox.MovieMaker.IMovieResource Sandbox.MovieMaker.MoviePlayer.Resource { get; set; }public System.Single Sandbox.MovieMaker.MoviePlayer.TimeScale { get; set; }Metadata