Package de.bsommerfeld.pathetic.api.pathing

Interface Pathfinder

All Known Implementing Classes:

AbstractPathfinder, AStarPathfinder

public interface Pathfinder

A Pathfinder is a class that can find a path between two positions while following a given set of rules.

Method Summary

Modifier and Type	Method	Description
default PathfindingSearch	findPath(PathPosition start, PathPosition target)	Tries to find a Path between the two PathPositions.
PathfindingSearch	findPath(PathPosition start, PathPosition target, EnvironmentContext context)	Tries to find a path between the specified start and target positions within the provided environment context.
void	registerPathfindingHook(PathfinderHook hook)	Deprecated. Use PathfinderConfiguration.PathfinderConfigurationBuilder.pathfindingHooks(java.util.List) to configure hooks in the PathfinderConfiguration instead.

Method Details

findPath

default PathfindingSearch findPath(PathPosition start,
 PathPosition target)

Tries to find a Path between the two PathPositions.

Returns:

A PathfindingSearch instance that can be used to configure and retrieve the result of the pathfinding operation.

findPath

PathfindingSearch findPath(PathPosition start,
 PathPosition target,
 EnvironmentContext context)

Tries to find a path between the specified start and target positions within the provided environment context.

Parameters:

start - The starting position for pathfinding.

target - The target position for pathfinding.

context - The environment context that provides additional information for the pathfinding operation. This parameter can be null if no specific context is required.

Returns:

A PathfindingSearch instance that can be used to configure and retrieve the result of the pathfinding operation.

registerPathfindingHook

@Deprecated
void registerPathfindingHook(PathfinderHook hook)

Deprecated.

Use PathfinderConfiguration.PathfinderConfigurationBuilder.pathfindingHooks(java.util.List) to configure hooks in the PathfinderConfiguration instead.

Registers a PathfinderHook that will be called on every step of subsequent pathfinding operations.

Each search snapshots the currently registered hooks at the moment it starts. Hooks registered after that snapshot apply only to future searches, never to a search that is already running.

Parameters:

hook - The hook to register.