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
use crate::{
    DbcTable, Indexable,
};
use crate::header::{
    DbcHeader, HEADER_SIZE, parse_header,
};
use crate::wrath_tables::sound_entries::SoundEntriesKey;
use crate::wrath_tables::spell_visual_kit::SpellVisualKitKey;
use std::io::Write;

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

impl DbcTable for SpellVisual {
    type Row = SpellVisualRow;

    const FILENAME: &'static str = "SpellVisual.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 != 128 {
            return Err(crate::DbcError::InvalidHeader(
                crate::InvalidHeaderError::RecordSize {
                    expected: 128,
                    actual: header.record_size,
                },
            ));
        }

        if header.field_count != 32 {
            return Err(crate::DbcError::InvalidHeader(
                crate::InvalidHeaderError::FieldCount {
                    expected: 32,
                    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 (SpellVisual) int32
            let id = SpellVisualKey::new(crate::util::read_i32_le(chunk)?);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

            // missile_targeting_kit: foreign_key (SpellVisualKit) int32
            let missile_targeting_kit = SpellVisualKitKey::new(crate::util::read_i32_le(chunk)?.into());

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

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

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

            // missile_cast_offset: float[3]
            let missile_cast_offset = crate::util::read_array_f32::<3>(chunk)?;

            // missile_impact_offset: float[3]
            let missile_impact_offset = crate::util::read_array_f32::<3>(chunk)?;


            rows.push(SpellVisualRow {
                id,
                precast_kit,
                cast_kit,
                impact_kit,
                state_kit,
                state_done_kit,
                channel_kit,
                has_missile,
                missile_model,
                missile_path_type,
                missile_destination_attachment,
                missile_sound,
                anim_event_sound_id,
                flags,
                caster_impact_kit,
                target_impact_kit,
                missile_attachment,
                missile_follow_ground_height,
                missile_follow_ground_drop_speed,
                missile_follow_ground_approach,
                missile_follow_ground_flags,
                missile_motion,
                missile_targeting_kit,
                instant_area_kit,
                impact_area_kit,
                persistent_area_kit,
                missile_cast_offset,
                missile_impact_offset,
            });
        }

        Ok(SpellVisual { rows, })
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

            // missile_cast_offset: float[3]
            for i in row.missile_cast_offset {
                b.write_all(&i.to_le_bytes())?;
            }


            // missile_impact_offset: float[3]
            for i in row.missile_impact_offset {
                b.write_all(&i.to_le_bytes())?;
            }


        }

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

        Ok(())
    }

}

impl Indexable for SpellVisual {
    type PrimaryKey = SpellVisualKey;
    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 SpellVisualKey {
    pub id: i32
}

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

}

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

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

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

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

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

impl TryFrom<u32> for SpellVisualKey {
    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 SpellVisualKey {
    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 SpellVisualKey {
    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 SpellVisualKey {
    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 SpellVisualKey {
    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 SpellVisualRow {
    pub id: SpellVisualKey,
    pub precast_kit: i32,
    pub cast_kit: i32,
    pub impact_kit: i32,
    pub state_kit: i32,
    pub state_done_kit: i32,
    pub channel_kit: i32,
    pub has_missile: i32,
    pub missile_model: i32,
    pub missile_path_type: i32,
    pub missile_destination_attachment: i32,
    pub missile_sound: i32,
    pub anim_event_sound_id: SoundEntriesKey,
    pub flags: i32,
    pub caster_impact_kit: i32,
    pub target_impact_kit: i32,
    pub missile_attachment: i32,
    pub missile_follow_ground_height: i32,
    pub missile_follow_ground_drop_speed: i32,
    pub missile_follow_ground_approach: i32,
    pub missile_follow_ground_flags: i32,
    pub missile_motion: i32,
    pub missile_targeting_kit: SpellVisualKitKey,
    pub instant_area_kit: i32,
    pub impact_area_kit: i32,
    pub persistent_area_kit: i32,
    pub missile_cast_offset: [f32; 3],
    pub missile_impact_offset: [f32; 3],
}