org.spongepowered.api.entity.ai.task

Class AbstractAITask<O extends Agent>

java.lang.Object

org.spongepowered.api.entity.ai.task.AbstractAITask<O>

Type Parameters:

O - The type of Agent

All Implemented Interfaces:

AITask<O>

public abstract class AbstractAITask<O extends Agent>
extends Object
implements AITask<O>

An abstract implementation of a AITask that a Goal can run.

It is required for anyone wanting to write their own logic that a Goal can run to utilize this class. If you desire to use the builtin AI included with Minecraft, use GameRegistry.createBuilder(Class) and pass a builder to it instead.

At the beginning of every "AI" tick, all AITasks that are added to the parent Goal are iterated through. If an AITask is already marked as "in use", that task's continueUpdating() is checked for true. If continueUpdating() is false, reset() is invoked, and the AITask is "flagged" as unused for the parent Goal. If continueUpdating() is true, update() is invoked to perform any major logic.

If an AITask is not currently flagged as "in use", then shouldUpdate() is invoked. If shouldUpdate() is true, the AITask is marked as "in use", and start() is invoked. After start() is called, update() will be invoked to be used for the first time in this "AI tick".

Regardless whether the AITask was "in use" or not, if the AITask is now "in use", continueUpdating() is called to verify the validity of the task. If continueUpdating() is false, reset() is called to clean up the AITask.

Constructor Summary

Constructors

Constructor and Description
AbstractAITask(AITaskType type) Creates a new AbstractAITask with the provided AITask.

Method Summary

Modifier and Type	Method and Description
abstract boolean	continueUpdating() Called to verify that this AITask needs to update() in this tick.
Optional<Goal<O>>	getGoal() Gets the Goal that is updating this task, if any.
AITaskType	getType() Gets the AITaskType of this task.
abstract void	reset() Performs any reset necessary for this task during the current tick.
abstract boolean	shouldUpdate() Determines whether this AITask should be considered for "ticking" or start(), update(), and reset() are called for that "AI" tick.
abstract void	start() Invoked when the task is "started".
abstract void	update() Performs any customary logic for this "task" to modify the parent Agent in any way, including navigation, health, potion effects, etc.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.spongepowered.api.entity.ai.task.AITask

canBeInterrupted, canRunConcurrentWith, getOwner

Constructor Detail

AbstractAITask

public AbstractAITask(AITaskType type)

Creates a new AbstractAITask with the provided AITask.

Parameters:

type - The type

Method Detail

getType

public final AITaskType getType()

Description copied from interface: AITask

Gets the AITaskType of this task.

Specified by:

getType in interface AITask<O extends Agent>

Returns:

The type

getGoal

public final Optional<Goal<O>> getGoal()

Description copied from interface: AITask

Gets the Goal that is updating this task, if any.

Specified by:

getGoal in interface AITask<O extends Agent>

Returns:

The goal or Optional.empty() if not present

start

public abstract void start()

Invoked when the task is "started". A "start" of a task occurs at the "start" of the "AI" is "ticking". Depending on the case where shouldUpdate() returns false, an AITask is NOT going to be called, so this method would not be called at the "start" of the tick to "prepare" for update().

shouldUpdate

public abstract boolean shouldUpdate()

Determines whether this AITask should be considered for "ticking" or start(), update(), and reset() are called for that "AI" tick.

Returns:

Whether this task should be marked for use in the current tick

update

public abstract void update()

Performs any customary logic for this "task" to modify the parent Agent in any way, including navigation, health, potion effects, etc. Only called when shouldUpdate() returns true, and after start() has completed. Likewise, if continueUpdating()

continueUpdating

public abstract boolean continueUpdating()

Called to verify that this AITask needs to update() in this tick. If this returns false, this AITask is removed from use and reset() is called.

Returns:

Whether this task should update this "tick" or not

reset

public abstract void reset()

Performs any reset necessary for this task during the current tick.

Note that this may be called during any state during start() or update() such that the task is removed from use for the current "AI" tick.