org.spongepowered.api.entity.ai

Interface Goal<O extends Agent>

Type Parameters:

O - The type of agent

public interface Goal<O extends Agent>

Represents a set of tasks that will be updated together by an Agent.

In Minecraft, most agents have just one goal which is living or simulating, or whichever term you want to call it. Other agents, such as Monsters, use a "target" goal which serves to seek out potential victims and execute a series of attack tasks.

Method Summary

Modifier and Type	Method and Description
Goal<O>	addTask(int priority, AITask<? extends O> task) Adds a new AITask to this goal.
void	clear() Clears all AITasks from this goal.
O	getOwner() The Agent that owns this goal.
List<? super AITask<? extends O>>	getTasks() Gets all AITasks in this goal.
List<? super AITask<? extends O>>	getTasksByType(AITaskType type) Gets all AITasks whose AITaskType matches the provided type.
GoalType	getType() The type of this goal.
Goal<O>	removeTask(AITask<? extends O> task) Removes a specific AITask from this goal.
Goal<O>	removeTasks(AITaskType type) Removes all AITasks whose AITaskType matches the provided type.

Method Detail

getType

GoalType getType()

The type of this goal.

Returns:

The type

getOwner

O getOwner()

The Agent that owns this goal.

Returns:

The owner

addTask

Goal<O> addTask(int priority,
                AITask<? extends O> task)

Adds a new AITask to this goal.

Parameters:

priority - The priority this task should run at

task - The task to run

Returns:

This goal, for chaining

removeTask

Goal<O> removeTask(AITask<? extends O> task)

Removes a specific AITask from this goal.

Parameters:

task - The task to remove

Returns:

This goal, for chaining

removeTasks

Goal<O> removeTasks(AITaskType type)

Removes all AITasks whose AITaskType matches the provided type.

Parameters:

type - The type to remove

Returns:

The goal, for chaining

getTasksByType

List<? super AITask<? extends O>> getTasksByType(AITaskType type)

Gets all AITasks whose AITaskType matches the provided type.

Parameters:

type - The type to look for

Returns:

All the tasks found

getTasks

List<? super AITask<? extends O>> getTasks()

Gets all AITasks in this goal.

Returns:

The tasks

clear

void clear()

Clears all AITasks from this goal.