net.citizensnpcs.api.ai

Class SimpleGoalController

java.lang.Object

net.citizensnpcs.api.ai.SimpleGoalController

All Implemented Interfaces:

Iterable<GoalController.GoalEntry>, Runnable, GoalController

public class SimpleGoalController
extends Object
implements GoalController

A simple GoalController implementation that stores goals as a ArrayList. It works with both Behavior, Goal and will also consider PrioritisableGoals if implemented.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SimpleGoalController.SimpleGoalSelector

Nested classes/interfaces inherited from interface net.citizensnpcs.api.ai.GoalController

GoalController.GoalEntry

Constructor Summary

Constructors

Constructor and Description
SimpleGoalController()

Method Summary

Modifier and Type	Method and Description
void	addBehavior(Behavior behavior, int priority) Registers a Behavior with a given priority.
void	addGoal(Goal goal, int priority) Registers a Goal with a given priority.
void	addPrioritisableGoal(PrioritisableGoal goal) Registers a goal which can reprioritise itself dynamically every tick.
void	cancelCurrentExecution() Cancels and resets the currently executing goal.
void	clear() Clears the goal controller of all Goals.
boolean	isExecutingGoal()
boolean	isPaused()
Iterator<GoalController.GoalEntry>	iterator()
void	removeBehavior(Behavior behavior) Removes the given Behavior from rotation.
void	removeGoal(Goal goal) Removes a Goal from rotation.
void	run()
void	setPaused(boolean paused) Sets whether the controller is paused.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SimpleGoalController

public SimpleGoalController()

Method Detail

addBehavior

public void addBehavior(Behavior behavior,
                        int priority)

Description copied from interface: GoalController

Registers a Behavior with a given priority.

Specified by:

addBehavior in interface GoalController

Parameters:

behavior - The behavior

priority - The priority

See Also:

GoalController.addGoal(Goal, int)

addGoal

public void addGoal(Goal goal,
                    int priority)

Description copied from interface: GoalController

Registers a Goal with a given priority. Priority must be greater than 0.

Specified by:

addGoal in interface GoalController

Parameters:

goal - The goal

priority - The goal priority

addPrioritisableGoal

public void addPrioritisableGoal(PrioritisableGoal goal)

Description copied from interface: GoalController

Registers a goal which can reprioritise itself dynamically every tick. Implementation note: this may slow down individual goal controller ticks as the list must be sorted every tick.

Specified by:

addPrioritisableGoal in interface GoalController

cancelCurrentExecution

public void cancelCurrentExecution()

Description copied from interface: GoalController

Cancels and resets the currently executing goal.

Specified by:

cancelCurrentExecution in interface GoalController

clear

public void clear()

Description copied from interface: GoalController

Clears the goal controller of all Goals. Will stop the execution of any current goal.

Specified by:

clear in interface GoalController

isExecutingGoal

public boolean isExecutingGoal()

Specified by:

isExecutingGoal in interface GoalController

Returns:

Whether a goal is currently being executed

isPaused

public boolean isPaused()

Specified by:

isPaused in interface GoalController

Returns:

Whether the controller is currently paused

See Also:

GoalController.setPaused(boolean)

iterator

public Iterator<GoalController.GoalEntry> iterator()

Specified by:

iterator in interface Iterable<GoalController.GoalEntry>

removeBehavior

public void removeBehavior(Behavior behavior)

Description copied from interface: GoalController

Removes the given Behavior from rotation.

Specified by:

removeBehavior in interface GoalController

Parameters:

behavior - The behavior to remove

removeGoal

public void removeGoal(Goal goal)

Description copied from interface: GoalController

Removes a Goal from rotation.

Specified by:

removeGoal in interface GoalController

Parameters:

goal - The goal to remove

run

public void run()

Specified by:

run in interface Runnable

setPaused

public void setPaused(boolean paused)

Description copied from interface: GoalController

Sets whether the controller is paused. While paused, no new Goals will be selected and any executing goals will be suspended.

Specified by:

setPaused in interface GoalController

Parameters:

paused - Whether to pause execution