Stage - Documentation

Constructor

new Stage($engine)

Description:

Creates a new stage.

Source:

core/stage.js, line 22

Example

class StageExample extends Stage {}

Parameters:

Name	Type	Description
`$engine`	Engine	The engine on which to create the stage.

Members

actors :Array.<Actor>

Description:

Gets the current actors.

Source:

core/stage.js, line 64

Gets the current actors.

Type:

Array.<Actor>

engine :Engine

Description:

Gets the current engine.

Source:

core/stage.js, line 74

Gets the current engine.

Type:

Engine

origin :Actor

Description:

Gets the 'origin' actor (not attached).

Source:

core/stage.js, line 84

Gets the 'origin' actor (not attached).

Type:

Actor

pointOfView :Actor

Description:

Gets the point of view.

Source:

core/stage.js, line 94

Gets the point of view.

Type:

Actor

uuid :string

Description:

Gets the uuid.

Source:

core/stage.js, line 104

Gets the uuid.

Type:

string

Methods

createActor($actoropt) → {Actor.<TypeGenericAction, TypeGenericState>}

Description:

Creates the given actor.

Source:

core/stage.js, line 168

Parameters:

Name	Type	Attributes	Description
`$actor`	Class.<Actor.<TypeGenericAction, TypeGenericState>>	<optional>	The actor to create.

Returns:

Type: Actor.<TypeGenericAction, TypeGenericState>

getActorWithIdentifier($identifier) → {Actor}

Description:

Gets the first actor with the given identifier.

Source:

core/stage.js, line 185

Parameters:

Name	Type	Description
`$identifier`	string	The identifier of the actor to get.

Returns:

Type: Actor

getActorsWithIdentifier($identifier) → {Array.<Actor>}

Description:

Gets the actors with the given identifier.

Source:

core/stage.js, line 196

Parameters:

Name	Type	Description
`$identifier`	string	The identifier of the actors to get.

Returns:

Type: Array.<Actor>

hasActor($actor) → {boolean}

Description:

Checks if the stage has the given actor.

Source:

core/stage.js, line 207

Parameters:

Name	Type	Description
`$actor`	Actor	The actor to check.

Returns:

Type: boolean

hasActorWithIdentifier($identifier) → {boolean}

Description:

Checks if the stage has an actor with the given identifier.

Source:

core/stage.js, line 218

Parameters:

Name	Type	Description
`$identifier`	string	The identifier of the actor to check.

Returns:

Type: boolean

onCreate()

Description:

Called when the stage is being created.

Source:

core/stage.js, line 227

removeActor($actor)

Description:

Removes the given actor.

Source:

core/stage.js, line 234

Parameters:

Name	Type	Description
`$actor`	Actor	The actor to remove.

removeActorWithIdentifier($identifier)

Description:

Removes the first actor with the given identifier.

Source:

core/stage.js, line 249

Parameters:

Name	Type	Description
`$identifier`	string	The identifier of the actor to remove.

removeActors($force)

Description:

Removes all actors.

Source:

core/stage.js, line 266

Parameters:

Name	Type	Default	Description
`$force`	boolean	`false`	If the removal should also be applied to all actors created during this removal.

removeActorsWithIdentifier($identifier, $force)

Description:

Removes the actors with the given identifier.

Source:

core/stage.js, line 292

Parameters:

Name	Type	Default	Description
`$identifier`	string		The identifier of the actors to remove.
`$force`	boolean	`false`	If the removal should also be applied to the actors with the given identifier created during this removal.

setPointOfView($actor)

Description:

Sets the given actor as the point of view.

Source:

core/stage.js, line 317

Parameters:

Name	Type	Description
`$actor`	Actor	The actor to set as the point of view.