From 4e160d235a4c6e20906ea30e6d99174dda8fb445 Mon Sep 17 00:00:00 2001 From: altrisi Date: Sun, 14 Dec 2025 22:54:37 +0100 Subject: [PATCH] Fix docs regarding cancellation of player message and command events Relates to #2137 --- docs/scarpet/api/Events.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/scarpet/api/Events.md b/docs/scarpet/api/Events.md index 59378f9b..e273f3f4 100644 --- a/docs/scarpet/api/Events.md +++ b/docs/scarpet/api/Events.md @@ -318,11 +318,11 @@ Triggered when a player sends a disconnect package or is forcefully disconnected ### `__on_player_message(player, message)` Triggered when a player sends a chat message. +This event can be cancelled by returning `'cancel'`, which prevents the message from being sent. + ### `__on_player_command(player, command)` Triggered when a player runs a command. Command value is returned without the / in front. -This event can be cancelled by returning `'cancel'`, which prevents the message from being sent. - ### `__on_statistic(player, category, event, value)` Triggered when a player statistic changes. Doesn't notify on periodic an rhythmic events, i.e. `time_since_death`, `time_since_rest`, and `played_one_minute` since these are triggered every tick. Event