Pathfinder (api 5.0.0 API)

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

void

abort()

Aborts the running pathfinding process.

CompletionStage<PathfinderResult>

findPath(PathPosition start, PathPosition target)

Tries to find a Path between the two PathPositions.

void

registerPathfindingHook(PathfinderHook hook)

Registers a PathfinderHook that will be called on every step of the pathfinding process.

Method Details
- findPath
  
  CompletionStage<PathfinderResult> findPath(PathPosition start, PathPosition target)
  
  Tries to find a Path between the two PathPositions.
  
  Returns:
  
  An CompletionStage that will contain a PathfinderResult.
- abort
  
  void abort()
  
  Aborts the running pathfinding process.
  In this context aborts means that the pathfinding process will be stopped and the result will be PathState.ABORTED.
- registerPathfindingHook
  
  void registerPathfindingHook(PathfinderHook hook)
  
  Registers a PathfinderHook that will be called on every step of the pathfinding process. This can be used to modify the pathfinding process or to collect data.
  
  Parameters:
  
  hook - The hook to register.