PlayerKickEvent

class · pocketmine\event\player\PlayerKickEvent · source

Extends PlayerEvent
Implements Cancellable

Called when a player is kicked (forcibly disconnected) from the server, e.g. if an operator used /kick.

Properties

$disconnectReason

public \pocketmine\lang\Translatable|string $disconnectReason

$disconnectScreenMessage

public \pocketmine\lang\Translatable|string|null $disconnectScreenMessage

$quitMessage

public \pocketmine\lang\Translatable|string $quitMessage

Methods

__construct()

public function __construct(\pocketmine\player\Player $player, \pocketmine\lang\Translatable|string $disconnectReason, \pocketmine\lang\Translatable|string $quitMessage, \pocketmine\lang\Translatable|string|null $disconnectScreenMessage)

getQuitMessage()

public function getQuitMessage() : \pocketmine\lang\Translatable|string

Returns the quit message broadcasted to other players, e.g. "Steve left the game".

setQuitMessage()

public function setQuitMessage(\pocketmine\lang\Translatable|string $quitMessage) : void

Sets the quit message broadcasted to other players.