Called when a player attempts to be transferred to another server, e.g. by using /transferserver.
Definition at line 34 of file PlayerTransferEvent.php.
◆ __construct()
pocketmine\event\player\PlayerTransferEvent::__construct |
( |
Player | $player, |
|
|
protected string | $address, |
|
|
protected int | $port, |
|
|
protected Translatable|string | $message ) |
◆ 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.
◆ getAddress()
pocketmine\event\player\PlayerTransferEvent::getAddress |
( |
| ) |
|
Returns the destination server address. This could be an IP or a domain name.
Definition at line 49 of file PlayerTransferEvent.php.
◆ getEventName()
pocketmine\event\Event::getEventName |
( |
| ) |
|
|
finalinherited |
◆ getMessage()
pocketmine\event\player\PlayerTransferEvent::getMessage |
( |
| ) |
|
Returns the disconnect reason shown in the server log and on the console.
Definition at line 77 of file PlayerTransferEvent.php.
◆ getPlayer()
pocketmine\event\player\PlayerEvent::getPlayer |
( |
| ) |
|
|
inherited |
◆ getPort()
pocketmine\event\player\PlayerTransferEvent::getPort |
( |
| ) |
|
◆ 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.
◆ isCancelled()
pocketmine\event\Cancellable::isCancelled |
( |
| ) |
|
|
inherited |
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.
◆ setAddress()
pocketmine\event\player\PlayerTransferEvent::setAddress |
( |
string | $address | ) |
|
◆ setMessage()
pocketmine\event\player\PlayerTransferEvent::setMessage |
( |
Translatable|string | $message | ) |
|
Sets the disconnect reason shown in the server log and on the console.
Definition at line 84 of file PlayerTransferEvent.php.
◆ setPort()
pocketmine\event\player\PlayerTransferEvent::setPort |
( |
int | $port | ) |
|
◆ $eventName
string pocketmine\event\Event::$eventName = null |
|
protectedinherited |
◆ $player
Player pocketmine\event\player\PlayerEvent::$player |
|
protectedinherited |
The documentation for this class was generated from the following file: