Struct rust_sc2::client::RunnerMulti

pub struct RunnerMulti<'a, B> where
    B: Player + DerefMut<Target = Bot> + Deref<Target = Bot>,  {
    pub human_settings: PlayerSettings<'a>,
    pub realtime: bool,
    pub save_replay_as: Option<&'a str>,
    // some fields omitted
}

Runner for games vs Human.

Fields

human_settings: PlayerSettings<'a>

Configuration of human opponent.

realtime: bool

Play games in real time mode or not.

save_replay_as: Option<&'a str>

Save replay after the game in given path.

Implementations

impl<'a, B> RunnerMulti<'a, B> where
    B: Player + DerefMut<Target = Bot> + Deref<Target = Bot>, 

pub fn new(
    bot: &'a mut B,
    human_settings: PlayerSettings<'a>,
    map: &str,
    sc2_version: Option<&'a str>
) -> Self

Constructs new multi player runner.

pub fn launch(&mut self) -> SC2Result<()>

Launches SC2 clients and connects bot to the API.

pub fn run_game(&mut self) -> SC2Result<()>

Runs requested game.

pub fn set_map(&mut self, map: &str)

Changes map to play on.

Panics

Panics if the map doesn’t exist in maps directory.

pub fn close(&mut self)

Manually closes SC2 clients.