fr.arakne.utils.maps.path

Class Pathfinder<C extends MapCell>

java.lang.Object

fr.arakne.utils.maps.path.Pathfinder<C>

public final class Pathfinder<C extends MapCell>
extends Object

Find the shortest path between two cells decoder .pathfinder() .targetDistance(2) .directions(Direction.values()) .findPath(fighter.cell(), target) ;

Constructor Summary

Constructors

Constructor and Description
Pathfinder(Decoder<C> decoder)

Method Summary

Modifier and Type	Method and Description
Pathfinder<C>	addFirstCell(boolean addFirstCell) Does the first cell (source) should be added to the path ?
Pathfinder<C>	cellWeightFunction(Function<C,Integer> function) Define the function for compute the cell cost This function can add penalty on some cells.
Pathfinder<C>	directions(Direction[] directions) Define the available movements directions Note : Adding all directions will permit to move in diagonal, But the pathfinder is not optimal, because the distance is not computed using pythagoras distance By default, the direction are the restricted directions
Pathfinder<C>	exploredCellLimit(@Positive int limit) Define the maximum number of cells to explore before fail A lower limit will fail faster, but do not permit complex path The limit cannot be higher than walkable cells number
Path<C>	findPath(C source, C target) Find the shortest path between source and target cells
Pathfinder<C>	targetDistance(@NonNegative int distance) Define the minimal target distance to consider the path as reached A distance of 0 means that the end of the path must be the target cell A distance of 1 means that the end of the path must be an adjacent cell of the target By default the value is 0 (the end must be the target)
Pathfinder<C>	walkablePredicate(Predicate<C> predicate) Define the predicate for check if the cell is walkable By default the predicate will call MapCell.walkable()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Pathfinder

public Pathfinder(Decoder<C> decoder)

Method Detail

targetDistance

public Pathfinder<C> targetDistance(@NonNegative int distance)

Define the minimal target distance to consider the path as reached A distance of 0 means that the end of the path must be the target cell A distance of 1 means that the end of the path must be an adjacent cell of the target By default the value is 0 (the end must be the target)

Parameters:

distance - The distance in number of cells

Returns:

this instance

walkablePredicate

public Pathfinder<C> walkablePredicate(Predicate<C> predicate)

Define the predicate for check if the cell is walkable By default the predicate will call MapCell.walkable()

Parameters:

predicate - The predicate to use

Returns:

this instance

cellWeightFunction

public Pathfinder<C> cellWeightFunction(Function<C,Integer> function)

Define the function for compute the cell cost This function can add penalty on some cells. For example on adjacent cell of an enemy. By default the function always returns 1

Parameters:

function - The function to use

Returns:

this instance

directions

public Pathfinder<C> directions(Direction[] directions)

Define the available movements directions Note : Adding all directions will permit to move in diagonal, But the pathfinder is not optimal, because the distance is not computed using pythagoras distance By default, the direction are the restricted directions

Parameters:

directions - Allowed directions

Returns:

this instance

See Also:

Direction.restricted()

exploredCellLimit

public Pathfinder<C> exploredCellLimit(@Positive int limit)

Define the maximum number of cells to explore before fail A lower limit will fail faster, but do not permit complex path The limit cannot be higher than walkable cells number

Parameters:

limit - The cells number. Must be a positive integer

Returns:

this instance

addFirstCell

public Pathfinder<C> addFirstCell(boolean addFirstCell)

Does the first cell (source) should be added to the path ? The source cell should be added by path generated by the server, but it's not added by the client.

Parameters:

addFirstCell - true to add the first cell (default), or false to disable

Returns:

this instance

findPath

public Path<C> findPath(C source,
                        C target)

Find the shortest path between source and target cells

Parameters:

source - The source (start) cell

target - The target (end) cell

Returns:

The path, including source

Throws:

PathException - When cannot found any valid path