Pathfinding v0.1.1 Pathfinding View Source

Entry point to access the more important Pathfinding.Grid and provides the traversal methods used against a Pathfinding.Grid struct.

Link to this section Summary

Functions

Returns the path from one coordinate to another

Returns the 'walkable' coordinates within the grid from a specified coordinate. If a list of coordinate is provided, a traversal will be executed starting from each coordinate

Link to this section Functions

Link to this function

find_path(grid, start_x, start_y, end_x, end_y, cost_threshold \\ nil) View Source

Returns the path from one coordinate to another.

A cost_threshold can be provided if the traversal should terminate early, such as being restricted by movement distance.

Link to this function

find_walkable(grid, coord, cost_threshold \\ nil) View Source

Returns the 'walkable' coordinates within the grid from a specified coordinate. If a list of coordinate is provided, a traversal will be executed starting from each coordinate.

A cost_threshold can be provided if the traversal should terminate early, such as being restricted by movement distance.