RandomBoardGen

Struct RandomBoardGen 

Source
pub struct RandomBoardGen<R: Rng> { /* private fields */ }
Expand description

Random world map board generator

Implementations§

Source§

impl RandomBoardGen<StdRng>

Source

pub fn from_seed(seed: u64) -> Self

Create a new random map generator. It’s internal random number generator is initialized by the given seed. Standard random number generator is used.

Source§

impl<R: Rng> RandomBoardGen<R>

Source

pub fn gen( &mut self, resolution: Option<Resolution>, width: Option<usize>, height: Option<usize>, ) -> Result<Board<'static>>

Most generic method to generate a random map. When resolution is None, the resolution is determined from its size. When width and/or height are None they will be determined from the terminal size. In the case, when terminal size cannot be obtained, this method returns an error.

Source

pub fn gen_auto(&mut self, width: usize, height: usize) -> Board<'static>

Generate a random map of given width and height. Resolution is automatically determined from its size.

  • When width and height are lower than 15: low resolution
  • When width and height are lower than 120: middle resolution
  • Otherwise: high resolution
Source

pub fn gen_small(&mut self, width: usize, height: usize) -> Board<'static>

Generate a low resolution random map of given width and height.

Source

pub fn gen_middle(&mut self, width: usize, height: usize) -> Board<'static>

Generate a middle resolution random map of given width and height.

Source

pub fn gen_large(&mut self, width: usize, height: usize) -> Board<'static>

Generate a large resolution random map of given width and height.

Trait Implementations§

Source§

impl Default for RandomBoardGen<ThreadRng>

Source§

fn default() -> Self

Create a new random map generator. It’s internal random number generator is initialized by random number generated by hardware. Default thread-local random number generator is used.

Auto Trait Implementations§

§

impl<R> Freeze for RandomBoardGen<R>
where R: Freeze,

§

impl<R> RefUnwindSafe for RandomBoardGen<R>
where R: RefUnwindSafe,

§

impl<R> Send for RandomBoardGen<R>
where R: Send,

§

impl<R> Sync for RandomBoardGen<R>
where R: Sync,

§

impl<R> Unpin for RandomBoardGen<R>
where R: Unpin,

§

impl<R> UnwindSafe for RandomBoardGen<R>
where R: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.