Struct sim::SimFlags

pub struct SimFlags {
    load_path: Option<String>,
    pub load: String,
    pub scenario_modifiers: Vec<ScenarioModifier>,
    pub rng_seed: u64,
    pub opts: SimOptions,
}

SimFlags specifies a simulation to setup. After parsing from structopt, you must call initialize.

Fields

load_path: Option<String>

A path to some file:

• some kind of map: start an empty simulation on the map
• a scenario
• a savestate: restore the simulation exactly from some savestate

load: String

The same as load_path, but with a default value filled out. Call initialize to set this up.

scenario_modifiers: Vec<ScenarioModifier>

A JSON list of modifiers to transform the scenario. These can be generated with the GUI.

rng_seed: u64

An arbitrary number to seed the random number generator. This is input to the deterministic simulation, so different values affect results.

opts: SimOptions

Implementations

impl SimFlags

pub const RNG_SEED: u64

pub fn initialize(&mut self)

pub fn for_test(run_name: &str) -> SimFlags

pub fn make_rng(&self) -> XorShiftRng

pub fn load_synchronously(
    &self,
    timer: &mut Timer<'_>
) -> (Map, Sim, XorShiftRng)

Loads a map and simulation. Not appropriate for use in the UI or on web.

Trait Implementations

impl Clone for SimFlags

fn clone(&self) -> SimFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl StructOpt for SimFlags

fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by [StructOpt::clap] called on the same type, otherwise it must panic.

fn from_args() -> Self

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

fn from_args_safe() -> Result<Self, Error>

Builds the struct from the command line arguments (std::env::args_os). Unlike [StructOpt::from_args], returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.