Package com.destroystokyo.paper.entity

Interface Pathfinder

public interface Pathfinder

Handles pathfinding operations for an Entity

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Pathfinder.PathResult	Represents the result of a pathfinding calculation

Method Summary

Modifier and Type	Method	Description
Pathfinder.PathResult	findPath(LivingEntity target)	Calculates a destination for the Entity to navigate to to reach the target entity, but does not set it as the current target.
Pathfinder.PathResult	findPath(Location loc)	Calculates a destination for the Entity to navigate to, but does not set it as the current target.
Pathfinder.PathResult	getCurrentPath()
Mob	getEntity()
boolean	hasPath()	If the entity is currently trying to navigate to a destination, this will return true
default boolean	moveTo(Pathfinder.PathResult path)	Takes the result of a previous pathfinding calculation and sets it as the active pathfinding with default speed.
boolean	moveTo(Pathfinder.PathResult path, double speed)	Takes the result of a previous pathfinding calculation and sets it as the active pathfinding,
default boolean	moveTo(LivingEntity target)	Calculates a destination for the Entity to navigate to to reach the target entity, and sets it with default speed.
default boolean	moveTo(LivingEntity target, double speed)	Calculates a destination for the Entity to navigate to to reach the target entity, and sets it with specified speed.
default boolean	moveTo(Location loc)	Calculates a destination for the Entity to navigate to, and sets it with default speed as the current target.
default boolean	moveTo(Location loc, double speed)	Calculates a destination for the Entity to navigate to, with desired speed as the current target.
void	stopPathfinding()	Instructs the Entity to stop trying to navigate to its current desired location

Method Detail

getEntity

@NotNull
Mob getEntity()

Returns:

The entity that is controlled by this pathfinder

stopPathfinding

void stopPathfinding()

Instructs the Entity to stop trying to navigate to its current desired location

hasPath

boolean hasPath()

If the entity is currently trying to navigate to a destination, this will return true

Returns:

true if the entity is navigating to a destination

getCurrentPath

@Nullable
Pathfinder.PathResult getCurrentPath()

Returns:

The location the entity is trying to navigate to, or null if there is no destination

findPath

@Nullable
Pathfinder.PathResult findPath(@NotNull
                               Location loc)

Calculates a destination for the Entity to navigate to, but does not set it as the current target. Useful for calculating what would happen before setting it.

Parameters:

loc - Location to navigate to

Returns:

The closest Location the Entity can get to for this navigation, or null if no path could be calculated

findPath

@Nullable
Pathfinder.PathResult findPath(@NotNull
                               LivingEntity target)

Calculates a destination for the Entity to navigate to to reach the target entity, but does not set it as the current target. Useful for calculating what would happen before setting it. The behavior of this PathResult is subject to the games pathfinding rules, and may result in the pathfinding automatically updating to follow the target Entity. However, this behavior is not guaranteed, and is subject to the games behavior.

Parameters:

target - the Entity to navigate to

Returns:

The closest Location the Entity can get to for this navigation, or null if no path could be calculated

moveTo

default boolean moveTo(@NotNull
                       Location loc)

Calculates a destination for the Entity to navigate to, and sets it with default speed as the current target.

Parameters:

loc - Location to navigate to

Returns:

If the pathfinding was successfully started

moveTo

default boolean moveTo(@NotNull
                       Location loc,
                       double speed)

Calculates a destination for the Entity to navigate to, with desired speed as the current target.

Parameters:

loc - Location to navigate to

speed - Speed multiplier to navigate at, where 1 is 'normal'

Returns:

If the pathfinding was successfully started

moveTo

default boolean moveTo(@NotNull
                       LivingEntity target)

Calculates a destination for the Entity to navigate to to reach the target entity, and sets it with default speed. The behavior of this PathResult is subject to the games pathfinding rules, and may result in the pathfinding automatically updating to follow the target Entity. However, this behavior is not guaranteed, and is subject to the games behavior.

Parameters:

target - the Entity to navigate to

Returns:

If the pathfinding was successfully started

moveTo

default boolean moveTo(@NotNull
                       LivingEntity target,
                       double speed)

Calculates a destination for the Entity to navigate to to reach the target entity, and sets it with specified speed. The behavior of this PathResult is subject to the games pathfinding rules, and may result in the pathfinding automatically updating to follow the target Entity. However, this behavior is not guaranteed, and is subject to the games behavior.

Parameters:

target - the Entity to navigate to

speed - Speed multiplier to navigate at, where 1 is 'normal'

Returns:

If the pathfinding was successfully started

moveTo

default boolean moveTo(@NotNull
                       Pathfinder.PathResult path)

Takes the result of a previous pathfinding calculation and sets it as the active pathfinding with default speed.

Parameters:

path - The Path to start following

Returns:

If the pathfinding was successfully started

moveTo

boolean moveTo(@NotNull
               Pathfinder.PathResult path,
               double speed)

Takes the result of a previous pathfinding calculation and sets it as the active pathfinding,

Parameters:

path - The Path to start following

speed - Speed multiplier to navigate at, where 1 is 'normal'

Returns:

If the pathfinding was successfully started