PlayerJoinEvent
extends PlayerEvent
in package
Called when the player spawns in the world after logging in, when they first see the terrain.
Note: A lot of data is sent to the player between login and this event. Disconnecting the player during this event will cause this data to be wasted. Prefer disconnecting at login-time if possible to minimize bandwidth wastage.
Tags
Table of Contents
- MAX_EVENT_CALL_DEPTH = 50
- $eventName : string|null
- $joinMessage : string|Translatable
- $player : Player
- $eventCallDepth : int
- __construct() : mixed
- call() : void
- Calls event handlers registered for this event.
- getEventName() : string
- getJoinMessage() : Translatable|string
- getPlayer() : Player
- setJoinMessage() : void
Constants
MAX_EVENT_CALL_DEPTH
private
mixed
MAX_EVENT_CALL_DEPTH
= 50
Properties
$eventName
protected
string|null
$eventName
= null
$joinMessage
protected
string|Translatable
$joinMessage
$player
protected
Player
$player
$eventCallDepth
private
static int
$eventCallDepth
= 1
Methods
__construct()
public
__construct(Player $player, Translatable|string $joinMessage) : mixed
Parameters
- $player : Player
- $joinMessage : Translatable|string
Return values
mixed —call()
Calls event handlers registered for this event.
public
call() : void
Tags
Return values
void —getEventName()
public
final getEventName() : string
Return values
string —getJoinMessage()
public
getJoinMessage() : Translatable|string
Return values
Translatable|string —getPlayer()
public
getPlayer() : Player
Return values
Player —setJoinMessage()
public
setJoinMessage(Translatable|string $joinMessage) : void
Parameters
- $joinMessage : Translatable|string