net.glowstone.util.pathfinding

Class Pathfinder

java.lang.Object

net.glowstone.util.pathfinding.Pathfinder

public class Pathfinder
extends Object

A class used for general pathfinding.

Constructor Summary

Constructors

Constructor and Description
Pathfinder(GlowBlock startPoint, GlowBlock endPoint) Creates a new pathfinder object using various options.
Pathfinder(GlowBlock startPoint, GlowBlock endPoint, Map<org.bukkit.Material,Double> materialWeights) Creates a new pathfinder object using various options.
Pathfinder(GlowBlock startPoint, GlowBlock endPoint, Map<org.bukkit.Material,Double> materialWeights, org.bukkit.Material... blockedMaterials) Creates a new pathfinder object using various options.
Pathfinder(GlowBlock startPoint, GlowBlock endPoint, org.bukkit.Material... blockedMaterials) Creates a new pathfinder object using various options.

Method Summary

Modifier and Type	Method and Description
List<org.bukkit.util.Vector>	getPath(IAlgorithm algorithm) Used to get the path from this Pathfinder's start to end points.

Methods inherited from class java.lang.Object

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

Constructor Detail

Pathfinder

public Pathfinder(GlowBlock startPoint,
                  GlowBlock endPoint)

Creates a new pathfinder object using various options.

Parameters:

startPoint - The starting position.

endPoint - The ending position.

Pathfinder

public Pathfinder(GlowBlock startPoint,
                  GlowBlock endPoint,
                  org.bukkit.Material... blockedMaterials)

Creates a new pathfinder object using various options.

Parameters:

startPoint - The starting position.

endPoint - The ending position.

blockedMaterials - A varargs of materials that should be blocked from pathing. This is used during getPath(IAlgorithm).

Pathfinder

public Pathfinder(GlowBlock startPoint,
                  GlowBlock endPoint,
                  Map<org.bukkit.Material,Double> materialWeights)

Creates a new pathfinder object using various options.

Parameters:

startPoint - The starting position.

endPoint - The ending position.

materialWeights - A map containing a material key, with a cost as the value. This is used during getPath(IAlgorithm).

Pathfinder

public Pathfinder(GlowBlock startPoint,
                  GlowBlock endPoint,
                  Map<org.bukkit.Material,Double> materialWeights,
                  org.bukkit.Material... blockedMaterials)

Creates a new pathfinder object using various options.

Parameters:

startPoint - The starting position.

endPoint - The ending position.

materialWeights - A map containing a material key, with a cost as the value. This is used during getPath(IAlgorithm).

blockedMaterials - A varargs of materials that should be blocked from pathing. This is used during getPath(IAlgorithm).

Method Detail

getPath

public List<org.bukkit.util.Vector> getPath(IAlgorithm algorithm)

Used to get the path from this Pathfinder's start to end points.

Parameters:

algorithm - The pathfinding algorithm to use.

Returns:

A list of vector's, representing block locations, of the resulting path.