Package de.bsommerfeld.pathetic.api.pathing

Class PathfindingProgress

java.lang.Object

de.bsommerfeld.pathetic.api.pathing.PathfindingProgress

public class PathfindingProgress
extends Object

Immutable container for the three core positions in a pathfinding operation.

Holds the start position, the current position being evaluated, and the target position. Used to pass these positions together to pathfinding components.

Since:

5.3.3

Constructor Summary

Constructors

Constructor	Description
PathfindingProgress(PathPosition startPosition, PathPosition currentPosition, PathPosition targetPosition)

Method Summary

Modifier and Type	Method	Description
PathPosition	currentPosition()	Returns the current step (position) of the pathfinding process.
boolean	equals(Object o)
int	hashCode()
PathPosition	startPosition()	Returns the start position of the overall pathfinding process.
PathPosition	targetPosition()	Returns the destination (target) position of the overall pathfinding process.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PathfindingProgress

public PathfindingProgress(PathPosition startPosition,
 PathPosition currentPosition,
 PathPosition targetPosition)

Method Details

startPosition

public PathPosition startPosition()

Returns the start position of the overall pathfinding process.

Returns:

the start position

currentPosition

public PathPosition currentPosition()

Returns the current step (position) of the pathfinding process.

Returns:

the current position

targetPosition

public PathPosition targetPosition()

Returns the destination (target) position of the overall pathfinding process.

Returns:

the target position

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object