Struct genie_scx::Map

pub struct Map { /* fields omitted */ }

Describes the terrain in a map.

Implementations

impl Map

pub fn new(width: u32, height: u32) -> Self

Create a new, empty map.

pub fn fill(&mut self, terrain_type: u8)

Fill the map with the given terrain type.

pub fn read_from(input: impl Read) -> Result<Self>

Read map/terrain data from an input stream.

pub fn write_to(&self, output: impl Write, version: u32) -> Result<()>

Write map/terrain data to an output stream.

pub fn version(&self) -> u32

Get the version of the map data.

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.

pub fn rows(&self) -> impl Iterator<Item = &[Tile]>

Iterate over all the tiles by row.

This is handy if you want to iterate over tiles while keeping track of coordinates.

Example

let mut ys = vec![];
for (y, row) in map.rows().enumerate() {
    let mut xs = vec![];
    for (x, tile) in row.iter().enumerate() {
        xs.push(x);
    }
    assert_eq!(xs, (0..120).collect::<Vec<usize>>());
    ys.push(y);
}
assert_eq!(ys, (0..120).collect::<Vec<usize>>());

pub fn rows_mut(&mut self) -> impl Iterator<Item = &mut [Tile]>

Iterate over all the tiles by row, with mutable references.

Trait Implementations

impl Clone for Map

fn clone(&self) -> Map

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Map

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

Formats the value using the given formatter.