Struct vault::commands::SelectBattlegroup
source · pub struct SelectBattlegroup { /* private fields */ }
Expand description
Representation of a battlegroup selection command in a Company of Heroes 3 replay.
Commands are collected during tick parsing and then associated with the Player
instance that
sent them. To access, see Player::commands
. To quickly access a player’s selected battlegroup
without having to extract it from the player’s commands, see Player::battlegroup
. To access
all of a player’s battlegroup-related commands, see Player::battlegroup_commands
.
Implementations§
source§impl SelectBattlegroup
impl SelectBattlegroup
sourcepub fn tick(&self) -> u32
pub fn tick(&self) -> u32
This value is the tick at which the command was found while parsing the replay, which represents the time in the replay at which it was executed. Because CoH3’s engine runs at 8 ticks per second, you can divide this value by 8 to get the number of seconds since the replay began, which will tell you when this command was executed.
sourcepub fn pbgid(&self) -> u32
pub fn pbgid(&self) -> u32
Internal ID that uniquely identifies the battlegroup selected. This value can be matched to CoH3 attribute files in order to determine the battlegroup being selected. Note that, while rare, it is possible that this value may change between patches for the same battlegroup.
Trait Implementations§
source§impl Clone for SelectBattlegroup
impl Clone for SelectBattlegroup
source§fn clone(&self) -> SelectBattlegroup
fn clone(&self) -> SelectBattlegroup
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more