org.spongepowered.api.entity.ai.task

Interface AITask<O extends Agent>

Type Parameters:

O - The type of agent

All Known Subinterfaces:

AttackLivingAITask, AvoidEntityAITask, FindNearestAttackableTargetAITask, LookIdleAITask, RangeAgentAITask, RunAroundLikeCrazyAITask, SwimmingAITask, TargetAITask<A>, WanderAITask, WatchClosestAITask

All Known Implementing Classes:

AbstractAITask

public interface AITask<O extends Agent>

Represents a task performed by Agents. If you desire to create your own, see AbstractAITask.

Method Summary

Modifier and Type	Method and Description
boolean	canBeInterrupted() Returns if this task can be interrupted.
boolean	canRunConcurrentWith(AITask<O> other) Tests if the provided AITask is allowed to be ran concurrently with this task.
Optional<Goal<O>>	getGoal() Gets the Goal that is updating this task, if any.
default Optional<O>	getOwner() Gets the Agent that owns this task, if any.
AITaskType	getType() Gets the AITaskType of this task.

Method Detail

getType

AITaskType getType()

Gets the AITaskType of this task.

Returns:

The type

getGoal

Optional<Goal<O>> getGoal()

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

Returns:

The goal or Optional.empty() if not present

getOwner

default Optional<O> getOwner()

Gets the Agent that owns this task, if any.

Returns:

The owner or Optional.empty() if not present

canRunConcurrentWith

boolean canRunConcurrentWith(AITask<O> other)

Tests if the provided AITask is allowed to be ran concurrently with this task.

This plays a role in determining if tasks should be updated or not. If this method is being called on this task, that means:

1. This task has higher priority than the provided task for our getGoal().
2. Returning "false" will remove the provided task from the list of updated tasks, if not there already.
3. Returning "true" will add the provided task to the list of updated tasks, if not there already.

Parameters:

other - The other task

Returns:

True if it can be, false if not

canBeInterrupted

boolean canBeInterrupted()

Returns if this task can be interrupted. This determines if this task can be added to the list of updated tasks as well as if it should continue updating.

Thought should be made before blindly returning true or false here. In Minecraft, all tasks can be interrupted by higher priority tasks (tasks added with lower numerical values in Goal.addTask(int, AITask)) but a task being created by a plugin might be deemed critical and as such should return false.

Due note that the meaning of "true" changes based on the state of the Goal. To put it simply, this value can mean "Should I be added as an updating task or "Should I continue updating?". Regardless of the question, the next step that happens is transferring from this method to canRunConcurrentWith(AITask) in the next AI tick loop.

Returns:

True if can be interrupted, false if not