mirrors/PocketMine-MP
1
0
Fork 0
mirror of https://github.com/pmmp/PocketMine-MP.git synced 2025-07-04 00:59:51 +00:00
Code Issues Projects Releases Wiki Activity

Update PlayerPreLoginEvent documentation (#4940)

Browse Source 
Removed outdated documentation that was very misleading. Replaced with better documentation that accurately describes how to cancel the event.
This commit is contained in:
Armen Deroian 2022-04-03 12:59:07 -04:00 committed by GitHub
parent 6bea2961d9
commit f924208881
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/event/player/PlayerPreLoginEvent.php
View File

@ -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.