Inheritance diagram for pocketmine\event\player\PlayerQuitEvent:

Collaboration diagram for pocketmine\event\player\PlayerQuitEvent:

Public Member Functions
	__construct (Player $player, protected Translatable\|string $quitMessage, protected Translatable\|string $quitReason)

	call ()

	getEventName ()

	getPlayer ()

	getQuitMessage ()

	getQuitReason ()

	setQuitMessage (Translatable\|string $quitMessage)

Static Public Member Functions
static	hasHandlers ()

Protected Attributes
string	$eventName = null

Player	$player

Detailed Description

Called when a player disconnects from the server for any reason.

Some possible reasons include:

being kicked by an operator
disconnecting from the game
timeout due to network connectivity issues

See also: PlayerKickEvent

Definition at line 39 of file PlayerQuitEvent.php.

Constructor & Destructor Documentation

◆ __construct()

pocketmine\event\player\PlayerQuitEvent::__construct	(	Player	$player,
		protected Translatable\|string	$quitMessage,
		protected Translatable\|string	$quitReason
	)

Definition at line 40 of file PlayerQuitEvent.php.

Member Function Documentation

◆ call()

pocketmine\event\Event::call ( )

inherited

Calls event handlers registered for this event.

Exceptions

RuntimeException if event call recursion reaches the max depth limit

Definition at line 49 of file Event.php.

◆ getEventName()

pocketmine\event\Event::getEventName ( )

finalinherited

Definition at line 40 of file Event.php.

◆ getPlayer()

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

inherited

Definition at line 35 of file PlayerEvent.php.

◆ getQuitMessage()

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

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

Definition at line 58 of file PlayerQuitEvent.php.

◆ getQuitReason()

pocketmine\event\player\PlayerQuitEvent::getQuitReason ( )

Returns the disconnect reason shown in the server log and on the console.

Definition at line 65 of file PlayerQuitEvent.php.

◆ hasHandlers()

static pocketmine\event\Event::hasHandlers ( )

staticinherited

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.

◆ setQuitMessage()

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

Sets the quit message broadcasted to other players.

Definition at line 51 of file PlayerQuitEvent.php.

Member Data Documentation

◆ $eventName

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

protectedinherited

Definition at line 38 of file Event.php.

◆ $player

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