From f924208881426528d15b81aacb106d67248ac822 Mon Sep 17 00:00:00 2001 From: Armen Deroian Date: Sun, 3 Apr 2022 12:59:07 -0400 Subject: [PATCH] Update PlayerPreLoginEvent documentation (#4940) Removed outdated documentation that was very misleading. Replaced with better documentation that accurately describes how to cancel the event. --- src/event/player/PlayerPreLoginEvent.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/event/player/PlayerPreLoginEvent.php b/src/event/player/PlayerPreLoginEvent.php index 66cf550d2..78be4746e 100644 --- a/src/event/player/PlayerPreLoginEvent.php +++ b/src/event/player/PlayerPreLoginEvent.php @@ -31,7 +31,7 @@ use function count; /** * Called when a player connects to the server, prior to authentication taking place. - * Cancelling this event will cause the player to be disconnected with the kick message set. + * Set a kick reason to cancel the event and disconnect the player with the kick message set. * * This event should be used to decide if the player may continue to login to the server. Do things like checking * bans, whitelisting, server-full etc here.