Struct conway::universe::BigBang

pub struct BigBang { /* fields omitted */ }

Builder paradigm to create Universe structs with default values.

Methods

impl BigBang

This is a builder for Universe structs.

Examples

let mut uni = conway::universe::BigBang::new()
                .width(512)      // optionally override width
                .height(256)     // optionally override height
                .fog_radius(16)  // optionally override fog radius
                .birth()
                .unwrap();

pub fn new() -> BigBang

Creates and returns a new builder.

pub fn width(self, new_width: usize) -> BigBang

Update the total number of columns for this Universe

pub fn height(self, new_height: usize) -> BigBang

Update the total number of rows for this Universe

pub fn server_mode(self, is_server: bool) -> BigBang

Determines whether we are running a Server or a Client.

• true - Server
• false - Client

pub fn history(self, history_depth: usize) -> BigBang

This records the number of generations that will be buffered.

pub fn add_player(self, new_player: PlayerBuilder) -> BigBang

This will add a single player to the list of players. Each player is responsible for providing their details through the PlayerBuilder.

Panics

Panics if, after adding this player, the length of the internal player_writable vector does not match the number of players.

pub fn add_players(self, new_player_list: Vec<PlayerBuilder>) -> BigBang

Adds a vector of players using add_player method.

Panics

Panics if, after adding these players, the length of the internal player_writable vector does not match the number of players.

pub fn fog_radius(self, new_radius: usize) -> BigBang

Updates the fog to a new visibility radius. This is used to grant players visibility into the fog when they are competing against other players and they create cells outside of their own writiable regions.

pub fn birth(&self) -> ConwayResult<Universe>

"Gives life to the universe and the first moment of time." Creates a Universe which can then CGoL process generations.

Errors

• if width or height are not positive, or if width is not a multiple of 64.
• if fog_radius is not positive.
• if history is not positive.