wow_world_messages 0.3.0

Message definitions for World of Warcraft world servers
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205

use std::io::{Read, Write};

use crate::Guid;
use crate::shared::level_vanilla_tbc_wrath::Level;
use crate::tbc::{
    Area, Character, CharacterGear, Class, CreatureFamily, Gender, InventoryType, 
    Map, Race, Vector3d,
};

/// Auto generated from the original `wowm` in file [`wow_message_parser/wowm/world/character_screen/smsg_char_enum_2_4_3.wowm:3`](https://github.com/gtker/wow_messages/tree/main/wow_message_parser/wowm/world/character_screen/smsg_char_enum_2_4_3.wowm#L3):
/// ```text
/// smsg SMSG_CHAR_ENUM = 0x003B {
///     u8 amount_of_characters;
///     Character[amount_of_characters] characters;
/// }
/// ```
#[derive(Debug, Clone, PartialEq, PartialOrd, Default)]
pub struct SMSG_CHAR_ENUM {
    pub characters: Vec<Character>,
}

impl crate::private::Sealed for SMSG_CHAR_ENUM {}
impl SMSG_CHAR_ENUM {
    fn read_inner(mut r: &mut &[u8], body_size: u32) -> Result<Self, crate::errors::ParseErrorKind> {
        if !(1..=126465).contains(&body_size) {
            return Err(crate::errors::ParseErrorKind::InvalidSize);
        }

        // amount_of_characters: u8
        let amount_of_characters = crate::util::read_u8_le(&mut r)?;

        // characters: Character[amount_of_characters]
        let characters = {
            let mut characters = Vec::with_capacity(amount_of_characters as usize);
            for _ in 0..amount_of_characters {
                characters.push(Character::read(&mut r)?);
            }
            characters
        };

        Ok(Self {
            characters,
        })
    }

}

impl crate::Message for SMSG_CHAR_ENUM {
    const OPCODE: u32 = 0x003b;

    #[cfg(feature = "print-testcase")]
    fn message_name(&self) -> &'static str {
        "SMSG_CHAR_ENUM"
    }

    #[cfg(feature = "print-testcase")]
    fn to_test_case_string(&self) -> Option<String> {
        use std::fmt::Write;
        use crate::traits::Message;

        let mut s = String::new();

        writeln!(s, "test SMSG_CHAR_ENUM {{").unwrap();
        // Members
        writeln!(s, "    amount_of_characters = {};", self.characters.len()).unwrap();
        writeln!(s, "    characters = [").unwrap();
        for v in self.characters.as_slice() {
            writeln!(s, "        {{").unwrap();
            // Members
            writeln!(s, "            guid = {};", v.guid.guid()).unwrap();
            writeln!(s, "            name = \"{}\";", v.name).unwrap();
            writeln!(s, "            race = {};", v.race.as_test_case_value()).unwrap();
            writeln!(s, "            class = {};", v.class.as_test_case_value()).unwrap();
            writeln!(s, "            gender = {};", v.gender.as_test_case_value()).unwrap();
            writeln!(s, "            skin = {};", v.skin).unwrap();
            writeln!(s, "            face = {};", v.face).unwrap();
            writeln!(s, "            hair_style = {};", v.hair_style).unwrap();
            writeln!(s, "            hair_color = {};", v.hair_color).unwrap();
            writeln!(s, "            facial_hair = {};", v.facial_hair).unwrap();
            writeln!(s, "            level = {};", v.level.as_int()).unwrap();
            writeln!(s, "            area = {};", v.area.as_test_case_value()).unwrap();
            writeln!(s, "            map = {};", v.map.as_test_case_value()).unwrap();
            // position: Vector3d
            writeln!(s, "            position = {{").unwrap();
            // Members
            writeln!(s, "                x = {};", if v.position.x.to_string().contains('.') { v.position.x.to_string() } else { format!("{}.0", v.position.x) }).unwrap();
            writeln!(s, "                y = {};", if v.position.y.to_string().contains('.') { v.position.y.to_string() } else { format!("{}.0", v.position.y) }).unwrap();
            writeln!(s, "                z = {};", if v.position.z.to_string().contains('.') { v.position.z.to_string() } else { format!("{}.0", v.position.z) }).unwrap();

            writeln!(s, "            }};").unwrap();
            writeln!(s, "            guild_id = {};", v.guild_id).unwrap();
            writeln!(s, "            flags = {};", v.flags).unwrap();
            writeln!(s, "            first_login = {};", if v.first_login { "TRUE" } else { "FALSE" }).unwrap();
            writeln!(s, "            pet_display_id = {};", v.pet_display_id).unwrap();
            writeln!(s, "            pet_level = {};", v.pet_level.as_int()).unwrap();
            writeln!(s, "            pet_family = {};", v.pet_family.as_test_case_value()).unwrap();
            writeln!(s, "            equipment = [").unwrap();
            for v in v.equipment.as_slice() {
                writeln!(s, "                {{").unwrap();
                // Members
                writeln!(s, "                    equipment_display_id = {};", v.equipment_display_id).unwrap();
                writeln!(s, "                    inventory_type = {};", v.inventory_type.as_test_case_value()).unwrap();
                writeln!(s, "                    enchantment = {};", v.enchantment).unwrap();

                writeln!(s, "                }},").unwrap();
            }
            writeln!(s, "            ];").unwrap();

            writeln!(s, "        }},").unwrap();
        }
        writeln!(s, "    ];").unwrap();

        writeln!(s, "}} [").unwrap();

        let [a, b] = (u16::try_from(self.size() + 2).unwrap()).to_be_bytes();
        writeln!(s, "    {a:#04X}, {b:#04X}, /* size */").unwrap();
        let [a, b] = 59_u16.to_le_bytes();
        writeln!(s, "    {a:#04X}, {b:#04X}, /* opcode */").unwrap();
        let mut bytes: Vec<u8> = Vec::new();
        self.write_into_vec(&mut bytes).unwrap();
        let mut bytes = bytes.into_iter();

        crate::util::write_bytes(&mut s, &mut bytes, 1, "amount_of_characters", "    ");
        if !self.characters.is_empty() {
            writeln!(s, "    /* characters: Character[amount_of_characters] start */").unwrap();
            for (i, v) in self.characters.iter().enumerate() {
                writeln!(s, "    /* characters: Character[amount_of_characters] {i} start */").unwrap();
                crate::util::write_bytes(&mut s, &mut bytes, 8, "guid", "        ");
                crate::util::write_bytes(&mut s, &mut bytes, v.name.len() + 1, "name", "        ");
                crate::util::write_bytes(&mut s, &mut bytes, 1, "race", "        ");
                crate::util::write_bytes(&mut s, &mut bytes, 1, "class", "        ");
                crate::util::write_bytes(&mut s, &mut bytes, 1, "gender", "        ");
                crate::util::write_bytes(&mut s, &mut bytes, 1, "skin", "        ");
                crate::util::write_bytes(&mut s, &mut bytes, 1, "face", "        ");
                crate::util::write_bytes(&mut s, &mut bytes, 1, "hair_style", "        ");
                crate::util::write_bytes(&mut s, &mut bytes, 1, "hair_color", "        ");
                crate::util::write_bytes(&mut s, &mut bytes, 1, "facial_hair", "        ");
                crate::util::write_bytes(&mut s, &mut bytes, 1, "level", "        ");
                crate::util::write_bytes(&mut s, &mut bytes, 4, "area", "        ");
                crate::util::write_bytes(&mut s, &mut bytes, 4, "map", "        ");
                writeln!(s, "    /* position: Vector3d start */").unwrap();
                crate::util::write_bytes(&mut s, &mut bytes, 4, "x", "            ");
                crate::util::write_bytes(&mut s, &mut bytes, 4, "y", "            ");
                crate::util::write_bytes(&mut s, &mut bytes, 4, "z", "            ");
                writeln!(s, "    /* position: Vector3d end */").unwrap();
                crate::util::write_bytes(&mut s, &mut bytes, 4, "guild_id", "        ");
                crate::util::write_bytes(&mut s, &mut bytes, 4, "flags", "        ");
                crate::util::write_bytes(&mut s, &mut bytes, 1, "first_login", "        ");
                crate::util::write_bytes(&mut s, &mut bytes, 4, "pet_display_id", "        ");
                crate::util::write_bytes(&mut s, &mut bytes, 4, "pet_level", "        ");
                crate::util::write_bytes(&mut s, &mut bytes, 4, "pet_family", "        ");
                writeln!(s, "    /* equipment: CharacterGear[20] start */").unwrap();
                for (i, v) in v.equipment.iter().enumerate() {
                    writeln!(s, "    /* equipment: CharacterGear[20] {i} start */").unwrap();
                    crate::util::write_bytes(&mut s, &mut bytes, 4, "equipment_display_id", "            ");
                    crate::util::write_bytes(&mut s, &mut bytes, 1, "inventory_type", "            ");
                    crate::util::write_bytes(&mut s, &mut bytes, 4, "enchantment", "            ");
                    writeln!(s, "    /* equipment: CharacterGear[20] {i} end */").unwrap();
                }
                writeln!(s, "    /* equipment: CharacterGear[20] end */").unwrap();
                writeln!(s, "    /* characters: Character[amount_of_characters] {i} end */").unwrap();
            }
            writeln!(s, "    /* characters: Character[amount_of_characters] end */").unwrap();
        }


        writeln!(s, "] {{").unwrap();
        writeln!(s, "    versions = \"{}\";", std::env::var("WOWM_TEST_CASE_WORLD_VERSION").unwrap_or("2.4.3".to_string())).unwrap();
        writeln!(s, "}}\n").unwrap();

        Some(s)
    }

    fn size_without_header(&self) -> u32 {
        self.size() as u32
    }

    fn write_into_vec(&self, mut w: impl Write) -> Result<(), std::io::Error> {
        // amount_of_characters: u8
        w.write_all(&(self.characters.len() as u8).to_le_bytes())?;

        // characters: Character[amount_of_characters]
        for i in self.characters.iter() {
            i.write_into_vec(&mut w)?;
        }

        Ok(())
    }

    fn read_body<S: crate::private::Sealed>(r: &mut &[u8], body_size: u32) -> Result<Self, crate::errors::ParseError> {
        Self::read_inner(r, body_size).map_err(|a| crate::errors::ParseError::new(59, "SMSG_CHAR_ENUM", body_size, a))
    }

}

#[cfg(feature = "tbc")]
impl crate::tbc::ServerMessage for SMSG_CHAR_ENUM {}

impl SMSG_CHAR_ENUM {
    pub(crate) fn size(&self) -> usize {
        1 // amount_of_characters: u8
        + self.characters.iter().fold(0, |acc, x| acc + x.size()) // characters: Character[amount_of_characters]
    }
}