org.spongepowered.api.entity.ai.task.builtin.creature

Interface AvoidEntityAITask

All Superinterfaces:

AITask<Creature>

public interface AvoidEntityAITask
extends AITask<Creature>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AvoidEntityAITask.Builder

Method Summary

Modifier and Type	Method and Description
static AvoidEntityAITask.Builder	builder() Creates a new AvoidEntityAITask.Builder for creating a new AvoidEntityAITask.
double	getCloseRangeSpeed() Gets the speed "modifier" for which the parent Agent will move away from a found Entity to "avoid" when in close range.
double	getFarRangeSpeed() Gets the close range speed "modifier" for which the parent Agent will move away from a found Entity to "avoid" when in a farther range than 7 blocks.
float	getSearchDistance() Gets the search distance at which any Entity instances in a radius of the parent Agent are considered for avoiding.
Predicate<Entity>	getTargetSelector() Gets the Predicate for filtering which Entity instances are qualified to have the owning Agent move away from the Entity of which the Predicate.test(Object) returns true.
AvoidEntityAITask	setCloseRangeSpeed(double speed) Sets the peed "modifier" for which the parent Agent will move away from a found Entity to "avoid" when in close range.
AvoidEntityAITask	setFarRangeSpeed(double speed) Sets the close range speed "modifier" for which the parent Agent will move away from a found Entity to "avoid" when in a farther range than 7 blocks.
AvoidEntityAITask	setSearchDistance(float distance) Sets the search distance at which any Entity instances in a radius of the parent Agent are considered for avoiding.
AvoidEntityAITask	setTargetSelector(Predicate<Entity> predicate) Sets the Predicate for filtering which Entity instances are considered to be "avoided" by the owning Agent.

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

canBeInterrupted, canRunConcurrentWith, getGoal, getOwner, getType

Method Detail

builder

static AvoidEntityAITask.Builder builder()

Creates a new AvoidEntityAITask.Builder for creating a new AvoidEntityAITask.

Returns:

A new builder

getTargetSelector

Predicate<Entity> getTargetSelector()

Gets the Predicate for filtering which Entity instances are qualified to have the owning Agent move away from the Entity of which the Predicate.test(Object) returns true.

Returns:

The predicate used to filter which entities to avoid

setTargetSelector

AvoidEntityAITask setTargetSelector(Predicate<Entity> predicate)

Sets the Predicate for filtering which Entity instances are considered to be "avoided" by the owning Agent.

Parameters:

predicate - The predicate

Returns:

This task, for chaining

getSearchDistance

float getSearchDistance()

Gets the search distance at which any Entity instances in a radius of the parent Agent are considered for avoiding.

Returns:

The search distance

setSearchDistance

AvoidEntityAITask setSearchDistance(float distance)

Sets the search distance at which any Entity instances in a radius of the parent Agent are considered for avoiding.

Parameters:

distance - The search distance

Returns:

This task, for chaining

getCloseRangeSpeed

double getCloseRangeSpeed()

Gets the speed "modifier" for which the parent Agent will move away from a found Entity to "avoid" when in close range. Close range is currently defined as 7 blocks.

Returns:

The close range movement speed modifier

setCloseRangeSpeed

AvoidEntityAITask setCloseRangeSpeed(double speed)

Sets the peed "modifier" for which the parent Agent will move away from a found Entity to "avoid" when in close range. Close range is currently defined as 7 blocks.

Parameters:

speed - The movement speed modifier

Returns:

This task, for chaining

getFarRangeSpeed

double getFarRangeSpeed()

Gets the close range speed "modifier" for which the parent Agent will move away from a found Entity to "avoid" when in a farther range than 7 blocks.

Returns:

The close range speed

setFarRangeSpeed

AvoidEntityAITask setFarRangeSpeed(double speed)

Sets the close range speed "modifier" for which the parent Agent will move away from a found Entity to "avoid" when in a farther range than 7 blocks.

Parameters:

speed - The movement speed modifier

Returns:

This task, for chaining