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

//! A mod declares changes at init and sets their values later.

#[cfg(test)]
mod tests {
    use enshwick::abi::Status;
    use enshwick::content::Guid;
    use enshwick::content::changes::{ChangeHandle, Field, Items, Target, Value};
    use enshwick::state::ModLocal;
    use enshwick::test::FakeHost;

    const WOOD: Guid = Guid::parse("3f4093ae-75ed-4e5d-bd0b-784ba83b88f5");

    static STACKS: ModLocal<ChangeHandle> = ModLocal::new();

    struct Stacks;

    impl enshwick::Mod for Stacks {
        fn manifest() -> &'static enshwick::abi::Manifest {
            enshwick::manifest!(id: "you.stacks", side: BOTH, join: true)
        }

        fn init(load: &mut enshwick::Load<'_>) -> Result<Self, enshwick::Off> {
            let stacks = load.declare_change(
                Target::Items(Items::Stackable),
                Field::MaxStackSize,
                "stacks",
            )?;
            let _set = STACKS.set(stacks);
            load.declare_change(Target::Entry(WOOD), Field::MaxStackSize, "wood")?;
            if load
                .declare_change(Target::Entry(WOOD), Field::Ingredient, "x")
                .is_ok()
            {
                return Err(enshwick::Off::new("an ingredient took"));
            }
            Ok(Self)
        }
    }

    enshwick::declare_mod!(Stacks);

    #[test]
    fn a_change_holds_no_value_until_set_and_takes_each_set_and_reset() {
        let loader = FakeHost::new().install();
        // SAFETY: `enshwick_mod_init` is the export of this file's `declare_mod!(Stacks)`.
        assert_eq!(unsafe { loader.init(enshwick_mod_init) }, Status::OK);
        let live = loader.live_changes();
        assert_eq!(live.len(), 2);
        assert_eq!(live[0].target, Target::Items(Items::Stackable));
        assert_eq!(live[1].target, Target::Entry(WOOD));
        assert!(live.iter().all(|c| c.value.is_none()));

        let stacks = STACKS.get().copied().unwrap();
        stacks.set(Value::Times(4.0)).unwrap();
        assert_eq!(loader.live_changes()[0].value, Some(Value::Times(4.0)));
        assert!(stacks.set(Value::Set(70000.0)).is_err());
        assert_eq!(loader.live_changes()[0].value, Some(Value::Times(4.0)));
        stacks.reset().unwrap();
        assert_eq!(loader.live_changes()[0].value, None);
    }
}