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

PlayerKickEvent: improved woefully inadequate documentation

Browse Source
This commit is contained in:
Dylan K. Taylor
2022-05-21 21:03:56 +01:00
parent 82104a8251
commit 3177d19730
1 changed files with 16 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
src/event/player/PlayerKickEvent.php
View File

@ -29,7 +29,7 @@ use pocketmine\lang\Translatable;
use pocketmine\player\Player;
/**
* Called when a player leaves the server
* Called when a player is kicked (forcibly disconnected) from the server, e.g. if an operator used /kick.
*/
class PlayerKickEvent extends PlayerEvent implements Cancellable{
use CancellableTrait;
@ -46,18 +46,33 @@ class PlayerKickEvent extends PlayerEvent implements Cancellable{
$this->reason = $reason;
}
/**
* Sets the message shown on the kicked player's disconnection screen.
* This message is also displayed in the console and server log.
*/
public function setReason(string $reason) : void{
$this->reason = $reason;
}
/**
* Returns the message shown on the kicked player's disconnection screen.
* This message is also displayed in the console and server log.
* When kicked by the /kick command, the default is something like "Kicked by admin.".
*/
public function getReason() : string{
return $this->reason;
}
/**
* Sets the quit message broadcasted to other players.
*/
public function setQuitMessage(Translatable|string $quitMessage) : void{
$this->quitMessage = $quitMessage;
}
/**
* Returns the quit message broadcasted to other players, e.g. "Steve left the game".
*/
public function getQuitMessage() : Translatable|string{
return $this->quitMessage;
}