Struct vault::Player

pub struct Player { /* private fields */ }

Game-specific player representation. Includes generally immutable information alongside data specific to the replay being parsed.

Implementations

impl Player

pub fn name(&self) -> &str

Name of the player at the time the replay was recorded. Note that the player may have changed their name since time of recording. If attempting to uniquely identify players across replay files, look at Player::steam_id and Player::profile_id instead. The string is UTF-16 encoded.

pub fn human(&self) -> bool

Whether or not the player was a human or an AI/CPU player.

pub fn faction(&self) -> Faction

The faction selected by the player in this match.

pub fn team(&self) -> Team

The team the player was assigned to. Currently only head-to-head matchups are supported (max two teams).

pub fn battlegroup(&self) -> Option<u32>

The pbgid of the battlegroup the player selected, or None if no battlegroup was selected. For details on what this ID represents please see SelectBattlegroup::pbgid.

pub fn steam_id(&self) -> Option<u64>

The Steam ID of the player, or None if the player is AI. This ID can be used to uniquely identify a player between replays, and connect them to their Steam profile.

pub fn profile_id(&self) -> Option<u64>

The Relic profile ID of the player, or None if the player is AI. This ID can be used to uniquely identify a player between replays, and can be used to query statistical information about the player from Relic’s stats API.

pub fn messages(&self) -> Vec<Message>

A list of all messages sent by the player in the match. Sorted chronologically from first to last.

pub fn commands(&self) -> Vec<Command>

A list of all commands executed by the player in the match. Sorted chronologically from first to last.

pub fn build_commands(&self) -> Vec<Command>

A list of only build-related commands executed by the player in the match. A build command is any that enqueues the construction of a new unit or upgrade. Sorted chronologically from first to last.

pub fn battlegroup_commands(&self) -> Vec<Command>

A list of only battlegroup-related commands executed by the player in the match. A battlegroup command is any that involves the select or use of battlegroups and their abilities.

Trait Implementations

impl Clone for Player

fn clone(&self) -> Player

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Player

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

Formats the value using the given formatter.

impl Display for Player

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

Formats the value using the given formatter.