[][src]Module world_map_gen::gen

This module provides random world map generator

RandomBoardGen is a key struct to generate a world map. It contains random number generator as its internal state and generates a random world map of several resolutions. There are 3 resolutions for generating a world map.

  • Low
  • Middle
  • High
use world_map_gen::gen::RandomBoardGen;

// Default generator initialized with hardware random number.
let mut gen = RandomBoardGen::default();

// A random map generator initialized with specific seed.
let mut gen = RandomBoardGen::from_seed(42);

// Generate 3x4 board. Resolution is automatically determined from the size.
let board = gen.gen_auto(3, 4);
assert_eq!(board.width(), 3);
assert_eq!(board.height(), 4);

// Generate 3x4 low resolution board.
let board = gen.gen_small(3, 4);
assert_eq!(board.width(), 3);
assert_eq!(board.height(), 4);

// Generate 3x4 middle resolution board.
let board = gen.gen_middle(3, 4);
assert_eq!(board.width(), 3);
assert_eq!(board.height(), 4);

// Generate 3x4 large resolution board.
let board = gen.gen_large(3, 4);
assert_eq!(board.width(), 3);
assert_eq!(board.height(), 4);

Structs

RandomBoardGen

Random world map board generator

Enums

Resolution

Resolution of the board.