Struct Generator

pub struct Generator {
    pub map: Vec<usize>,
    pub width: usize,
    pub height: usize,
    pub noise_options: NoiseOptions,
    /* private fields */
}

The foundation of this crate

Fields

map: Vec<usize>

width: usize

height: usize

noise_options: NoiseOptions

Implementations

impl Generator

pub fn new() -> Self

Create generator.

pub fn with_seed(self, seed: u32) -> Self

Set seed for noise generation. Useful for reproducing results. Random otherwise.

pub fn with_options(self, options: NoiseOptions) -> Self

Changes how noise is generated. Different values make for much more interesting noise

pub fn show(&self)

Prints the map to stdout with colors.

pub fn with_size(self, width: usize, height: usize) -> Self

Sets size of map. This clears the map as well.

pub fn spawn_perlin<F: Fn(f64) -> usize + Sync>(self, f: F) -> Self

Generates perlin noise over the entire map. For every coordinate, the closure f(f64) receives a value between 0 and 1. This closure must then return a usize accordingly to what value it receives, such as the following. You can also modify some options for how the noise should behave, see NoiseOptions.

fn main() {
    Generator::new()
        .with_size(40, 20)
        .spawn_perlin(|value| {
            if value > 0.66 {
                2
            } else if value > 0.33 {
                1
            } else {
                0
            }
        })
        .show();
}

pub fn spawn_rooms(self, number: usize, rooms: usize, size: &Size) -> Self

Spawns rooms of varying sizes based on input size. number sets what number the rooms are represented with in the map, rooms is amount of rooms to generate and size specifies the minimum and maximum boundaries for each room.

fn main() {
    let size = Size::new((4, 4), (10, 10));
    Generator::new()
        .with_size(30, 20)
        .spawn_rooms(2, 3, &size)
        .show();
}

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

Returns value at (x, y) coordinate, useful since map is in 1d form but treated as 2d.

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

Same as get(...), except sets value.

pub fn get_2d_map(&self) -> Vec<Vec<usize>>

This is not recommended unless it’s convenient or necessary, as 2d vectors are slow.

Trait Implementations

impl Debug for Generator

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

Formats the value using the given formatter.

impl Default for Generator

fn default() -> Generator

Returns the “default value” for a type.

impl Display for Generator

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

Formats the value using the given formatter.