PocketMine-MP 5.17.1 git-df4ada81e5d74a14046f27cf44a37dcee69d657e
pocketmine\event\player\PlayerKickEvent Class Reference
+ Inheritance diagram for pocketmine\event\player\PlayerKickEvent:
+ Collaboration diagram for pocketmine\event\player\PlayerKickEvent:

Public Member Functions

 __construct (Player $player, protected Translatable|string $disconnectReason, protected Translatable|string $quitMessage, protected Translatable|string|null $disconnectScreenMessage)
 call ()
 getEventName ()
 getPlayer ()
 getQuitMessage ()
 isCancelled ()
 setQuitMessage (Translatable|string $quitMessage)

Static Public Member Functions

static hasHandlers ()

Protected Attributes

string $eventName = null
Player $player

Detailed Description

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

Definition at line 34 of file PlayerKickEvent.php.

Constructor & Destructor Documentation

◆ __construct()

pocketmine\event\player\PlayerKickEvent::__construct ( Player  $player,
protected Translatable|string  $disconnectReason,
protected Translatable|string  $quitMessage,
protected Translatable|string|null  $disconnectScreenMessage 

Definition at line 38 of file PlayerKickEvent.php.

Member Function Documentation

◆ call()

pocketmine\event\Event::call ( )

Calls event handlers registered for this event.


RuntimeException if event call recursion reaches the max depth limit

Definition at line 49 of file Event.php.

◆ getEventName()

pocketmine\event\Event::getEventName ( )

Definition at line 40 of file Event.php.

◆ getPlayer()

pocketmine\event\player\PlayerEvent::getPlayer ( )

Definition at line 35 of file PlayerEvent.php.

◆ getQuitMessage()

pocketmine\event\player\PlayerKickEvent::getQuitMessage ( )

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

Definition at line 57 of file PlayerKickEvent.php.

◆ hasHandlers()

static pocketmine\event\Event::hasHandlers ( )

Returns whether the current class context has any registered global handlers. This can be used in hot code paths to avoid unnecessary event object creation.

Usage: SomeEventClass::hasHandlers()

Definition at line 77 of file Event.php.

◆ isCancelled()

pocketmine\event\Cancellable::isCancelled ( )

Returns whether this instance of the event is currently cancelled.

If it is cancelled, only downstream handlers that declare @handleCancelled will be called with this event.

◆ setQuitMessage()

pocketmine\event\player\PlayerKickEvent::setQuitMessage ( Translatable|string  $quitMessage)

Sets the quit message broadcasted to other players.

Definition at line 50 of file PlayerKickEvent.php.

Member Data Documentation

◆ $eventName

string pocketmine\event\Event::$eventName = null

Definition at line 38 of file Event.php.

◆ $player

Player pocketmine\event\player\PlayerEvent::$player

Definition at line 33 of file PlayerEvent.php.

The documentation for this class was generated from the following file: