Struct genie_scx::Map

pub struct Map { /* fields omitted */ }

Describes the terrain in a map.

Methods

impl Map

pub fn from<R: Read>(input: &mut R) -> Result<Self>

pub fn write_to<W: Write>(&self, output: &mut W) -> Result<()>

pub fn width(&self) -> u32

Get the width of the map.

pub fn height(&self) -> u32

Get the height of the map.

pub fn tile(&self, x: u32, y: u32) -> Option<&Tile>

Get a tile at the given coordinates.

If the coordinates are out of bounds, returns None.

pub fn tile_mut(&mut self, x: u32, y: u32) -> Option<&mut Tile>

Get a mutable reference to the tile at the given coordinates.

If the coordinates are out of bounds, returns None.

pub fn tiles(&self) -> impl Iterator<Item = &Tile>

Iterate over all the tiles.

pub fn tiles_mut(&mut self) -> impl Iterator<Item = &mut Tile>

Iterate over all the tiles, with mutable references.

This is handy if you want to replace terrains throughout the entire map, for example.

Trait Implementations

impl Debug for Map

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

Formats the value using the given formatter.