Inheritance diagram for pocketmine\event\player\PlayerJoinEvent:

Collaboration diagram for pocketmine\event\player\PlayerJoinEvent:

Public Member Functions
	__construct (Player $player, protected Translatable\|string $joinMessage)

	call ()

	getEventName ()

	getJoinMessage ()

	getPlayer ()

	setJoinMessage (Translatable\|string $joinMessage)

Static Public Member Functions
static	hasHandlers ()

Protected Attributes
string	$eventName = null

Player	$player

Detailed Description

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.

See also: PlayerLoginEvent

Definition at line 36 of file PlayerJoinEvent.php.

Constructor & Destructor Documentation

◆ __construct()

pocketmine\event\player\PlayerJoinEvent::__construct	(	Player	$player,
		protected Translatable\|string	$joinMessage )

Definition at line 37 of file PlayerJoinEvent.php.

Member Function Documentation

◆ call()

pocketmine\event\Event::call ( )

inherited

Calls event handlers registered for this event.

Exceptions

RuntimeException if event call recursion reaches the max depth limit

Definition at line 49 of file Event.php.

◆ getEventName()

pocketmine\event\Event::getEventName ( )

finalinherited

Definition at line 40 of file Event.php.

◆ getJoinMessage()

pocketmine\event\player\PlayerJoinEvent::getJoinMessage ( )

Definition at line 48 of file PlayerJoinEvent.php.

◆ getPlayer()

pocketmine\event\player\PlayerEvent::getPlayer ( )

inherited

Definition at line 35 of file PlayerEvent.php.

◆ hasHandlers()

static pocketmine\event\Event::hasHandlers ( )

staticinherited

Returns whether the current class context has any registered global handlers. This can be used in hot code paths to avoid unnecessary event object creation.

Usage: SomeEventClass::hasHandlers()

Definition at line 77 of file Event.php.

◆ setJoinMessage()

pocketmine\event\player\PlayerJoinEvent::setJoinMessage ( Translatable|string $joinMessage )

Definition at line 44 of file PlayerJoinEvent.php.

Member Data Documentation

◆ $eventName

string pocketmine\event\Event::$eventName = null

protectedinherited

Definition at line 38 of file Event.php.

◆ $player

Player pocketmine\event\player\PlayerEvent::$player