Struct movingai::MovingAiMap

pub struct MovingAiMap { /* fields omitted */ }

An immutable representation of a MovingAI map.

Methods

impl MovingAiMap

fn new(
    map_type: String,
    height: usize,
    width: usize,
    map: Vec<char>
) -> MovingAiMap

Create a new MovingAIMap object from basic components.

Arguments

• map_type: The type of map you are registering. Usually octile.
• height: the height of the map.
• width: the width of the map.
• map: A vector representing the map in row-major order.

Panics

The new call will panic id the size of the map vector is different from heigth*width.

Trait Implementations

impl Map2D<char> for MovingAiMap

fn get_width(&self) -> usize

Every Map2D must have a width.

fn get_height(&self) -> usize

Every Map2D must have an height.

fn get_cell(&self, coords: Coords2D) -> &char

In every Map2D must be possible to get an item.

fn is_out_of_bound(&self, coords: Coords2D) -> bool

Check if the given coordinates are out of bound.

fn is_traversable(&self, tile: Coords2D) -> bool

Check if a tile in the map can be traversed.

fn is_traversable_from(&self, from: Coords2D, to: Coords2D) -> bool

Check if a tile in the map can be traversed coming from the from tile.

fn coords_iter(&self) -> Map2DCoordsIter

Return an iterator returning all the coordinates in the map in row-major order.

fn free_states(&self) -> usize

Return the number of free states of a map.

fn neighbors(&self, tile: Coords2D) -> Vec<Coords2D>

Return the list of accessible neighbors of a tile.

impl Index<Coords2D> for MovingAiMap

type Output = char

The returned type after indexing.

fn index(&self, coords: Coords2D) -> &char

Performs the indexing (container[index]) operation.