rust_sc2::game_info

Struct GameInfo

Source
pub struct GameInfo {
    pub map_name: String,
    pub map_name_path: String,
    pub mod_names: Vec<String>,
    pub local_map_path: String,
    pub players: FxHashMap<u32, PlayerInfo>,
    pub map_size: Size,
    pub pathing_grid: PixelMap,
    pub terrain_height: Rc<ByteMap>,
    pub placement_grid: PixelMap,
    pub playable_area: Rect,
    pub start_locations: Vec<Point2>,
    pub map_center: Point2,
}
Expand description

Structure where all map information stored.

Fields§

§map_name: String

Map name bot playing on, which depends on sc2 localization language.

§map_name_path: String

Map name bot playing on, which depends on file name.

§mod_names: Vec<String>

Mods used on that map.

§local_map_path: String

Path to the map on current computer.

§players: FxHashMap<u32, PlayerInfo>

Players on this map, mapped by their ids.

§map_size: Size

Full size of the map.

§pathing_grid: PixelMap

Grid with information about pathable tiles on that map.

§terrain_height: Rc<ByteMap>

Grid with information about terrain height on that map.

§placement_grid: PixelMap

Grid with information about buildable tiles on that map.

§playable_area: Rect

Usually maps have some unplayable area around it, where units can’t exist. This rectangle is only playble area on that map.

§start_locations: Vec<Point2>

All starting locations of opponents.

§map_center: Point2

Center of the map.

Trait Implementations§

Source§

impl Clone for GameInfo

Source§

fn clone(&self) -> GameInfo

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for GameInfo

Source§

fn default() -> GameInfo

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V