vault 10.2.0

A parser for Company of Heroes replay files.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

//! Wrapper for Company of Heroes 3 player commands.

use crate::{
    command_data::{Empty, Pbgid, Sourced, SourcedIndex, SourcedPbgid, Unknown},
    command_type::CommandType,
    data::ticks,
};

#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

/// Wrapper for one of many Company of Heroes 3 player commands parsed from a replay file. For
/// details on the specifics of a given command, see the specific enum variants.
///
/// Commands are collected during tick parsing and then associated with the `Player` instance that
/// sent them. To access, see `Player::commands`.

#[derive(Clone, Debug)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "magnus", magnus::wrap(class = "VaultCoh::Command"))]
pub enum Command {
    AITakeover(Empty),
    BuildGlobalUpgrade(SourcedPbgid),
    BuildSquad(SourcedPbgid),
    CancelConstruction(Sourced),
    CancelProduction(SourcedIndex),
    ConstructEntity(Pbgid),
    SelectBattlegroup(Pbgid),
    SelectBattlegroupAbility(Pbgid),
    UseAbility(SourcedPbgid),
    UseBattlegroupAbility(Pbgid),
    Unknown(Unknown),
}

impl Command {
    pub(crate) fn from_data_command_at_tick(command: ticks::Command, tick: u32) -> Self {
        match command.data {
            ticks::CommandData::Empty => match command.action_type {
                CommandType::PCMD_AIPlayer => Self::AITakeover(Empty::new(tick)),
                _ => panic!(
                    "an empty command isn't being handled here! command type {:?}",
                    command.action_type
                ),
            },
            ticks::CommandData::Pbgid(pbgid) => match command.action_type {
                CommandType::PCMD_Ability => {
                    Self::UseBattlegroupAbility(Pbgid::new(tick, command.index, pbgid))
                }
                CommandType::PCMD_InstantUpgrade => {
                    Self::SelectBattlegroup(Pbgid::new(tick, command.index, pbgid))
                }
                CommandType::PCMD_PlaceAndConstructEntities => {
                    Self::ConstructEntity(Pbgid::new(tick, command.index, pbgid))
                }
                CommandType::PCMD_TentativeUpgrade => {
                    Self::SelectBattlegroupAbility(Pbgid::new(tick, command.index, pbgid))
                }
                _ => panic!(
                    "a pbgid command isn't being handled here! command type {:?}",
                    command.action_type
                ),
            },
            ticks::CommandData::SourcedPbgid(pbgid, source_identifier) => match command.action_type
            {
                CommandType::CMD_Ability => Self::UseAbility(SourcedPbgid::new(
                    tick,
                    command.index,
                    pbgid,
                    source_identifier,
                )),
                CommandType::CMD_BuildSquad => Self::BuildSquad(SourcedPbgid::new(
                    tick,
                    command.index,
                    pbgid,
                    source_identifier,
                )),
                CommandType::CMD_Upgrade => Self::BuildGlobalUpgrade(SourcedPbgid::new(
                    tick,
                    command.index,
                    pbgid,
                    source_identifier,
                )),
                _ => panic!(
                    "a sourced pbgid command isn't being handled here! command type {:?}",
                    command.action_type
                ),
            },
            ticks::CommandData::Sourced(source_identifier) => match command.action_type {
                CommandType::CMD_CancelConstruction => {
                    Self::CancelConstruction(Sourced::new(tick, command.index, source_identifier))
                }
                _ => panic!(
                    "a sourced command isn't being handled here! command type {:?}",
                    command.action_type
                ),
            },
            ticks::CommandData::SourcedIndex(source_identifier, queue_index) => {
                match command.action_type {
                    CommandType::CMD_CancelProduction => Self::CancelProduction(SourcedIndex::new(
                        tick,
                        command.index,
                        source_identifier,
                        queue_index,
                    )),
                    _ => panic!(
                        "a sourced command isn't being handled here! command type {:?}",
                        command.action_type
                    ),
                }
            }
            ticks::CommandData::Unknown => {
                Self::Unknown(Unknown::new(tick, command.index, command.action_type))
            }
        }
    }
}

// this is safe as Command does not contain any Ruby types
#[cfg(feature = "magnus")]
unsafe impl magnus::IntoValueFromNative for Command {}

#[derive(Clone, Debug)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg(feature = "raw")]
pub struct RawCommand {
    pub tick: u32,
    pub index: u32,
    pub action_type: CommandType,
    pub player_id: u8,
    pub bytes: Vec<u8>,
}

#[cfg(feature = "raw")]
impl RawCommand {
    pub(crate) fn from_data_command_at_tick(command: ticks::Command, tick: u32) -> Self {
        Self {
            tick,
            index: command.index,
            action_type: command.action_type,
            player_id: command.player_id,
            bytes: command.bytes,
        }
    }
}