Members

engine :Engine

The game engine associated with the action.

Type:

• Engine

Source:

• Action.js, line 14

entity :Entity

The entity associated with the action.

Type:

• Entity

Source:

• Action.js, line 19

options :Object

The arguments associated with the action.

Type:

• Object

Source:

• Action.js, line 32

player :Entity

The player who requested the action. Note that a player is an entity with a player component. It defaults to PlayerComponent, but it can be changed by TurnEngine.

Type:

• Entity

Source:

• Action.js, line 27

result :Object

The result of the action. It should be null if it hasn't run yet.

Type:

• Object

Source:

• Action.js, line 38

Methods

<static> deserialize(engine, object) → {Action}

Deserializes the action.

Parameters:

Name	Type	Description
engine	Engine	The game engine.
object	Object	Serialized Action object.

Source:

• Action.js, line 71

Returns:

The deserialized Action object

Type

Action

<static> scaffold(func, constructor, classObj) → {Action}

Creates a new Action class that has given function as Action#run.

Parameters:

Name	Type	Argument	Default	Description
func	function			The function to use as Action#run.
constructor	function			The function to use as constructor.
classObj	function	<optional>	Action	The class to extend from.

Source:

• Action.js, line 86

Returns:

A new class that has specified function and class.

Type

Action

run(engine)

Runs the action and applies changes to the engine.

Parameters:

Name	Type	Description
engine	Engine	The game engine to assign.

Source:

• Action.js, line 46

Throws:

Will throw an error if action#run is not implemented.

serialize() → {Object}

Serializes the action.

Source:

• Action.js, line 54

Returns:

The serialized Action object

Type

Object