Extends

• Goal

Members

nullable owner :GameEntity

goal/Goal.js, line 20

The owner of this goal.

Overrides:

• Goal#owner

Default Value:

• null

status :Status

goal/Goal.js, line 27

The status of this goal.

Overrides:

• Goal#status

Default Value:

• INACTIVE

subgoals :Array.<Goal>

goal/CompositeGoal.js, line 24

A list of subgoals.

Methods

activate()

goal/Goal.js, line 34

Executed when this goal is activated.

Overrides:

• Goal#activate

activateIfInactive() → {Goal}

goal/Goal.js, line 124

Ensures the goal is activated if it is inactive.

Returns:

Goal -

A reference to this goal.

Overrides:

• Goal#activateIfInactive

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.

Overrides:

• Goal#active

addSubgoal(goal) → {Goal}

goal/CompositeGoal.js, line 34

Adds a goal as a subgoal to this instance.

Parameters:

Name	Type	Description
goal	Goal	The subgoal to add.

Returns:

Goal -

A reference to this goal.

clearSubgoals() → {Goal}

goal/CompositeGoal.js, line 63

Removes all subgoals and ensures Goal#terminate is called for each subgoal.

Returns:

Goal -

A reference to this goal.

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.

Overrides:

• Goal#completed

currentSubgoal() → {Goal}

goal/CompositeGoal.js, line 86

Returns the current subgoal. If no subgoals are defined, null is returned.

Returns:

Goal -

The current subgoal.

execute()

goal/Goal.js, line 39

Executed in each simulation step.

Overrides:

• Goal#execute

executeSubgoals() → {Status}

goal/CompositeGoal.js, line 107

Executes the current subgoal of this composite goal.

Returns:

Status -

The status of this composite subgoal.

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.

Overrides:

• Goal#failed

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.

Overrides:

• Goal#fromJSON

handleMessage() → {Boolean}

goal/CompositeGoal.js, line 187

Returns true if the given message was processed by the current subgoal.

Returns:

Boolean -

Whether the message was processed or not.

Overrides:

• Goal#handleMessage

hasSubgoals() → {Boolean}

goal/CompositeGoal.js, line 176

Returns true if this composite goal has subgoals.

Returns:

Boolean -

Whether the composite goal has subgoals 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.

Overrides:

• Goal#inactive

removeSubgoal(goal) → {Goal}

goal/CompositeGoal.js, line 48

Removes a subgoal from this instance.

Parameters:

Name	Type	Description
goal	Goal	The subgoal to remove.

Returns:

Goal -

A reference to this goal.

replanIfFailed() → {Goal}

goal/Goal.js, line 107

Ensures the goal is replanned if it has failed.

Returns:

Goal -

A reference to this goal.

Overrides:

• Goal#replanIfFailed

resolveReferences(entities) → {CompositeGoal}

goal/CompositeGoal.js, line 229

Restores UUIDs with references to GameEntity objects.

Parameters:

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

Returns:

CompositeGoal -

A reference to this composite goal.

Overrides:

• Goal#resolveReferences

terminate()

goal/Goal.js, line 44

Executed when this goal is satisfied.

Overrides:

• Goal#terminate

toJSON() → {Object}

goal/CompositeGoal.js, line 206

Transforms this instance into a JSON object.

Returns:

Object -

The JSON object.

Overrides:

• Goal#toJSON