PlayerTransferEvent: add documentation

This commit is contained in:
Dylan K. Taylor 2022-05-21 21:21:51 +01:00
parent 8ecf9717d6
commit 4a3e42f82e
No known key found for this signature in database
GPG Key ID: 8927471A91CAFD3D

View File

@ -27,6 +27,9 @@ use pocketmine\event\Cancellable;
use pocketmine\event\CancellableTrait;
use pocketmine\player\Player;
/**
* Called when a player attempts to be transferred to another server, e.g. by using /transferserver.
*/
class PlayerTransferEvent extends PlayerEvent implements Cancellable{
use CancellableTrait;
@ -44,26 +47,44 @@ class PlayerTransferEvent extends PlayerEvent implements Cancellable{
$this->message = $message;
}
/**
* Returns the destination server address. This could be an IP or a domain name.
*/
public function getAddress() : string{
return $this->address;
}
/**
* Sets the destination server address.
*/
public function setAddress(string $address) : void{
$this->address = $address;
}
/**
* Returns the destination server port.
*/
public function getPort() : int{
return $this->port;
}
/**
* Sets the destination server port.
*/
public function setPort(int $port) : void{
$this->port = $port;
}
/**
* Returns the disconnect reason shown in the server log and on the console.
*/
public function getMessage() : string{
return $this->message;
}
/**
* Sets the disconnect reason shown in the server log and on the console.
*/
public function setMessage(string $message) : void{
$this->message = $message;
}