Extends

• CompositeGoal

Members

evaluators :Array.<GoalEvaluator>

goal/Think.js, line 26

A list of goal evaluators.

nullable owner :GameEntity

goal/Goal.js, line 20

The owner of this goal.

Overrides:

• CompositeGoal#owner

Default Value:

• null

status :Status

goal/Goal.js, line 27

The status of this goal.

Overrides:

• CompositeGoal#status

Default Value:

• INACTIVE

subgoals :Array.<Goal>

goal/CompositeGoal.js, line 24

A list of subgoals.

Overrides:

• CompositeGoal#subgoals

Methods

activate()

goal/Think.js, line 37

Executed when this goal is activated.

Overrides:

• CompositeGoal#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:

• CompositeGoal#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:

• CompositeGoal#active

addEvaluator(evaluator) → {Think}

goal/Think.js, line 75

Adds the given goal evaluator to this instance.

Parameters:

Name	Type	Description
evaluator	GoalEvaluator	The goal evaluator to add.

Returns:

Think -

A reference to this instance.

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.

Overrides:

• CompositeGoal#addSubgoal

arbitrate() → {Think}

goal/Think.js, line 105

This method represents the top level decision process of an agent. It iterates through each goal evaluator and selects the one that has the highest score as the current goal.

Returns:

Think -

A reference to this instance.

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.

Overrides:

• CompositeGoal#clearSubgoals

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:

• CompositeGoal#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.

Overrides:

• CompositeGoal#currentSubgoal

execute()

goal/Think.js, line 46

Executed in each simulation step.

Overrides:

• CompositeGoal#execute

executeSubgoals() → {Status}

goal/CompositeGoal.js, line 107

Executes the current subgoal of this composite goal.

Returns:

Status -

The status of this composite subgoal.

Overrides:

• CompositeGoal#executeSubgoals

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:

• CompositeGoal#failed

fromJSON(json) → {Think}

goal/Think.js, line 174

Restores this instance from the given JSON object.

Parameters:

Name	Type	Description
json	Object	The JSON object.

Returns:

Think -

A reference to this instance.

Overrides:

• CompositeGoal#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:

• CompositeGoal#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.

Overrides:

• CompositeGoal#hasSubgoals

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:

• CompositeGoal#inactive

registerType(type, constructor) → {Think}

goal/Think.js, line 266

Registers a custom type for deserialization. When calling Think#fromJSON this instance is able to pick the correct constructor in order to create custom goals or goal evaluators.

Parameters:

Name	Type	Description
type	String	The name of the goal or goal evaluator.
constructor	function	The constructor function.

Returns:

Think -

A reference to this instance.

removeEvaluator(evaluator) → {Think}

goal/Think.js, line 89

Removes the given goal evaluator from this instance.

Parameters:

Name	Type	Description
evaluator	GoalEvaluator	The goal evaluator to remove.

Returns:

Think -

A reference to this instance.

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.

Overrides:

• CompositeGoal#removeSubgoal

replanIfFailed() → {Goal}

goal/Goal.js, line 107

Ensures the goal is replanned if it has failed.

Returns:

Goal -

A reference to this goal.

Overrides:

• CompositeGoal#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:

• CompositeGoal#resolveReferences

terminate()

goal/Think.js, line 63

Executed when this goal is satisfied.

Overrides:

• CompositeGoal#terminate

toJSON() → {Object}

goal/Think.js, line 151

Transforms this instance into a JSON object.

Returns:

Object -

The JSON object.

Overrides:

• CompositeGoal#toJSON