fmc_client_api 0.0.5

Library for creating fmc client plugins
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

package fmc:api;

// These structs are implemented in the glam crate
interface math {
    record vec3 {
        x: f32,
        y: f32,
        z: f32
    }

    /// IM DOCUMENTING
    record i-vec3 {
        x: s32,
        y: s32,
        z: s32
    }

    // TODO: Unfortunate ergonomics, include glam in the repo and gut the Quat
    //
    // We use the f64 version instead because the f32 version is implemented with simd and so
    // doesn't have any fields.
    record d-quat {
        x: f64,
        y: f64,
        z: f64,
        w: f64,
    }
}

interface transform {
    use math.{vec3, d-quat};

    record transform {
        translation: vec3,
        rotation: d-quat,
        scale: vec3
    }
}

world plugin {
    use math.{vec3, i-vec3, d-quat};
    use transform.{transform};

    type block-id = u16;
    type entity = u64;

    record friction {
        surface: option<surface-friction>,
        drag: vec3
    }

    record surface-friction {
        front: f32,
        back: f32,
        right: f32,
        left: f32,
        top: f32,
        bottom: f32,
    }

    // TODO: The client can map keys, is it best to handle this only host side? Eventually the wasm
    // should handle the interfaces which means it needs complete access to the keyboard anyways.
    enum key {
       key-w, 
       key-a, 
       key-s, 
       key-d, 
       shift,
       control,
       space
    }

    record keyboard-key {
        /// Physical key code
        key: key,
        /// True if it was released, false if pressed
        released: bool,
        /// If the button has been held down for some OS specified period
        repeat: bool
    }

    export init-plugin: func();
    export set-update-frequency: func() -> option<f32>;
    export update: func();
    export handle-server-data: func(data: list<u8>);

    import log: func(msg: string);

    import delta-time: func() -> f32;

    import get-player-transform: func() -> transform;
    import get-camera-transform: func() -> transform;

    import set-player-transform: func(transform: transform);
    import set-camera-transform: func(transform: transform);

    import keyboard-input: func() -> list<keyboard-key>;

    /// Get the id of a block in the world map
    import get-block: func(block-position: i-vec3) -> option<block-id>;
    /// Get the friction of a block
    import get-block-friction: func(block-id: block-id) -> friction;
    /// Get the name of a block
    import get-block-name: func(block-id: block-id) -> string;
    /// Get the aabb of the block
    import get-block-aabb: func(block-id: block-id) -> option<tuple<vec3, vec3>>;

    /// Get the models inside the aabb defined by min and max
    import get-models: func(min: vec3, max: vec3) -> list<u32>;
    /// Get the aabb a model
    import get-model-aabb: func(model-id: u32) -> tuple<vec3, vec3>;
}