Struct rust_sc2::PlayerSettings

pub struct PlayerSettings<'a> {
    pub race: Race,
    pub name: Option<&'a str>,
    pub raw_affects_selection: bool,
    pub raw_crop_to_playable_area: bool,
}

Settings that must be provided by a player when joining a game.

if name is None, it’ll be shown as “foo(whatever)” in game.

if raw_affects_selection is true, bot will select units to which it gives orders.

if raw_crop_to_playable_area is true, maps will be crooped to the size of self.game_info.playable_area.

Defaults: name: None raw_affects_selection: false raw_crop_to_playable_area: false

Fields

race: Race

name: Option<&'a str>

raw_affects_selection: bool

raw_crop_to_playable_area: bool

Implementations

impl<'a> PlayerSettings<'a>

pub fn new(race: Race) -> Self

Constructs new settings with given Race.

pub fn with_name(self, name: &'a str) -> Self

Sets name of the player.

pub fn raw_affects_selection(self, val: bool) -> Self

Sets raw_affects_selection to a given value.

pub fn raw_crop_to_playable_area(self, val: bool) -> Self

Sets raw_crop_to_playable_area to a given value.

Trait Implementations

impl Default for PlayerSettings<'_>

fn default() -> Self

Returns the “default value” for a type.