PocketMine-MP 5.15.1 git-5ef247620a7c6301a849b54e5ef1009217729fc8
pocketmine\event\player\PlayerLoginEvent Class Reference
+ Inheritance diagram for pocketmine\event\player\PlayerLoginEvent:
+ Collaboration diagram for pocketmine\event\player\PlayerLoginEvent:

Public Member Functions

 __construct (Player $player, protected Translatable|string $kickMessage)
 call ()
 getEventName ()
 getKickMessage ()
 getPlayer ()
 isCancelled ()
 setKickMessage (Translatable|string $kickMessage)

Static Public Member Functions

static hasHandlers ()

Protected Attributes

string $eventName = null
Player $player

Detailed Description

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.

Definition at line 36 of file PlayerLoginEvent.php.

Constructor & Destructor Documentation

◆ __construct()

pocketmine\event\player\PlayerLoginEvent::__construct ( Player  $player,
protected Translatable|string  $kickMessage 

Definition at line 39 of file PlayerLoginEvent.php.

Member Function Documentation

◆ call()

pocketmine\event\Event::call ( )

Calls event handlers registered for this event.


RuntimeException if event call recursion reaches the max depth limit

Definition at line 49 of file Event.php.

◆ getEventName()

pocketmine\event\Event::getEventName ( )

Definition at line 40 of file Event.php.

◆ getKickMessage()

pocketmine\event\player\PlayerLoginEvent::getKickMessage ( )

Definition at line 50 of file PlayerLoginEvent.php.

◆ getPlayer()

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

Definition at line 35 of file PlayerEvent.php.

◆ hasHandlers()

static pocketmine\event\Event::hasHandlers ( )

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.

◆ isCancelled()

pocketmine\event\Cancellable::isCancelled ( )

Returns whether this instance of the event is currently cancelled.

If it is cancelled, only downstream handlers that declare @handleCancelled will be called with this event.

◆ setKickMessage()

pocketmine\event\player\PlayerLoginEvent::setKickMessage ( Translatable|string  $kickMessage)

Definition at line 46 of file PlayerLoginEvent.php.

Member Data Documentation

◆ $eventName

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

Definition at line 38 of file Event.php.

◆ $player

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

Definition at line 33 of file PlayerEvent.php.

The documentation for this class was generated from the following file: