RUAL Documentation

a* fastest route w/heavy lifting

This block is part of the a* path finding group and was last modified in core v12.0.7.

a* fastest route w/heavy lifting v12.0.7

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

Pin Pin Type Default
flow
flow
stopsrequired
Array [Array [x (Number), y (Number)]] or array with objects using stops_key.
array
end atrequired
Array [x (Number), y (Number)]
array
Key
The key to read from the stops array, in case the array contains objects. It contains the tiles to walk.
value
Percentage key
The percentage key to read from the stops array, in case the array contains objects. It may contain a percentage of heavy lifting required.
value
Required percentage
The minimum percentage heavy lifting required before splitting up routes. This allows for optimalization.
number
Lifting percentage
The maximum percentage heavy lifting allowed, until the user has to end the route before they can continue.
number
grid widthrequired
Width of 2D matrix
number
grid heightrequired
Height of 2D matrix
number
tilesrequired
Could be an array of 2D matrix or x, y, state. We support the following states: heavy, heavy_x2 and heavy_x4.
array
allow diagonal
Default: false
condition
cross corners
Default: false
condition
Pin Pin Type Example
flow
flow
path Matrix
Path matrix [x_y, ..]
array
path Readable
Human readable path.
array
cost
Calculated cost to walk this path to the end.
number
return cost
Calculated cost to return from last point back to first.
number
return index
If percentage given, we return from this index.
number

Core Releases

v12.0.7 This block was introduced in v12.0.7, click here to see the release notes.
Back to a* path finding Return to the main group to view all sub-groups Back to pathfinding Return to the group to view all blocks within this group