PlayerLoginEvent
extends PlayerEvent
in package
implements
Cancellable
Uses
CancellableTrait
Called after the player has successfully authenticated, before it spawns. The player is on the loading screen when this is called.
Cancelling this event will cause the player to be disconnected with the kick message set.
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
- $kickMessage : string
- $player : Player
- $eventCallDepth : int
- $isCancelled : bool
- __construct() : mixed
- call() : void
- Calls event handlers registered for this event.
- cancel() : void
- getEventName() : string
- getKickMessage() : string
- getPlayer() : Player
- isCancelled() : bool
- setKickMessage() : void
- uncancel() : void
Constants
MAX_EVENT_CALL_DEPTH
private
mixed
MAX_EVENT_CALL_DEPTH
= 50
Properties
$eventName
protected
string|null
$eventName
= null
$kickMessage
protected
string
$kickMessage
$player
protected
Player
$player
$eventCallDepth
private
static int
$eventCallDepth
= 1
$isCancelled
private
bool
$isCancelled
= false
Methods
__construct()
public
__construct(Player $player, string $kickMessage) : mixed
Parameters
- $player : Player
- $kickMessage : 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 —getKickMessage()
public
getKickMessage() : string
Return values
string —getPlayer()
public
getPlayer() : Player
Return values
Player —isCancelled()
public
isCancelled() : bool
Return values
bool —setKickMessage()
public
setKickMessage(string $kickMessage) : void
Parameters
- $kickMessage : string
Return values
void —uncancel()
public
uncancel() : void