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
$player
protected
Player
$player
$quitMessage
protected
Translatable|string
$quitMessage
$reason
protected
string
$reason
$eventCallDepth
private
static int
$eventCallDepth
= 1
$isCancelled
private
bool
$isCancelled
= false
Methods
__construct()
public
__construct(Player $player, string $reason, Translatable|string $quitMessage) : mixed
Parameters
- $player : Player
- $reason : string
- $quitMessage : Translatable|string
Return values
mixed —call()
Calls event handlers registered for this event.
public
call() : void
Tags
Return values
void —cancel()
public
cancel() : void
Return values
void —getEventName()
public
final getEventName() : string
Return values
string —getPlayer()
public
getPlayer() : Player
Return values
Player —getQuitMessage()
public
getQuitMessage() : Translatable|string
Return values
Translatable|string —getReason()
public
getReason() : string
Return values
string —isCancelled()
public
isCancelled() : bool
Return values
bool —setQuitMessage()
public
setQuitMessage(Translatable|string $quitMessage) : void
Parameters
- $quitMessage : Translatable|string
Return values
void —setReason()
public
setReason(string $reason) : void
Parameters
- $reason : string
Return values
void —uncancel()
public
uncancel() : void