Struct SC2ReplayState 

pub struct SC2ReplayState {
    pub init_data: InitData,
    pub details: Details,
    pub units: HashMap<u32, SC2Unit>,
    pub user_state: HashMap<i64, SC2UserState>,
    pub balance_units: VersionedBalanceUnits,
}

The state of the replay as it’s being processed, units are added to owners, control groups are updated, unit position recorded, etc.

Fields

init_data: InitData

The parsed replay.initData from the MPQ, used to get further information about the players, protocol version, map size, observe, user_id (can be used to match between different event typse)

details: Details

The parsed replay.details from the MPQ, used to get information on the players

units: HashMap<u32, SC2Unit>

The registered units state as they change through time. These are with unit index as reference

user_state: HashMap<i64, SC2UserState>

The per-user state, the control groups, the supply, units, upgrades, as it progresses through time.

balance_units: VersionedBalanceUnits

The current protocol version abilities, containing a possible string translation.

Implementations

impl SC2ReplayState

pub fn with_balance_units( self, balance_units: HashMap<String, VersionedBalanceUnit>, ) -> Self

pub fn handle_transition_to_next_event( &mut self, event: SC2EventType, ) -> SC2EventIteratorItem

When an event is meant to be consumed (i.e. it’s the next in order), then the state of the game needs to transition through the event, returning a Hint of what has changed.

Trait Implementations

impl Clone for SC2ReplayState

fn clone(&self) -> SC2ReplayState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SC2ReplayState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SC2ReplayState

fn default() -> SC2ReplayState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SC2ReplayState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SC2ReplayState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&InitData> for SC2ReplayState

type Error = S2ProtocolError

The type returned in the event of a conversion error.

fn try_from(init_data: &InitData) -> Result<Self, Self::Error>

Performs the conversion.