Struct rpgtools::map::GridMap

pub struct GridMap { /* private fields */ }

A map with grid coordinates

Examples

// Make a map that's 25x25 cells in size.
let map = GridMap::new(25, 25);

Implementations

impl GridMap

pub fn new(xmax: usize, ymax: usize) -> GridMap

Make a new GridMap

Examples

// Make a map that's 25x25 cells in size.
let map = GridMap::new(25, 25);

pub fn get_limits(&self) -> (usize, usize)

Returns size of map in (x, y) format

Examples

let limits = map.get_limits();
assert_eq!(limits, (25, 25));

pub fn get_cell_ref(&self, x: usize, y: usize) -> &GridCell

Get a reference to a GridCell at coordinate.

pub fn place_entrance(&mut self, (x, y): (usize, usize))

Set the entrance at a particular location. The cell at this location will be marked as having the entrance area type. Typically this will be coloured differently on a map.

pub fn place_entrance_near(
    &mut self,
    (x, y): (usize, usize)
) -> Result<(), &'static str>

Similar to place entrance, however it starts with the coordinates and finds the nearest spot that is already a “room”. This allows entrances to be placed in non-deterministic generators, such as caves.

pub fn place_room(&mut self, (x0, y0): (usize, usize), (x1, y1): (usize, usize))

Set a room

pub fn place_room_dimensions(
    &mut self,
    (x, y): (usize, usize),
    (w, h): (isize, isize)
)

Place a room by setting the origin and width/height

Arguments:

• (x, y) -> The origin of the room. This will be a corner.
• (w, h) -> Width/Height of the room. Note, they’re isize because you can specify the w/h to be left OR right of the origin and up OR down, respectively.

pub fn place_hallway(
    &mut self,
    (x0, y0): (usize, usize),
    (x1, y1): (usize, usize),
    route: RouteMethod
)

Place a hallway between two points

pub fn generate_random_cells(&mut self, limit: i64)

Generate random cells with a biasing towards more/less rooms. Limit is a value between 1 and 100. This limit sets the chance that the cells are a room. Higher limit means fewer rooms.

pub fn generate_annealed_random_cells(&mut self)

pub fn place_random_room(&mut self, scale: usize, connect: bool)

Place a randomly sized room of up to scale length or width.

pub fn generate_dungeon(&mut self, num_rooms: usize, room_size: usize)

pub fn generate_cave(&mut self, iter: i64, seed_limit: i64)

Trait Implementations

impl Clone for GridMap

fn clone(&self) -> GridMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GridMap

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

Formats the value using the given formatter.