Stage

Stage

Abstract stages.

Constructor

new Stage($engine)

Description:
  • Creates a new stage.
Source:
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:
Gets the current actors.
Type:

engine :Engine

Description:
  • Gets the current engine.
Source:
Gets the current engine.
Type:

pointOfView :Actor

Description:
  • Gets the point of view.
Source:
Gets the point of view.
Type:

uuid :string

Description:
  • Gets the uuid.
Source:
Gets the uuid.
Type:
  • string

Methods

createActor($actoropt)

Description:
  • Creates the given actor.
Source:
Parameters:
Name Type Attributes Description
$actor Class.<Actor> <optional>
The actor to create.

hasActor($actor) → {boolean}

Description:
  • Checks if the stage has the given actor.
Source:
Parameters:
Name Type Description
$actor Actor The actor to check.
Returns:
Type
boolean

onCreate()

Description:
  • Called when the stage is being created.
Source:

removeActor($actor)

Description:
  • Removes the given actor.
Source:
Parameters:
Name Type Description
$actor Actor The actor to remove.

removeActors()

Description:
  • Removes all actors.
Source:

setPointOfView($actor)

Description:
  • Sets the given actor as the point of view.
Source:
Parameters:
Name Type Description
$actor Actor The actor to set as the point of view.