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

//! Chat and command events.

/// A player sent a chat message.
///
/// If cancelled, the message is not broadcast. The sender is
/// available via `ctx.player()`.
#[derive(Debug, Clone)]
pub struct ChatMessageEvent {
    /// The chat message content.
    pub message: String,
    /// Whether this event has been cancelled by a Validate handler.
    pub cancelled: bool,
}
crate::instant_cancellable_event!(ChatMessageEvent);

/// A player issued a command (e.g., `/tp 0 64 0`).
///
/// If cancelled, the command is not executed. The issuing player
/// is available via `ctx.player()`.
#[derive(Debug, Clone)]
pub struct CommandEvent {
    /// The command string without the leading `/`.
    pub command: String,
    /// Whether this event has been cancelled by a Validate handler.
    pub cancelled: bool,
}
crate::instant_cancellable_event!(CommandEvent);

#[cfg(test)]
mod tests {
    use crate::events::{BusKind, EventRouting};

    use super::*;

    #[test]
    fn event_routing() {
        assert_eq!(ChatMessageEvent::BUS, BusKind::Instant);
        assert_eq!(CommandEvent::BUS, BusKind::Instant);
    }
}