From 4a3e42f82e962765cddbb9186111a80251e6c2fe Mon Sep 17 00:00:00 2001
From: "Dylan K. Taylor" <dktapps@pmmp.io>
Date: Sat, 21 May 2022 21:21:51 +0100
Subject: [PATCH] PlayerTransferEvent: add documentation

---
 src/event/player/PlayerTransferEvent.php | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/src/event/player/PlayerTransferEvent.php b/src/event/player/PlayerTransferEvent.php
index 9e6669893..adaa0ca5d 100644
--- a/src/event/player/PlayerTransferEvent.php
+++ b/src/event/player/PlayerTransferEvent.php
@@ -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;
 	}