Merge branch 'stable' into next-minor

src/event/block/BlockGrowEvent.php

@@ -23,11 +23,9 @@ declare(strict_types=1);
 
 namespace pocketmine\event\block;
 
-use pocketmine\event\Cancellable;
-
 /**
  * Called when plants or crops grow.
  */
-class BlockGrowEvent extends BaseBlockChangeEvent implements Cancellable{
+class BlockGrowEvent extends BaseBlockChangeEvent{
 
 }

src/event/player/PlayerChatEvent.php

@@ -26,6 +26,7 @@ namespace pocketmine\event\player;
 use pocketmine\command\CommandSender;
 use pocketmine\event\Cancellable;
 use pocketmine\event\CancellableTrait;
+use pocketmine\lang\KnownTranslationKeys;
 use pocketmine\player\Player;
 use pocketmine\utils\Utils;
 
@@ -47,7 +48,7 @@ class PlayerChatEvent extends PlayerEvent implements Cancellable{
 	/**
 	 * @param CommandSender[] $recipients
 	 */
-	public function __construct(Player $player, string $message, array $recipients, string $format = "chat.type.text"){
+	public function __construct(Player $player, string $message, array $recipients, string $format = KnownTranslationKeys::CHAT_TYPE_TEXT){
 		$this->player = $player;
 		$this->message = $message;
 

src/event/player/PlayerCreationEvent.php

@@ -30,7 +30,20 @@ use pocketmine\utils\Utils;
 use function is_a;
 
 /**
- * Allows the creation of players overriding the base Player class
+ * Allows the use of custom Player classes. This enables overriding built-in Player methods to change behaviour that is
+ * not possible to alter any other way.
+ *
+ * You probably don't need this event, and found your way here because you looked at some code in an old plugin that
+ * abused it (very common). Instead of using custom player classes, you should consider making session classes instead.
+ *
+ * @see https://github.com/pmmp/SessionsDemo
+ *
+ * This event is a power-user feature, and multiple plugins using it at the same time will conflict and break unless
+ * they've been designed to work together. This means that it's only usually useful in private plugins.
+ *
+ * WARNING: This should NOT be used for adding extra functions or properties. This is intended for **overriding existing
+ * core behaviour**, and should only be used if you know EXACTLY what you're doing.
+ * Custom player classes may break in any update without warning. This event isn't much more than glorified reflection.
  */
 class PlayerCreationEvent extends Event{
 
@@ -54,6 +67,8 @@ class PlayerCreationEvent extends Event{
 	}
 
 	/**
+	 * Returns the base class that the final player class must extend.
+	 *
 	 * @return string
 	 * @phpstan-return class-string<Player>
 	 */
@@ -62,6 +77,10 @@ class PlayerCreationEvent extends Event{
 	}
 
 	/**
+	 * Sets the class that the final player class must extend.
+	 * The new base class must be a subclass of the current base class.
+	 * This can (perhaps) be used to limit the options for custom player classes provided by other plugins.
+	 *
 	 * @param string $class
 	 * @phpstan-param class-string<Player> $class
 	 */
@@ -74,6 +93,8 @@ class PlayerCreationEvent extends Event{
 	}
 
 	/**
+	 * Returns the class that will be instantiated to create the player after the event.
+	 *
 	 * @return string
 	 * @phpstan-return class-string<Player>
 	 */
@@ -82,6 +103,9 @@ class PlayerCreationEvent extends Event{
 	}
 
 	/**
+	 * Sets the class that will be instantiated to create the player after the event. The class must not be abstract,
+	 * and must be an instance of the base class.
+	 *
 	 * @param string $class
 	 * @phpstan-param class-string<Player> $class
 	 */