enshwick 1.0.0-alpha.11

The Enshwick Loader's modding API for Enshrouded: the one crate mods are written against
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

//! A mod's optional features: one that turns off on this game build leaves
//! the mod and its other features running, and the loader learns which and
//! why.

#[cfg(test)]
mod tests {
    use enshwick::abi::Status;
    use enshwick::{Load, Mod, Off};

    struct Lanterns;

    impl Mod for Lanterns {
        fn manifest() -> &'static enshwick::abi::Manifest {
            enshwick::manifest!(id: "you.lanterns", side: SERVER)
        }

        fn init(load: &mut Load<'_>) -> Result<Self, Off> {
            let _texts = load.texts(TEXTS)?;
            let glow = load.feature("glow", |load| load.symbol("lantern.glow"));
            assert_eq!(glow, None);
            let light = load.feature("light", |load| load.symbol("lantern.light"));
            assert_eq!(light, Some(0x1_4000_2000));
            let flicker = load.feature("flicker", |load| {
                load.symbol("lantern.flicker")
                    .map_err(|_| Off::text("flicker.off", &[("symbol", "lantern.flicker")]))
            });
            assert_eq!(flicker, None);
            Ok(Self)
        }
    }

    const TEXTS: &str = "[en]\n\"flicker.off\" = \"No flicker: {symbol} is missing.\"\n\
                         [uk]\n\"flicker.off\" = \"Без мерехтіння: бракує {symbol}.\"\n";

    enshwick::declare_mod!(Lanterns);

    #[test]
    fn a_feature_that_turns_off_leaves_the_mod_running_and_says_why() {
        let loader = enshwick::test::FakeHost::new()
            .symbol("lantern.light", 0x1_4000_2000)
            .install();
        // SAFETY: the exports of `declare_mod!` above.
        let status = unsafe { loader.start(enshwick_mod_init, enshwick_mod_ready) };
        assert_eq!(status, Status::OK);
        let features = loader.features();
        assert_eq!(
            features[..2],
            [
                (
                    "glow".to_owned(),
                    Some("symbol lantern.glow: missing on this game build".to_owned())
                ),
                ("light".to_owned(), None),
            ]
        );
        let (name, sent) = &features[2];
        assert_eq!(name, "flicker");
        let sent = sent.as_deref().unwrap_or_default();
        let texts = enshwick::i18n::Texts::parse(&loader.published_texts().unwrap_or_default())
            .unwrap_or_default();
        assert_eq!(
            texts
                .reason(sent, enshwick::i18n::Language::UK_UA)
                .as_deref(),
            Some("Без мерехтіння: бракує lantern.flicker.")
        );
        assert_eq!(
            texts
                .reason(sent, enshwick::i18n::Language::FALLBACK)
                .as_deref(),
            Some("No flicker: lantern.flicker is missing.")
        );
    }
}