Members

nullable owner :GameEntity

goal/Goal.js, line 20

The owner of this goal.

Default Value:

• null

status :Status

goal/Goal.js, line 27

The status of this goal.

Default Value:

• INACTIVE

Methods

activate()

goal/Goal.js, line 34

Executed when this goal is activated.

activateIfInactive() → {Goal}

goal/Goal.js, line 124

Ensures the goal is activated if it is inactive.

Returns:

Goal -

A reference to this goal.

active() → {Boolean}

goal/Goal.js, line 63

Returns true if the status of this goal is ACTIVE.

Returns:

Boolean -

Whether the goal is active or not.

completed() → {Boolean}

goal/Goal.js, line 85

Returns true if the status of this goal is COMPLETED.

Returns:

Boolean -

Whether the goal is completed or not.

execute()

goal/Goal.js, line 39

Executed in each simulation step.

failed() → {Boolean}

goal/Goal.js, line 96

Returns true if the status of this goal is FAILED.

Returns:

Boolean -

Whether the goal is failed or not.

fromJSON(json) → {Goal}

goal/Goal.js, line 159

Restores this instance from the given JSON object.

Parameters:

Name	Type	Description
json	Object	The JSON object.

Returns:

Goal -

A reference to this goal.

handleMessage(telegram) → {Boolean}

goal/Goal.js, line 52

Goals can handle messages. Many don't though, so this defines a default behavior

Parameters:

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

Returns:

Boolean -

Whether the message was processed or not.

inactive() → {Boolean}

goal/Goal.js, line 74

Returns true if the status of this goal is INACTIVE.

Returns:

Boolean -

Whether the goal is inactive or not.

replanIfFailed() → {Goal}

goal/Goal.js, line 107

Ensures the goal is replanned if it has failed.

Returns:

Goal -

A reference to this goal.

resolveReferences(entities) → {Goal}

goal/Goal.js, line 174

Restores UUIDs with references to GameEntity objects.

Parameters:

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

Returns:

Goal -

A reference to this goal.

terminate()

goal/Goal.js, line 44

Executed when this goal is satisfied.

toJSON() → {Object}

goal/Goal.js, line 143

Transforms this instance into a JSON object.

Returns:

Object -

The JSON object.