IgePoint3dstartPointThe point on the map to start path-finding from.
IgePoint3dendPointThe point on the map to try to path-find to.
FunctioncomparisonCallbackThe callback function that will decide if each tile that is being considered for use in the path is allowed or not based on the tile map's data stored for that tile which is passed to this method as the first parameter. Must return a boolean value.
BooleanallowSquareWhether to allow neighboring tiles along a square axis. Defaults to true if undefined.
BooleanallowDiagonalWhether to allow neighboring tiles along a diagonal axis. Defaults to false if undefined.
BooleanallowInvalidDestinationIf the path finder cannot path to the destination tile, if this is true the closest path will be returned instead.
Returns Array An array of objects each containing an x, y co-ordinate that describes the path from the starting point to the end point in order.