Members

nullable currentState :State

fsm/StateMachine.js, line 30

The current state of the game entity.

Default Value:

• null

nullable globalState :State

fsm/StateMachine.js, line 44

This state logic is called every time the state machine is updated.

Default Value:

• null

nullable owner :GameEntity

fsm/StateMachine.js, line 23

The game entity that owns this state machine.

Default Value:

• null

nullable previousState :State

fsm/StateMachine.js, line 37

The previous state of the game entity.

Default Value:

• null

states :Map.<String, State>

fsm/StateMachine.js, line 50

A map with all states of the state machine.

Methods

add(id, state) → {StateMachine}

fsm/StateMachine.js, line 88

Adds a new state with the given ID to the state machine.

Parameters:

Name	Type	Description
id	String	The ID of the state.
state	State	The state.

Returns:

StateMachine -

A reference to this state machine.

changeTo(id) → {StateMachine}

fsm/StateMachine.js, line 136

Performs a state change to the state defined by its ID.

Parameters:

Name	Type	Description
id	String	The ID of the state.

Returns:

StateMachine -

A reference to this state machine.

fromJSON(json) → {StateMachine}

fsm/StateMachine.js, line 246

Restores this instance from the given JSON object.

Parameters:

Name	Type	Description
json	Object	The JSON object.

Returns:

StateMachine -

A reference to this state machine.

get(id) → {State}

fsm/StateMachine.js, line 124

Returns the state for the given ID.

Parameters:

Name	Type	Description
id	String	The ID of the state.

Returns:

State -

The state for the given ID.

handleMessage(telegram) → {Boolean}

fsm/StateMachine.js, line 179

Tries to dispatch the massage to the current or global state and returns true if the message was processed successfully.

Parameters:

Name	Type	Description
telegram	Telegram	The telegram with the message data.

Returns:

Boolean -

Whether the message was processed or not.

in() → {Boolean}

fsm/StateMachine.js, line 164

Returns true if this FSM is in the given state.

Returns:

Boolean -

Whether this FSM is in the given state or not.

registerType(type, constructor) → {StateMachine}

fsm/StateMachine.js, line 315

Registers a custom type for deserialization. When calling StateMachine#fromJSON the state machine is able to pick the correct constructor in order to create custom states.

Parameters:

Name	Type	Description
type	String	The name of the state type.
constructor	function	The constructor function.

Returns:

StateMachine -

A reference to this state machine.

remove(id) → {StateMachine}

fsm/StateMachine.js, line 110

Removes a state via its ID from the state machine.

Parameters:

Name	Type	Description
id	String	The ID of the state.

Returns:

StateMachine -

A reference to this state machine.

resolveReferences(entities) → {StateMachine}

fsm/StateMachine.js, line 293

Restores UUIDs with references to GameEntity objects.

Parameters:

Name	Type	Description
entities	Map.<String, GameEntity>	Maps game entities to UUIDs.

Returns:

StateMachine -

A reference to this state machine.

revert() → {StateMachine}

fsm/StateMachine.js, line 151

Returns to the previous state.

Returns:

StateMachine -

A reference to this state machine.

toJSON() → {Object}

fsm/StateMachine.js, line 206

Transforms this instance into a JSON object.

Returns:

Object -

The JSON object.

update() → {StateMachine}

fsm/StateMachine.js, line 63

Updates the internal state of the FSM. Usually called by GameEntity#update.

Returns:

StateMachine -

A reference to this state machine.