Struct Map 

pub struct Map { /* private fields */ }

A Wolf RPG Editor map (.mps) file.

Contains all information needed for rendering a level, from the single tiles to the events set to happen.

Examples

use wolfrpg_map_parser::Map;
use std::fs;

match fs::read("filepath.mps") {
    Ok(bytes) => {
        let map: Map = Map::parse(&bytes);
        // Data manipulation ...
    }
    Err(_) => {
        // Error handling ...
    }
}

Implementations

impl Map

pub fn parse(bytes: &[u8]) -> Self

Parse raw bytes into a Map struct.

This is the main driver that should be used when loading a .mps file. Using other methods is highly discouraged, unless you know what you are doing and need that extra bit of speed.

Panics

This function will panic if the given bytes do not represent a valid map structure.

This might be caused by corrupt files, incompatible format updates and library bugs. In each of these cases, feel free to report an issue on GitHub.

Examples

use wolfrpg_map_parser::Map;
use std::fs;

match fs::read("filepath.mps") {
    Ok(bytes) => {
        let map: Map = Map::parse(&bytes);
        // Data manipulation ...
    }
    Err(_) => {
        // Error handling ...
    }
}

pub fn tileset(&self) -> u32

The ID of the set of pictures used for each tile.

pub fn tileset_mut(&mut self) -> &mut u32

Mutable reference accessor for Map::tileset.

pub fn width(&self) -> u32

The width of the map, in tiles.

pub fn width_mut(&mut self) -> &mut u32

Mutable reference accessor for Map::width.

pub fn height(&self) -> u32

The height of the map, in tiles.

pub fn height_mut(&mut self) -> &mut u32

Mutable reference accessor for Map::height.

pub fn layer1(&self) -> &Vec<u32>

The bottom-most layer of tiles.

Each layer is painted above the lower ones.

pub fn layer1_mut(&mut self) -> &mut Vec<u32>

Mutable reference accessor for Map::layer1.

pub fn layer2(&self) -> &Vec<u32>

The middle layer of tiles.

Each layer is painted above the lower ones.

pub fn layer2_mut(&mut self) -> &mut Vec<u32>

Mutable reference accessor for Map::layer2.

pub fn layer3(&self) -> &Vec<u32>

The top-most layer of tiles.

Each layer is painted above the lower ones.

pub fn layer3_mut(&mut self) -> &mut Vec<u32>

Mutable reference accessor for Map::layer3.

pub fn events(&self) -> &Vec<Event>

A collection of all the events set on this map.

Events are painted above each other based on the following priority:

1. If Page::options::above_hero is true, then the event has the highest priority.
2. If Page::options::above_hero is false and Page::options::slip_through is false, then the event has the second-highest priority.
3. if Page::options::above_hero is false and Page::options::slip_through is true, then the event has the lowest-priority.

When events have the same priority, they are displayed in order of Event::id.

pub fn events_mut(&mut self) -> &mut Vec<Event>

Mutable reference accessor for Map::events.

Trait Implementations

impl Clone for Map

fn clone(&self) -> Map

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl PartialEq for Map

fn eq(&self, other: &Map) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Map