wow_dbc 0.3.0

Library for parsing World of Warcraft DBC files for 1.12, 2.4.3 and 3.3.5.
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
use crate::{
    DbcTable, Indexable,
};
use crate::header::{
    DbcHeader, HEADER_SIZE, parse_header,
};
use crate::tbc_tables::footstep_terrain_lookup::FootstepTerrainLookupKey;
use crate::tbc_tables::sound_entries::SoundEntriesKey;
use std::io::Write;

#[derive(Debug, Clone, PartialEq, PartialOrd)]
pub struct CreatureSoundData {
    pub rows: Vec<CreatureSoundDataRow>,
}

impl DbcTable for CreatureSoundData {
    type Row = CreatureSoundDataRow;

    const FILENAME: &'static str = "CreatureSoundData.dbc";

    fn rows(&self) -> &[Self::Row] { &self.rows }
    fn rows_mut(&mut self) -> &mut [Self::Row] { &mut self.rows }

    fn read(b: &mut impl std::io::Read) -> Result<Self, crate::DbcError> {
        let mut header = [0_u8; HEADER_SIZE];
        b.read_exact(&mut header)?;
        let header = parse_header(&header)?;

        if header.record_size != 148 {
            return Err(crate::DbcError::InvalidHeader(
                crate::InvalidHeaderError::RecordSize {
                    expected: 148,
                    actual: header.record_size,
                },
            ));
        }

        if header.field_count != 37 {
            return Err(crate::DbcError::InvalidHeader(
                crate::InvalidHeaderError::FieldCount {
                    expected: 37,
                    actual: header.field_count,
                },
            ));
        }

        let mut r = vec![0_u8; (header.record_count * header.record_size) as usize];
        b.read_exact(&mut r)?;

        let mut rows = Vec::with_capacity(header.record_count as usize);

        for mut chunk in r.chunks(header.record_size as usize) {
            let chunk = &mut chunk;

            // id: primary_key (CreatureSoundData) int32
            let id = CreatureSoundDataKey::new(crate::util::read_i32_le(chunk)?);

            // sound_exertion_id: foreign_key (SoundEntries) int32
            let sound_exertion_id = SoundEntriesKey::new(crate::util::read_i32_le(chunk)?.into());

            // sound_exertion_critical_id: foreign_key (SoundEntries) int32
            let sound_exertion_critical_id = SoundEntriesKey::new(crate::util::read_i32_le(chunk)?.into());

            // sound_injury_id: foreign_key (SoundEntries) int32
            let sound_injury_id = SoundEntriesKey::new(crate::util::read_i32_le(chunk)?.into());

            // sound_injury_critical_id: foreign_key (SoundEntries) int32
            let sound_injury_critical_id = SoundEntriesKey::new(crate::util::read_i32_le(chunk)?.into());

            // sound_injury_crushing_blow_id: int32
            let sound_injury_crushing_blow_id = crate::util::read_i32_le(chunk)?;

            // sound_death_id: foreign_key (SoundEntries) int32
            let sound_death_id = SoundEntriesKey::new(crate::util::read_i32_le(chunk)?.into());

            // sound_stun_id: foreign_key (SoundEntries) int32
            let sound_stun_id = SoundEntriesKey::new(crate::util::read_i32_le(chunk)?.into());

            // sound_stand_id: foreign_key (SoundEntries) int32
            let sound_stand_id = SoundEntriesKey::new(crate::util::read_i32_le(chunk)?.into());

            // sound_footstep_id: foreign_key (FootstepTerrainLookup) int32
            let sound_footstep_id = FootstepTerrainLookupKey::new(crate::util::read_i32_le(chunk)?.into());

            // sound_aggro_id: foreign_key (SoundEntries) int32
            let sound_aggro_id = SoundEntriesKey::new(crate::util::read_i32_le(chunk)?.into());

            // sound_wing_flap_id: foreign_key (SoundEntries) int32
            let sound_wing_flap_id = SoundEntriesKey::new(crate::util::read_i32_le(chunk)?.into());

            // sound_wing_glide_id: foreign_key (SoundEntries) int32
            let sound_wing_glide_id = SoundEntriesKey::new(crate::util::read_i32_le(chunk)?.into());

            // sound_alert_id: foreign_key (SoundEntries) int32
            let sound_alert_id = SoundEntriesKey::new(crate::util::read_i32_le(chunk)?.into());

            // sound_fidget: int32[5]
            let sound_fidget = crate::util::read_array_i32::<5>(chunk)?;

            // custom_attack: int32[4]
            let custom_attack = crate::util::read_array_i32::<4>(chunk)?;

            // n_p_c_sound_id: int32
            let n_p_c_sound_id = crate::util::read_i32_le(chunk)?;

            // loop_sound_id: foreign_key (SoundEntries) int32
            let loop_sound_id = SoundEntriesKey::new(crate::util::read_i32_le(chunk)?.into());

            // creature_impact_type: int32
            let creature_impact_type = crate::util::read_i32_le(chunk)?;

            // sound_jump_start_id: foreign_key (SoundEntries) int32
            let sound_jump_start_id = SoundEntriesKey::new(crate::util::read_i32_le(chunk)?.into());

            // sound_jump_end_id: foreign_key (SoundEntries) int32
            let sound_jump_end_id = SoundEntriesKey::new(crate::util::read_i32_le(chunk)?.into());

            // sound_pet_attack_id: foreign_key (SoundEntries) int32
            let sound_pet_attack_id = SoundEntriesKey::new(crate::util::read_i32_le(chunk)?.into());

            // sound_pet_order_id: foreign_key (SoundEntries) int32
            let sound_pet_order_id = SoundEntriesKey::new(crate::util::read_i32_le(chunk)?.into());

            // sound_pet_dismiss_id: foreign_key (SoundEntries) int32
            let sound_pet_dismiss_id = SoundEntriesKey::new(crate::util::read_i32_le(chunk)?.into());

            // fidget_delay_seconds_min: float
            let fidget_delay_seconds_min = crate::util::read_f32_le(chunk)?;

            // fidget_delay_seconds_max: float
            let fidget_delay_seconds_max = crate::util::read_f32_le(chunk)?;

            // birth_sound_id: foreign_key (SoundEntries) int32
            let birth_sound_id = SoundEntriesKey::new(crate::util::read_i32_le(chunk)?.into());

            // spell_cast_directed_sound_id: foreign_key (SoundEntries) int32
            let spell_cast_directed_sound_id = SoundEntriesKey::new(crate::util::read_i32_le(chunk)?.into());

            // submerge_sound_id: foreign_key (SoundEntries) int32
            let submerge_sound_id = SoundEntriesKey::new(crate::util::read_i32_le(chunk)?.into());

            // submerged_sound_id: foreign_key (SoundEntries) int32
            let submerged_sound_id = SoundEntriesKey::new(crate::util::read_i32_le(chunk)?.into());


            rows.push(CreatureSoundDataRow {
                id,
                sound_exertion_id,
                sound_exertion_critical_id,
                sound_injury_id,
                sound_injury_critical_id,
                sound_injury_crushing_blow_id,
                sound_death_id,
                sound_stun_id,
                sound_stand_id,
                sound_footstep_id,
                sound_aggro_id,
                sound_wing_flap_id,
                sound_wing_glide_id,
                sound_alert_id,
                sound_fidget,
                custom_attack,
                n_p_c_sound_id,
                loop_sound_id,
                creature_impact_type,
                sound_jump_start_id,
                sound_jump_end_id,
                sound_pet_attack_id,
                sound_pet_order_id,
                sound_pet_dismiss_id,
                fidget_delay_seconds_min,
                fidget_delay_seconds_max,
                birth_sound_id,
                spell_cast_directed_sound_id,
                submerge_sound_id,
                submerged_sound_id,
            });
        }

        Ok(CreatureSoundData { rows, })
    }

    fn write(&self, b: &mut impl Write) -> Result<(), std::io::Error> {
        let header = DbcHeader {
            record_count: self.rows.len() as u32,
            field_count: 37,
            record_size: 148,
            string_block_size: 1,
        };

        b.write_all(&header.write_header())?;

        for row in &self.rows {
            // id: primary_key (CreatureSoundData) int32
            b.write_all(&row.id.id.to_le_bytes())?;

            // sound_exertion_id: foreign_key (SoundEntries) int32
            b.write_all(&(row.sound_exertion_id.id as i32).to_le_bytes())?;

            // sound_exertion_critical_id: foreign_key (SoundEntries) int32
            b.write_all(&(row.sound_exertion_critical_id.id as i32).to_le_bytes())?;

            // sound_injury_id: foreign_key (SoundEntries) int32
            b.write_all(&(row.sound_injury_id.id as i32).to_le_bytes())?;

            // sound_injury_critical_id: foreign_key (SoundEntries) int32
            b.write_all(&(row.sound_injury_critical_id.id as i32).to_le_bytes())?;

            // sound_injury_crushing_blow_id: int32
            b.write_all(&row.sound_injury_crushing_blow_id.to_le_bytes())?;

            // sound_death_id: foreign_key (SoundEntries) int32
            b.write_all(&(row.sound_death_id.id as i32).to_le_bytes())?;

            // sound_stun_id: foreign_key (SoundEntries) int32
            b.write_all(&(row.sound_stun_id.id as i32).to_le_bytes())?;

            // sound_stand_id: foreign_key (SoundEntries) int32
            b.write_all(&(row.sound_stand_id.id as i32).to_le_bytes())?;

            // sound_footstep_id: foreign_key (FootstepTerrainLookup) int32
            b.write_all(&(row.sound_footstep_id.id as i32).to_le_bytes())?;

            // sound_aggro_id: foreign_key (SoundEntries) int32
            b.write_all(&(row.sound_aggro_id.id as i32).to_le_bytes())?;

            // sound_wing_flap_id: foreign_key (SoundEntries) int32
            b.write_all(&(row.sound_wing_flap_id.id as i32).to_le_bytes())?;

            // sound_wing_glide_id: foreign_key (SoundEntries) int32
            b.write_all(&(row.sound_wing_glide_id.id as i32).to_le_bytes())?;

            // sound_alert_id: foreign_key (SoundEntries) int32
            b.write_all(&(row.sound_alert_id.id as i32).to_le_bytes())?;

            // sound_fidget: int32[5]
            for i in row.sound_fidget {
                b.write_all(&i.to_le_bytes())?;
            }


            // custom_attack: int32[4]
            for i in row.custom_attack {
                b.write_all(&i.to_le_bytes())?;
            }


            // n_p_c_sound_id: int32
            b.write_all(&row.n_p_c_sound_id.to_le_bytes())?;

            // loop_sound_id: foreign_key (SoundEntries) int32
            b.write_all(&(row.loop_sound_id.id as i32).to_le_bytes())?;

            // creature_impact_type: int32
            b.write_all(&row.creature_impact_type.to_le_bytes())?;

            // sound_jump_start_id: foreign_key (SoundEntries) int32
            b.write_all(&(row.sound_jump_start_id.id as i32).to_le_bytes())?;

            // sound_jump_end_id: foreign_key (SoundEntries) int32
            b.write_all(&(row.sound_jump_end_id.id as i32).to_le_bytes())?;

            // sound_pet_attack_id: foreign_key (SoundEntries) int32
            b.write_all(&(row.sound_pet_attack_id.id as i32).to_le_bytes())?;

            // sound_pet_order_id: foreign_key (SoundEntries) int32
            b.write_all(&(row.sound_pet_order_id.id as i32).to_le_bytes())?;

            // sound_pet_dismiss_id: foreign_key (SoundEntries) int32
            b.write_all(&(row.sound_pet_dismiss_id.id as i32).to_le_bytes())?;

            // fidget_delay_seconds_min: float
            b.write_all(&row.fidget_delay_seconds_min.to_le_bytes())?;

            // fidget_delay_seconds_max: float
            b.write_all(&row.fidget_delay_seconds_max.to_le_bytes())?;

            // birth_sound_id: foreign_key (SoundEntries) int32
            b.write_all(&(row.birth_sound_id.id as i32).to_le_bytes())?;

            // spell_cast_directed_sound_id: foreign_key (SoundEntries) int32
            b.write_all(&(row.spell_cast_directed_sound_id.id as i32).to_le_bytes())?;

            // submerge_sound_id: foreign_key (SoundEntries) int32
            b.write_all(&(row.submerge_sound_id.id as i32).to_le_bytes())?;

            // submerged_sound_id: foreign_key (SoundEntries) int32
            b.write_all(&(row.submerged_sound_id.id as i32).to_le_bytes())?;

        }

        b.write_all(&[0_u8])?;

        Ok(())
    }

}

impl Indexable for CreatureSoundData {
    type PrimaryKey = CreatureSoundDataKey;
    fn get(&self, key: impl TryInto<Self::PrimaryKey>) -> Option<&Self::Row> {
        let key = key.try_into().ok()?;
        self.rows.iter().find(|a| a.id.id == key.id)
    }

    fn get_mut(&mut self, key: impl TryInto<Self::PrimaryKey>) -> Option<&mut Self::Row> {
        let key = key.try_into().ok()?;
        self.rows.iter_mut().find(|a| a.id.id == key.id)
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Ord, PartialOrd, Hash, Default)]
pub struct CreatureSoundDataKey {
    pub id: i32
}

impl CreatureSoundDataKey {
    pub const fn new(id: i32) -> Self {
        Self { id }
    }

}

impl From<u8> for CreatureSoundDataKey {
    fn from(v: u8) -> Self {
        Self::new(v.into())
    }
}

impl From<u16> for CreatureSoundDataKey {
    fn from(v: u16) -> Self {
        Self::new(v.into())
    }
}

impl From<i8> for CreatureSoundDataKey {
    fn from(v: i8) -> Self {
        Self::new(v.into())
    }
}

impl From<i16> for CreatureSoundDataKey {
    fn from(v: i16) -> Self {
        Self::new(v.into())
    }
}

impl From<i32> for CreatureSoundDataKey {
    fn from(v: i32) -> Self {
        Self::new(v)
    }
}

impl TryFrom<u32> for CreatureSoundDataKey {
    type Error = u32;
    fn try_from(v: u32) -> Result<Self, Self::Error> {
        Ok(TryInto::<i32>::try_into(v).ok().ok_or(v)?.into())
    }
}

impl TryFrom<usize> for CreatureSoundDataKey {
    type Error = usize;
    fn try_from(v: usize) -> Result<Self, Self::Error> {
        Ok(TryInto::<i32>::try_into(v).ok().ok_or(v)?.into())
    }
}

impl TryFrom<u64> for CreatureSoundDataKey {
    type Error = u64;
    fn try_from(v: u64) -> Result<Self, Self::Error> {
        Ok(TryInto::<i32>::try_into(v).ok().ok_or(v)?.into())
    }
}

impl TryFrom<i64> for CreatureSoundDataKey {
    type Error = i64;
    fn try_from(v: i64) -> Result<Self, Self::Error> {
        Ok(TryInto::<i32>::try_into(v).ok().ok_or(v)?.into())
    }
}

impl TryFrom<isize> for CreatureSoundDataKey {
    type Error = isize;
    fn try_from(v: isize) -> Result<Self, Self::Error> {
        Ok(TryInto::<i32>::try_into(v).ok().ok_or(v)?.into())
    }
}

#[derive(Debug, Clone, Copy, PartialEq, PartialOrd)]
pub struct CreatureSoundDataRow {
    pub id: CreatureSoundDataKey,
    pub sound_exertion_id: SoundEntriesKey,
    pub sound_exertion_critical_id: SoundEntriesKey,
    pub sound_injury_id: SoundEntriesKey,
    pub sound_injury_critical_id: SoundEntriesKey,
    pub sound_injury_crushing_blow_id: i32,
    pub sound_death_id: SoundEntriesKey,
    pub sound_stun_id: SoundEntriesKey,
    pub sound_stand_id: SoundEntriesKey,
    pub sound_footstep_id: FootstepTerrainLookupKey,
    pub sound_aggro_id: SoundEntriesKey,
    pub sound_wing_flap_id: SoundEntriesKey,
    pub sound_wing_glide_id: SoundEntriesKey,
    pub sound_alert_id: SoundEntriesKey,
    pub sound_fidget: [i32; 5],
    pub custom_attack: [i32; 4],
    pub n_p_c_sound_id: i32,
    pub loop_sound_id: SoundEntriesKey,
    pub creature_impact_type: i32,
    pub sound_jump_start_id: SoundEntriesKey,
    pub sound_jump_end_id: SoundEntriesKey,
    pub sound_pet_attack_id: SoundEntriesKey,
    pub sound_pet_order_id: SoundEntriesKey,
    pub sound_pet_dismiss_id: SoundEntriesKey,
    pub fidget_delay_seconds_min: f32,
    pub fidget_delay_seconds_max: f32,
    pub birth_sound_id: SoundEntriesKey,
    pub spell_cast_directed_sound_id: SoundEntriesKey,
    pub submerge_sound_id: SoundEntriesKey,
    pub submerged_sound_id: SoundEntriesKey,
}