Mixes In

• EventEmitter
• Timeline

Methods

destroy() → {this}

Destroys the stage

• runner/stage.js, line 98

Returns:

The instance

Type

this

destroyAsset()

Sends a `destroyAsset` message to the renderer

• runner/stage.js, line 206

freeze()

Freeze/destroy the loop

• runner/stage.js, line 106

loadAsset()

Sends a `loadAsset` message to the renderer

• runner/stage.js, line 183

loadSubMovie(movieUrl, callback)

Loads a sub movie and runs it in the context of a new Movie object (should be provided by RunnerContext bootstrap)

Parameters:

Name	Type	Description
movieUrl		URL of sub-movie (will use the dirname of the submovie as asset path)
callback	Function	A callback to be called when your movie has loaded. The callback will be called with it's first argument signifying an error. So, if the first argument is `null` you can assume the movie was loaded successfully.

• runner/stage.js, line 223

post(data) → {this}

Sends data to the client.

Parameters:

Name	Type	Description
data

• runner/stage.js, line 349

Returns:

The instance

Type

this

sendMessage(category, messageData) → {this}

Sends a message to the renderer / stage controller

Parameters:

Name	Type	Argument	Default	Description
category		<optional>	null	The message category
messageData

• runner/stage.js, line 377

Returns:

The instance

Type

this

setBackgroundColor()

Set the background color of the stage

• runner/stage.js, line 453

setFramerate(framerate)

Set the framerate of the movie

Parameters:

Name	Type	Description
framerate	Number	frames per second

• runner/stage.js, line 396

setOptions(options) → {this}

Sets options on the stage

Parameters:

Name	Type	Description
options	Object	Properties Name Type Argument Default Description framerate number <optional> 30 Playback speed of the movie baseUrl string <optional> '.' The base URL to use to resolve urls. pluginUrl string <optional> '.' The base URL to use to resolve plugin location. plugins Array <optional> A list of plugin names to load.

• runner/stage.js, line 419

Returns:

the stage intance.

Type

this

setRendering(renderingType)

Set the technique for rendering, currently only supporting value, 'crispEdges'.

Parameters:

Name	Type	Description
renderingType	String	'crispEdges'

• runner/stage.js, line 438

unfreeze()

Unfreeze/initiate the loop

• runner/stage.js, line 466