pathfinding: a* farthest point in route
Array [x (Number), y (Number)]
Array [Array [x (Number), y (Number)]]
e.g. areas.tile
Array Matrix or Array of States
Default: false
Default: false

flow

start at

stops

Key

grid width

grid height

tiles

allow diagonal

cross corners

flow

tile

pathfinding: a* fastest route w/heavy lifting
Array [x (Number), y (Number)]
Array [Array [x (Number), y (Number)]] or array with objects using
Array [x (Number), y (Number)]
The key to read from the stops array, in case the array contains objects. It contains the tiles to walk.
The percentage key to read from the stops array, in case the array contains objects. It may contain a percentage of heavy lifting required.
Score penalty given walking past a previous stop.

Default:

The minimum percentage heavy lifting required before splitting up routes. This allows for optimalization.
The maximum percentage heavy lifting allowed, until the user has to end the route before they can continue.
Width of 2D matrix
Height of 2D matrix
Could be an array of 2D matrix or x, y, state. We support the following states:
Default: false
Default: false
Path matrix
Human readable path.
Calculated cost to walk this path to the end.
Calculated cost to return from last point back to first.
If percentage given, we return from this index.

Calculates the fastest route over multiple stops using heavy lifting parameters.

flow

start at

stops

`stops_key`

.
end at

Key

Percentage key

Walk-by penalty

Default:

`10`

Required percentage

Lifting percentage

grid width

grid height

tiles

`heavy`

, `heavy_x2`

and `heavy_x4`

.
allow diagonal

cross corners

flow

path Matrix

`[x_y, ..]`

path Readable

cost

return cost

return index

pathfinding: a*
Array [x (Number), y (Number)]
Array [x (Number), y (Number)]
Array Matrix or Array of States
Default: false
Default: false

Finds a path within a given grid.

flow

start at

stop at

grid width

grid height

tiles

allow diagonal

cross corners

flow

path Matrix

path Readable

cost

pathfinding: dijkstra
Array [x (Number), y (Number)]
Array [x (Number), y (Number)]
Array Matrix or Array of States
Default: false
Default: false

flow

start at

stop at

grid width

grid height

tiles

allow diagonal

cross corners

flow

path Matrix

path Readable