Struct vault::commands::UseBattlegroupAbility

pub struct UseBattlegroupAbility { /* private fields */ }

Representation of a battlegroup ability usage 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 access all of a player’s battlegroup-related commands, see Player::battlegroup_commands.

Implementations

impl UseBattlegroupAbility

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.

pub fn pbgid(&self) -> u32

Internal ID that uniquely identifies the battlegroup ability used. This value can be matched to CoH3 attribute files in order to determine the battlegroup ability being used. Note that, while rare, it is possible that this value may change between patches for the same battlegroup ability.

Trait Implementations

impl Clone for UseBattlegroupAbility

fn clone(&self) -> UseBattlegroupAbility

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UseBattlegroupAbility

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

Formats the value using the given formatter.