basalt-api 0.2.1

Public plugin API for the Basalt Minecraft server: traits, components, events, and the plugin registration system
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

//! Gamemode type for the Minecraft protocol.
//!
//! Provides a type-safe enum instead of raw `u8` values for gamemodes,
//! preventing invalid values from reaching the protocol layer.

use std::fmt;

/// A Minecraft game mode.
///
/// Used by [`Context::set_gamemode`](crate::Context::set_gamemode)
/// and the `/gamemode` command. Maps directly to the protocol values
/// sent in the GameStateChange packet (reason = 3).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum Gamemode {
    /// Survival mode (id 0): resource gathering, health, hunger.
    Survival = 0,
    /// Creative mode (id 1): unlimited resources, flight, no damage.
    Creative = 1,
    /// Adventure mode (id 2): survival with block interaction restrictions.
    Adventure = 2,
    /// Spectator mode (id 3): invisible, fly through blocks, no interaction.
    Spectator = 3,
}

impl Gamemode {
    /// Returns the protocol ID for this gamemode.
    pub fn id(self) -> u8 {
        self as u8
    }

    /// Creates a gamemode from its protocol ID.
    ///
    /// Returns `None` for invalid IDs (anything other than 0-3).
    pub fn from_id(id: u8) -> Option<Self> {
        match id {
            0 => Some(Self::Survival),
            1 => Some(Self::Creative),
            2 => Some(Self::Adventure),
            3 => Some(Self::Spectator),
            _ => None,
        }
    }
}

impl fmt::Display for Gamemode {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Gamemode::Survival => write!(f, "Survival"),
            Gamemode::Creative => write!(f, "Creative"),
            Gamemode::Adventure => write!(f, "Adventure"),
            Gamemode::Spectator => write!(f, "Spectator"),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn gamemode_ids() {
        assert_eq!(Gamemode::Survival.id(), 0);
        assert_eq!(Gamemode::Creative.id(), 1);
        assert_eq!(Gamemode::Adventure.id(), 2);
        assert_eq!(Gamemode::Spectator.id(), 3);
    }

    #[test]
    fn from_valid_id() {
        assert_eq!(Gamemode::from_id(0), Some(Gamemode::Survival));
        assert_eq!(Gamemode::from_id(1), Some(Gamemode::Creative));
        assert_eq!(Gamemode::from_id(2), Some(Gamemode::Adventure));
        assert_eq!(Gamemode::from_id(3), Some(Gamemode::Spectator));
    }

    #[test]
    fn from_invalid_id() {
        assert_eq!(Gamemode::from_id(4), None);
        assert_eq!(Gamemode::from_id(255), None);
    }

    #[test]
    fn display() {
        assert_eq!(Gamemode::Survival.to_string(), "Survival");
        assert_eq!(Gamemode::Creative.to_string(), "Creative");
        assert_eq!(Gamemode::Adventure.to_string(), "Adventure");
        assert_eq!(Gamemode::Spectator.to_string(), "Spectator");
    }
}