Documentation

PlayerQuitEvent extends PlayerEvent
in package

Called when a player leaves the server

Table of Contents

MAX_EVENT_CALL_DEPTH  = 50
$eventName  : string|null
$player  : Player
$quitMessage  : Translatable|string
$quitReason  : string
$eventCallDepth  : int
__construct()  : mixed
call()  : void
Calls event handlers registered for this event.
getEventName()  : string
getPlayer()  : Player
getQuitMessage()  : Translatable|string
getQuitReason()  : string
setQuitMessage()  : void

Constants

MAX_EVENT_CALL_DEPTH

private mixed MAX_EVENT_CALL_DEPTH = 50

Properties

$eventName

protected string|null $eventName = null

$eventCallDepth

private static int $eventCallDepth = 1

Methods

call()

Calls event handlers registered for this event.

public call() : void
Tags
throws
RuntimeException

if event call recursion reaches the max depth limit

Return values
void

getEventName()

public final getEventName() : string
Return values
string

getQuitReason()

public getQuitReason() : string
Return values
string

Search results