libgm 0.5.0

A tool for modding, unpacking and decompiling GameMaker games
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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
use macros::named_list_chunk;
use macros::num_enum;

use crate::prelude::*;
use crate::util::init::num_enum_from;
use crate::wad::deserialize::reader::DataReader;
use crate::wad::elements::GMElement;
use crate::wad::elements::sprite::GMSprite;
use crate::wad::reference::GMRef;
use crate::wad::serialize::builder::DataBuilder;

#[named_list_chunk("PSEM")]
pub struct GMParticleEmitters {
    pub emitters: Vec<GMParticleEmitter>,
    pub exists: bool,
}

impl GMElement for GMParticleEmitters {
    fn deserialize(reader: &mut DataReader) -> Result<Self> {
        if reader.chunk.length() > 8 {
            log::warn!("Particle emitters are not tested");
        }
        reader.align(4)?;
        reader.read_gms2_chunk_version("PSEM Version")?;
        let emitters: Vec<GMParticleEmitter> = reader.read_pointer_list()?;
        Ok(Self { emitters, exists: true })
    }

    fn serialize(&self, builder: &mut DataBuilder) -> Result<()> {
        builder.align(4);
        builder.write_u32(1); // PSEM Version
        builder.write_pointer_list(&self.emitters)?;
        Ok(())
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct GMParticleEmitter {
    pub name: String,
    pub enabled: bool,
    pub mode: EmitMode,
    pub emit_count: u32,

    /// This field is probably gonna be renamed
    pub size_data_etc: SizeDataEtc,

    pub distribution: EmitterDistribution,
    pub shape: EmitterShape,
    pub region_x: f32,
    pub region_y: f32,
    pub region_w: f32,
    pub region_h: f32,
    pub rotation: f32,
    pub sprite: Option<GMRef<GMSprite>>,
    pub texture: EmitterTexture,
    pub frame_index: f32,
    pub data_2023_4: Option<Data2023_4>,
    pub start_color: u32,
    pub mid_color: u32,
    pub end_color: u32,
    pub additive_blend: bool,
    pub lifetime_min: f32,
    pub lifetime_max: f32,
    pub scale_x: f32,
    pub scale_y: f32,
    pub speed_min: f32,
    pub speed_max: f32,
    pub speed_increase: f32,
    pub speed_wiggle: f32,
    pub gravity_force: f32,
    pub gravity_direction: f32,
    pub direction_min: f32,
    pub direction_max: f32,
    pub direction_increase: f32,
    pub direction_wiggle: f32,
    pub orientation_min: f32,
    pub orientation_max: f32,
    pub orientation_increase: f32,
    pub orientation_wiggle: f32,
    pub orientation_relative: bool,
    pub spawn_on_death: Option<GMRef<Self>>,
    pub spawn_on_death_count: u32,
    pub spawn_on_update: Option<GMRef<Self>>,
    pub spawn_on_update_count: u32,
}

impl GMElement for GMParticleEmitter {
    #[allow(clippy::too_many_lines)]
    fn deserialize(reader: &mut DataReader) -> Result<Self> {
        let name: String = reader.read_gm_string()?;
        let enabled: bool = if reader.general_info.is_version_at_least((2023, 6)) {
            reader.read_bool32()?
        } else {
            true
        };
        let mode: EmitMode = num_enum_from(reader.read_i32()?)?;

        let emit_count: u32;
        let data_2023_8: Option<Data2023_8> = if reader.general_info.is_version_at_least((2023, 8))
        {
            // For some reason, it's stored as a float here???
            // You could add extra validation here
            // (like disallowing NaN, Infinity, fractional numbers, negative numbers)
            emit_count = reader.read_f32()? as u32;
            let emit_relative = reader.read_bool32()?;
            reader.assert_bool(emit_relative, false, "Emit Relative")?;
            let delay_min = reader.read_f32()?;
            let delay_max = reader.read_f32()?;
            let delay_unit: TimeUnit = num_enum_from(reader.read_i32()?)?;
            let interval_min = reader.read_f32()?;
            let interval_max = reader.read_f32()?;
            let interval_unit: TimeUnit = num_enum_from(reader.read_i32()?)?;

            Some(Data2023_8 {
                emit_relative,
                delay_min,
                delay_max,
                delay_unit,
                interval_min,
                interval_max,
                interval_unit,
                ..Default::default() // will be populated later
            })
        } else {
            emit_count = reader.read_u32()?;
            None
        };

        let distribution: EmitterDistribution = num_enum_from(reader.read_i32()?)?;
        let shape: EmitterShape = num_enum_from(reader.read_i32()?)?;
        let region_x = reader.read_f32()?;
        let region_y = reader.read_f32()?;
        let region_w = reader.read_f32()?;
        let region_h = reader.read_f32()?;
        let rotation = reader.read_f32()?;
        let sprite: Option<GMRef<GMSprite>> = reader.read_resource_by_id_opt()?;
        let texture: EmitterTexture = num_enum_from(reader.read_i32()?)?;
        let frame_index = reader.read_f32()?;
        let data_2023_4: Option<Data2023_4> = reader.deserialize_if_gm_version((2023, 4))?;
        let start_color = reader.read_u32()?;
        let mid_color = reader.read_u32()?;
        let end_color = reader.read_u32()?;
        let additive_blend = reader.read_bool32()?;
        let lifetime_min = reader.read_f32()?;
        let lifetime_max = reader.read_f32()?;
        let scale_x = reader.read_f32()?;
        let scale_y = reader.read_f32()?;

        let size_data_etc: SizeDataEtc = if reader.general_info.is_version_at_least((2023, 8)) {
            let mut data = data_2023_8.unwrap();
            data.size_min_x = reader.read_f32()?;
            data.size_max_x = reader.read_f32()?;
            data.size_min_y = reader.read_f32()?;
            data.size_max_y = reader.read_f32()?;
            data.size_increase_x = reader.read_f32()?;
            data.size_increase_y = reader.read_f32()?;
            data.size_wiggle_x = reader.read_f32()?;
            data.size_wiggle_y = reader.read_f32()?;
            SizeDataEtc::Post2023_8(data)
        } else {
            let size_min = reader.read_f32()?;
            let size_max = reader.read_f32()?;
            let size_increase = reader.read_f32()?;
            let size_wiggle = reader.read_f32()?;
            let data = DataPre2023_8 {
                size_min,
                size_max,
                size_increase,
                size_wiggle,
            };
            SizeDataEtc::Pre2023_8(data)
        };

        let speed_min = reader.read_f32()?;
        let speed_max = reader.read_f32()?;
        let speed_increase = reader.read_f32()?;
        let speed_wiggle = reader.read_f32()?;
        let gravity_force = reader.read_f32()?;
        let gravity_direction = reader.read_f32()?;
        let direction_min = reader.read_f32()?;
        let direction_max = reader.read_f32()?;
        let direction_increase = reader.read_f32()?;
        let direction_wiggle = reader.read_f32()?;
        let orientation_min = reader.read_f32()?;
        let orientation_max = reader.read_f32()?;
        let orientation_increase = reader.read_f32()?;
        let orientation_wiggle = reader.read_f32()?;
        let orientation_relative = reader.read_bool32()?;

        let spawn_on_death: Option<GMRef<Self>> = reader.read_resource_by_id_opt()?;
        let spawn_on_death_count = reader.read_u32()?;
        let spawn_on_update: Option<GMRef<Self>> = reader.read_resource_by_id_opt()?;
        let spawn_on_update_count = reader.read_u32()?;

        Ok(Self {
            name,
            enabled,
            mode,
            emit_count,
            size_data_etc,
            distribution,
            shape,
            region_x,
            region_y,
            region_w,
            region_h,
            rotation,
            sprite,
            texture,
            frame_index,
            data_2023_4,
            start_color,
            mid_color,
            end_color,
            additive_blend,
            lifetime_min,
            lifetime_max,
            scale_x,
            scale_y,
            speed_min,
            speed_max,
            speed_increase,
            speed_wiggle,
            gravity_force,
            gravity_direction,
            direction_min,
            direction_max,
            direction_increase,
            direction_wiggle,
            orientation_min,
            orientation_max,
            orientation_increase,
            orientation_wiggle,
            orientation_relative,
            spawn_on_death,
            spawn_on_death_count,
            spawn_on_update,
            spawn_on_update_count,
        })
    }

    fn serialize(&self, builder: &mut DataBuilder) -> Result<()> {
        builder.write_gm_string(&self.name);
        if builder.is_version_at_least((2023, 6)) {
            builder.write_bool32(self.enabled);
        } else if !self.enabled {
            log::warn!("Cannot disable particle emitters before 2023.6");
        }

        if builder.is_version_at_least((2023, 8)) {
            let SizeDataEtc::Post2023_8(data) = &self.size_data_etc else {
                bail!("Expected >= 2023.8 data, got < 2023.8 data");
            };

            // Lmao, even clippy says storing natural numbers as floats is dumb.
            // What am I supposed to do, though? I'm just the janitor.
            #[allow(clippy::cast_precision_loss)]
            builder.write_f32(self.emit_count as f32);

            builder.write_bool32(data.emit_relative);
            builder.write_f32(data.delay_min);
            builder.write_f32(data.delay_max);
            builder.write_i32(data.delay_unit.into());
            builder.write_f32(data.interval_min);
            builder.write_f32(data.interval_max);
            builder.write_i32(data.interval_unit.into());
        } else {
            builder.write_u32(self.emit_count);
        }

        builder.write_i32(self.distribution.into());
        builder.write_i32(self.shape.into());
        builder.write_f32(self.region_x);
        builder.write_f32(self.region_y);
        builder.write_f32(self.region_w);
        builder.write_f32(self.region_h);
        builder.write_f32(self.rotation);
        builder.write_resource_id_opt(self.sprite);
        builder.write_i32(self.texture.into());
        builder.write_f32(self.frame_index);
        builder.write_if_ver(&self.data_2023_4, "2023.4 data", (2023, 4))?;
        builder.write_u32(self.start_color);
        builder.write_u32(self.mid_color);
        builder.write_u32(self.end_color);
        builder.write_bool32(self.additive_blend);
        builder.write_f32(self.lifetime_min);
        builder.write_f32(self.lifetime_max);
        builder.write_f32(self.scale_x);
        builder.write_f32(self.scale_y);
        if builder.is_version_at_least((2023, 8)) {
            let SizeDataEtc::Post2023_8(data) = &self.size_data_etc else {
                bail!("Expected >= 2023.8 data, got < 2023.8 data");
            };
            builder.write_f32(data.size_min_x);
            builder.write_f32(data.size_max_x);
            builder.write_f32(data.size_min_y);
            builder.write_f32(data.size_max_y);
            builder.write_f32(data.size_increase_x);
            builder.write_f32(data.size_increase_y);
            builder.write_f32(data.size_wiggle_x);
            builder.write_f32(data.size_wiggle_y);
        } else {
            let SizeDataEtc::Pre2023_8(data) = &self.size_data_etc else {
                bail!("Expected < 2023.8 data, got >= 2023.8 data");
            };
            builder.write_f32(data.size_min);
            builder.write_f32(data.size_max);
            builder.write_f32(data.size_increase);
            builder.write_f32(data.size_wiggle);
        }
        builder.write_f32(self.speed_min);
        builder.write_f32(self.speed_max);
        builder.write_f32(self.speed_increase);
        builder.write_f32(self.speed_wiggle);
        builder.write_f32(self.gravity_force);
        builder.write_f32(self.gravity_direction);
        builder.write_f32(self.direction_min);
        builder.write_f32(self.direction_max);
        builder.write_f32(self.direction_increase);
        builder.write_f32(self.direction_wiggle);
        builder.write_f32(self.orientation_min);
        builder.write_f32(self.orientation_max);
        builder.write_f32(self.orientation_increase);
        builder.write_f32(self.orientation_wiggle);
        builder.write_bool32(self.orientation_relative);
        builder.write_resource_id_opt(self.spawn_on_death);
        builder.write_u32(self.spawn_on_death_count);
        builder.write_resource_id_opt(self.spawn_on_update);
        builder.write_u32(self.spawn_on_update_count);
        Ok(())
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Data2023_4 {
    pub animate: bool,
    pub stretch: bool,
    pub is_random: bool,
}

impl GMElement for Data2023_4 {
    fn deserialize(reader: &mut DataReader) -> Result<Self> {
        let animate = reader.read_bool32()?;
        let stretch = reader.read_bool32()?;
        let is_random = reader.read_bool32()?;
        Ok(Self { animate, stretch, is_random })
    }

    fn serialize(&self, builder: &mut DataBuilder) -> Result<()> {
        builder.write_bool32(self.animate);
        builder.write_bool32(self.stretch);
        builder.write_bool32(self.is_random);
        Ok(())
    }
}

#[derive(Debug, Clone, PartialEq)]
/// This type will probably be renamed
pub enum SizeDataEtc {
    Pre2023_8(DataPre2023_8),
    Post2023_8(Data2023_8),
}

#[derive(Debug, Clone, PartialEq, Default)]
pub struct Data2023_8 {
    pub emit_relative: bool,
    pub delay_min: f32,
    pub delay_max: f32,
    pub delay_unit: TimeUnit,
    pub interval_min: f32,
    pub interval_max: f32,
    pub interval_unit: TimeUnit,
    pub size_min_x: f32,
    pub size_max_x: f32,
    pub size_min_y: f32,
    pub size_max_y: f32,
    pub size_increase_x: f32,
    pub size_increase_y: f32,
    pub size_wiggle_x: f32,
    pub size_wiggle_y: f32,
}

#[derive(Debug, Clone, PartialEq)]
pub struct DataPre2023_8 {
    pub size_min: f32,
    pub size_max: f32,
    pub size_increase: f32,
    pub size_wiggle: f32,
}

#[num_enum(i32)]
pub enum EmitMode {
    Stream = 0,
    Burst = 1,
}

#[num_enum(i32)]
#[derive(Default)]
pub enum TimeUnit {
    #[default]
    // no sensible reason to set this as default,
    // i just want `..Default::default()` to work ffs
    Seconds = 0,
    Frames = 1,
}

#[num_enum(i32)]
pub enum EmitterDistribution {
    Linear = 0,
    Gaussian = 1,
    InverseGaussian = 2,
}

#[num_enum(i32)]
pub enum EmitterShape {
    Rectangle = 0,
    Ellipse = 1,
    Diamond = 2,
    Line = 3,
}

#[num_enum(i32)]
pub enum EmitterTexture {
    None = -1,
    Pixel = 0,
    Disk = 1,
    Square = 2,
    Line = 3,
    Star = 4,
    Circle = 5,
    Ring = 6,
    Sphere = 7,
    Flare = 8,
    Spark = 9,
    Explosion = 10,
    Cloud = 11,
    Smoke = 12,
    Snow = 13,
}