Struct movingai::MovingAiMap

pub struct MovingAiMap { /* private fields */ }

Contains data structure for 2D MovingAI maps. An immutable representation of a MovingAI map.

Implementations

impl MovingAiMap

pub 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.

pub fn new_from_slice( map_type: String, height: usize, width: usize, map: Box<[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 boxed slice 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 Debug for MovingAiMap

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Index<(usize, usize)> for MovingAiMap

type Output = char

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Map2D<char> for MovingAiMap

fn width(&self) -> usize

Every Map2D must have a width.

fn height(&self) -> usize

Every Map2D must have an height.

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

In every Map2D must be possible to get a tile.

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(&self) -> CoordsIter

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.