#path-finding #traits #rogue-like #brackets #geometry #interface #maps

bracket-algorithm-traits

Traits required for the bracket-* crates. Adapt your maps to the traits with Algorithm2D, Algorithm3D and BaseMap.

6 releases

0.8.7 Oct 4, 2022
0.8.2 Feb 10, 2021
0.8.1 Apr 29, 2020
0.7.0 Feb 22, 2020
0.1.0 Feb 21, 2020

#1421 in Game dev

Download history 919/week @ 2023-12-12 851/week @ 2023-12-19 625/week @ 2023-12-26 446/week @ 2024-01-02 925/week @ 2024-01-09 895/week @ 2024-01-16 672/week @ 2024-01-23 540/week @ 2024-01-30 920/week @ 2024-02-06 1088/week @ 2024-02-13 1002/week @ 2024-02-20 1147/week @ 2024-02-27 991/week @ 2024-03-05 839/week @ 2024-03-12 1353/week @ 2024-03-19 1110/week @ 2024-03-26

4,554 downloads per month
Used in 9 crates (2 directly)

MIT license

88KB
2K SLoC

bracket-algorithm-traits

This crate provides traits for use in the bracket-pathfinding and bracket-geometry crates. It is part of the overall bracket-lib system.

Using a trait interface means that bracket-lib doesn't have to know or care about how you store your data, and can still provide useful geometry and path-finding functions. Defaults are provided, allowing you to get up and running quickly.

Everything is exported via bracket_algorithm_traits::prelude.

Map Indexing

A truly minimal implementation (replace TestMap with your map structure):

struct TestMap{};
impl BaseMap for TestMap {}
impl Algorithm2D for TestMap{
    fn dimensions(&self) -> Point {
        Point::new(2, 2)
    }
}

This is sufficient to provide the following services:

  • in_bounds(Point): is a point within the dimensions of the map?
  • point2d_to_index(Point) -> usize: provides an array index for a point, within the map dimensions. It assumes that your array has striding by column.
  • index_to_point2d(usize) -> Point : provides an x/y coordinate for a given array index, assuming the same striding.

If you don't like the default implementations, feel free to override them.

There is an equivalent Algorithm3D for 3D grid-based maps (substitute Point3D for Point).

Map Traversal

The BaseMap trait helps you define the map. If you want to use path-finding, you need to implement the is_opaque function:

impl BaseMap for MyMap {
    fn is_opaque(&self, _idx: usize) -> bool {
        false
    }
}

To support path-finding, you need to implement two more functions:

impl BaseMap for MyMap {
    fn get_available_exits(&self, idx: usize) -> SmallVec<[(usize, f32); 10]> {
        Vec::new()
        // Provide a list of exit indices (you can use point2d_to_index to generate them) for this
        // tile inside the array.
        // Do NOT include the current tile as an available exit.
    }

    fn get_pathing_distance(&self, _idx1: usize, _idx2: usize) -> f32 {
        1.0
        // This should be a distance, using whatever heuristic you prefer.
    }

Dependencies

~1.5MB
~32K SLoC