libgm 0.6.0

A tool for unpacking and modding 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

use crate::prelude::*;
use crate::util::fmt::typename;
use crate::wad::elements::GMElement;
use crate::wad::serialize::builder::DataBuilder;
use crate::wad::version::ToGMVersion;

// The element fields store `Option<T>`, so passing `Option<&T>` instead
// of `&Option<T>` would require using `.as_ref()` in every call.
#[allow(clippy::ref_option)]
impl DataBuilder<'_> {
    #[inline]
    pub fn write_if_ver<T: GMElement>(
        &mut self,
        element: &Option<T>,
        field_name: &'static str,
        ver_req: impl ToGMVersion,
    ) -> Result<()> {
        let ver_req = ver_req.to_gm_version();
        if self.version() < ver_req {
            return Ok(()); // Don't serialize if version requirement not met
        }

        let element: &T = element.as_ref().ok_or_else(|| {
            format!(
                "Field {:?} ({}) needs to be set since GameMaker version {} (data version is {})",
                field_name,
                typename::<T>(),
                ver_req,
                self.gm_data.general_info.version,
            )
        })?;

        element.serialize(self)
    }

    #[inline]
    pub fn write_if_wad_ver<T: GMElement>(
        &mut self,
        element: &Option<T>,
        field_name: &'static str,
        ver_req: u8,
    ) -> Result<()> {
        if self.wad_version() < ver_req {
            return Ok(()); // Don't serialize if version requirement not met
        }

        let element: &T = element.as_ref().ok_or_else(|| {
            format!(
                "Field {:?} ({}) needs to be set since WAD version {} (data WAD version is {})",
                field_name,
                typename::<T>(),
                ver_req,
                self.gm_data.general_info.wad_version,
            )
        })?;

        element.serialize(self)
    }
}