Documentation

PlayerKickEvent extends PlayerEvent
in package
implements Cancellable Uses CancellableTrait

Called when a player leaves the server

Interfaces, Classes, Traits and Enums

Cancellable
This interface is implemented by an Event subclass if and only if it can be cancelled.

Table of Contents

MAX_EVENT_CALL_DEPTH  = 50
$eventName  : string|null
$player  : Player
$quitMessage  : Translatable|string
$reason  : string
$eventCallDepth  : int
$isCancelled  : bool
__construct()  : mixed
call()  : void
Calls event handlers registered for this event.
cancel()  : void
getEventName()  : string
getPlayer()  : Player
getQuitMessage()  : Translatable|string
getReason()  : string
isCancelled()  : bool
setQuitMessage()  : void
setReason()  : void
uncancel()  : 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

setReason()

public setReason(string $reason) : void
Parameters
$reason : string
Return values
void

Search results