Merge branch 'next-minor' into next-major

.github/workflows/discord-release-notify.yml

@@ -13,7 +13,7 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Setup PHP and tools
-        uses: shivammathur/setup-php@2.21.2
+        uses: shivammathur/setup-php@2.22.0
         with:
           php-version: 8.0
 

.github/workflows/draft-release.yml

@@ -18,7 +18,7 @@ jobs:
           submodules: true
 
       - name: Setup PHP
-        uses: shivammathur/setup-php@2.21.2
+        uses: shivammathur/setup-php@2.22.0
         with:
           php-version: 8.0
 

.github/workflows/main.yml

@@ -198,7 +198,7 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Setup PHP and tools
-        uses: shivammathur/setup-php@2.21.2
+        uses: shivammathur/setup-php@2.22.0
         with:
           php-version: 8.0
           tools: php-cs-fixer:3.11

changelogs/4.10.md

@@ -11,4 +11,28 @@ Released 26th October 2022.
 
 ## General
 - Added support for Minecraft: Bedrock Edition 1.19.40.
-- Removed support for older versions.
+- Removed support for older versions.
+
+## Fixes
+- Fixed incorrect command descriptions showing in `/help` when multiple commands use the same name. Previously, the most recently registered command would show, even though it wouldn't actually be invoked.
+- Fixed splash potions affecting players in spectator mode.
+- Fixed `World->addParticle()` sending particles to players who couldn't possibly see them when a list of targets was used.
+- Fixed `World->addSound()` sending sounds to players who couldn't possibly hear them when a list of targets was used.
+
+## Documentation
+- Improved type information available for various API methods in `World`.
+
+# 4.10.1
+Released 7th November 2022.
+
+## Fixes
+- Fixed spawning in the void if spawn terrain in a world is solid at the default spawn position.
+- Fixed totems of undying activating when the player has 1 HP remaining.
+- Fixed durable items such as tools becoming unbreakable when in stacks larger than 1. Now, the durability correctly resets when the tool breaks.
+- TPS below 12 now correctly shows as red in `/status`. Previously, it showed as orange due to a condition ordering bug.
+- Improved handling of missing arguments in user-defined `pocketmine.yml` command aliases. Previously, missing arguments would be filled with an empty string, which caused a variety of unexpected behaviour.
+
+## Internals
+- Added validation for the array given to `BaseInventory->setContents()` to ensure that it contains only `Item` instances.
+- Silenced `PlayerAuthInputPacket` spam when the session is in the "spawn response" state.
+- Updated to PHPStan 1.9.

changelogs/4.11-beta.md

@@ -0,0 +1,67 @@
+**For Minecraft: Bedrock Edition 1.19.40**
+
+This is a minor feature release for PocketMine-MP, introducing some new features and improvements.
+
+### Note about API versions
+Plugins which don't touch the protocol and compatible with any previous 4.x.y version will also run on these releases and do not need API bumps.
+Plugin developers should **only** update their required API to this version if you need the changes in this build.
+
+**WARNING: If your plugin uses the protocol, you're not shielded by API change constraints.** You should consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you do.
+
+# 4.11.0-BETA1
+Released 7th November 2022.
+
+## General
+- Packet receive timings have now been split into two subcategories - Decode and Handle.
+- Console command entry can now be disabled via the `console.enable-input` setting in `pocketmine.yml`.
+    - Best suited for headless servers (e.g. in a Docker container) where the console will never be used anyway.
+    - Disabling the console reader slightly reduces memory usage, because console reading currently requires an additional subprocess.
+- Console command output now appears on the terminal only, and is not written to the log file.
+- The output from console commands now appears with a `Command output |` prefix, instead of as a log message.
+- Introduced validation for the `--data` and `--plugins` command line options.
+- Encrypted resource packs are now supported, by means of adding a `.key` file alongside the pack in the `resource_packs` folder.
+    - e.g. `MyEncryptedPack.zip` -> `MyEncryptedPack.zip.key`
+
+## Gameplay
+- Fixed supporting blocks of dead bush to be in line with vanilla.
+- Sugarcane can now be grown using bonemeal on any part of the sugarcane. Previously, it only worked when used on the bottom block.
+- Fixed modifier values for Instant Damage and Regeneration effects.
+
+## API
+### General
+- Plugins are now always disabled before their dependencies, to ensure that they are able to shutdown properly (e.g. a core plugin depending on a database plugin may want to save data to a DB during `onDisable()`).
+- [`webmozart/path-util`](https://packagist.org/packages/webmozart/path-util) has been deprecated, and will be dropped in favour of [`symfony/filesystem`](https://packagist.org/packages/symfony/filesystem) in PM5.
+    - To prepare for this change, simply replace any usage of `Webmozart\PathUtil\Path` with `Symfony\Component\Filesystem\Path`, which is available as a dependency in this release.
+
+### `pocketmine`
+- The following API methods are now deprecated:
+    - `Server->getPlayerByPrefix()`
+
+### `pocketmine\entity`
+- `EntitySpawnEvent` and `ItemSpawnEvent` are now fired on the first tick after the entity is added to the world. Previously, these events were called directly from the entity constructor, making it impossible to get properties like velocity which are often set after the entity is created.
+- The following API methods are now deprecated:
+    - `Living->hasLineOfSight()`
+
+### `pocketmine\item`
+- The following new API methods have been added:
+    - `public Armor->clearCustomColor() : $this`
+
+### `pocketmine\inventory\transaction`
+- Introduced a `TransactionBuilder` class. This makes it less of a hassle to build an `InventoryTransaction` server-side, since the regular `Inventory` API methods can be used, rather than having to manually create `SlotChangeAction`s.
+
+### `pocketmine\player`
+- The following new API methods have been added:
+    - `public Player->sendToastNotification(string $title, string $body) : void` - makes a grey box appear at the top of the player's screen containing the specified message
+
+### `pocketmine\utils`
+- The following new API methods have been added:
+    - `public static TextFormat::addBase(string $baseFormat, string $string) : string` - used for coloured log messages, changes the base formatting of a string by inserting the given formatting codes after every RESET code
+
+## Internals
+- Improved performance of `ContainerTrait` dropping items on block destroy. (24e72ec109c1442b09558df89b6833cf2f2e0ec7)
+- Avoid repeated calls to `Position->getWorld()` (use local variables). (2940547026db40ce76deb46e992870de3ead79ad)
+- Revamped the way `InventoryManager` handles fake inventory slot mappings for stuff like crafting tables. (e90abecf38d9c57635fa0497514bba7e546a2469)
+- Console polling is now done on the main thread (no longer a performance concern).
+- Console reader subprocess should now automatically die if the server main process is killed, instead of persisting as a zombie.
+- `ConsoleCommandSender` is no longer responsible for relaying broadcast messages to `MainLogger`. A new `BroadcastLoggerForwarder` has been added, which is subscribed to the appropriate server broadcast channels in order to relay messages. This ensures that chat messages and command audit messages are logged.
+- `DelegateInventory` now uses `WeakReference` to track its inventory listener. This allows the delegate to be reused.

composer.lock

@@ -984,21 +984,20 @@
         },
         {
             "name": "ramsey/uuid",
-            "version": "4.5.1",
+            "version": "4.6.0",
             "source": {
                 "type": "git",
                 "url": "https://github.com/ramsey/uuid.git",
-                "reference": "a161a26d917604dc6d3aa25100fddf2556e9f35d"
+                "reference": "ad63bc700e7d021039e30ce464eba384c4a1d40f"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/ramsey/uuid/zipball/a161a26d917604dc6d3aa25100fddf2556e9f35d",
-                "reference": "a161a26d917604dc6d3aa25100fddf2556e9f35d",
+                "url": "https://api.github.com/repos/ramsey/uuid/zipball/ad63bc700e7d021039e30ce464eba384c4a1d40f",
+                "reference": "ad63bc700e7d021039e30ce464eba384c4a1d40f",
                 "shasum": ""
             },
             "require": {
                 "brick/math": "^0.8.8 || ^0.9 || ^0.10",
-                "ext-ctype": "*",
                 "ext-json": "*",
                 "php": "^8.0",
                 "ramsey/collection": "^1.0"
@@ -1030,7 +1029,6 @@
             },
             "suggest": {
                 "ext-bcmath": "Enables faster math with arbitrary-precision integers using BCMath.",
-                "ext-ctype": "Enables faster processing of character classification using ctype functions.",
                 "ext-gmp": "Enables faster math with arbitrary-precision integers using GMP.",
                 "ext-uuid": "Enables the use of PeclUuidTimeGenerator and PeclUuidRandomGenerator.",
                 "paragonie/random-lib": "Provides RandomLib for use with the RandomLibAdapter",
@@ -1062,7 +1060,7 @@
             ],
             "support": {
                 "issues": "https://github.com/ramsey/uuid/issues",
-                "source": "https://github.com/ramsey/uuid/tree/4.5.1"
+                "source": "https://github.com/ramsey/uuid/tree/4.6.0"
             },
             "funding": [
                 {
@@ -1074,7 +1072,7 @@
                     "type": "tidelift"
                 }
             ],
-            "time": "2022-09-16T03:22:46+00:00"
+            "time": "2022-11-05T23:03:38+00:00"
         },
         {
             "name": "symfony/filesystem",

resources/pocketmine.yml

@@ -119,8 +119,6 @@ chunk-sending:
   spawn-radius: 4
 
 chunk-ticking:
-  #Max amount of chunks processed each tick
-  per-tick: 40
   #Radius of chunks around a player to tick
   tick-radius: 3
   #Number of blocks inside ticking areas' subchunks that get ticked every tick. Higher values will accelerate events

src/data/bedrock/EffectIdMap.php

@@ -74,6 +74,7 @@ final class EffectIdMap{
 		//TODO: SLOW_FALLING
 		//TODO: BAD_OMEN
 		//TODO: VILLAGE_HERO
+		$this->register(EffectIds::DARKNESS, VanillaEffects::DARKNESS());
 	}
 
 	//TODO: not a big fan of the code duplication here :(

src/data/bedrock/EffectIds.php

@@ -58,4 +58,5 @@ final class EffectIds{
 	public const SLOW_FALLING = 27;
 	public const BAD_OMEN = 28;
 	public const VILLAGE_HERO = 29;
+	public const DARKNESS = 30;
 }

src/entity/Human.php

@@ -343,7 +343,7 @@ class Human extends Living implements ProjectileSource, InventoryHolder{
 			&& ($this->inventory->getItemInHand() instanceof Totem || $this->offHandInventory->getItem(0) instanceof Totem)){
 
 			$compensation = $this->getHealth() - $source->getFinalDamage() - 1;
-			if($compensation < 0){
+			if($compensation <= -1){
 				$source->setModifier($compensation, EntityDamageEvent::MODIFIER_TOTEM);
 			}
 		}

src/entity/effect/StringToEffectParser.php

@@ -40,6 +40,7 @@ final class StringToEffectParser extends StringToTParser{
 		$result->register("absorption", fn() => VanillaEffects::ABSORPTION());
 		$result->register("blindness", fn() => VanillaEffects::BLINDNESS());
 		$result->register("conduit_power", fn() => VanillaEffects::CONDUIT_POWER());
+		$result->register("darkness", fn() => VanillaEffects::DARKNESS());
 		$result->register("fatal_poison", fn() => VanillaEffects::FATAL_POISON());
 		$result->register("fire_resistance", fn() => VanillaEffects::FIRE_RESISTANCE());
 		$result->register("haste", fn() => VanillaEffects::HASTE());

src/entity/effect/VanillaEffects.php

@@ -36,6 +36,7 @@ use pocketmine\utils\RegistryTrait;
  * @method static AbsorptionEffect ABSORPTION()
  * @method static Effect BLINDNESS()
  * @method static Effect CONDUIT_POWER()
+ * @method static Effect DARKNESS()
  * @method static PoisonEffect FATAL_POISON()
  * @method static Effect FIRE_RESISTANCE()
  * @method static Effect HASTE()
@@ -68,6 +69,7 @@ final class VanillaEffects{
 		//TODO: bad_omen
 		self::register("blindness", new Effect(KnownTranslationFactory::potion_blindness(), new Color(0x1f, 0x1f, 0x23), true));
 		self::register("conduit_power", new Effect(KnownTranslationFactory::potion_conduitPower(), new Color(0x1d, 0xc2, 0xd1)));
+		self::register("darkness", new Effect(KnownTranslationFactory::effect_darkness(), new Color(0x29, 0x27, 0x21), true, 600, false));
 		self::register("fatal_poison", new PoisonEffect(KnownTranslationFactory::potion_poison(), new Color(0x4e, 0x93, 0x31), true, 600, true, true));
 		self::register("fire_resistance", new Effect(KnownTranslationFactory::potion_fireResistance(), new Color(0xe4, 0x9a, 0x3a)));
 		self::register("haste", new Effect(KnownTranslationFactory::potion_digSpeed(), new Color(0xd9, 0xc0, 0x43)));

src/entity/projectile/Arrow.php

@@ -38,6 +38,7 @@ use pocketmine\network\mcpe\protocol\types\entity\EntityMetadataCollection;
 use pocketmine\network\mcpe\protocol\types\entity\EntityMetadataFlags;
 use pocketmine\player\Player;
 use pocketmine\world\sound\ArrowHitSound;
+use function ceil;
 use function mt_rand;
 use function sqrt;
 
@@ -95,7 +96,7 @@ class Arrow extends Projectile{
 	}
 
 	public function getResultDamage() : int{
-		$base = parent::getResultDamage();
+		$base = (int) ceil($this->motion->length() * parent::getResultDamage());
 		if($this->isCritical()){
 			return ($base + mt_rand(0, (int) ($base / 2) + 1));
 		}else{

src/entity/projectile/Projectile.php

@@ -118,7 +118,7 @@ abstract class Projectile extends Entity{
 	 * Returns the amount of damage this projectile will deal to the entity it hits.
 	 */
 	public function getResultDamage() : int{
-		return (int) ceil($this->motion->length() * $this->damage);
+		return (int) ceil($this->damage);
 	}
 
 	public function saveNBT() : CompoundTag{

src/inventory/BaseInventory.php

@@ -27,6 +27,7 @@ use pocketmine\item\Item;
 use pocketmine\item\VanillaItems;
 use pocketmine\player\Player;
 use pocketmine\utils\ObjectSet;
+use pocketmine\utils\Utils;
 use function array_slice;
 use function count;
 use function max;
@@ -84,6 +85,7 @@ abstract class BaseInventory implements Inventory{
 	 * @phpstan-param array<int, Item> $items
 	 */
 	public function setContents(array $items) : void{
+		Utils::validateArrayValueType($items, function(Item $item) : void{});
 		if(count($items) > $this->getSize()){
 			$items = array_slice($items, 0, $this->getSize(), true);
 		}

src/player/Player.php

@@ -2428,9 +2428,6 @@ class Player extends Human implements CommandSender, ChunkListener, IPlayer{
 		$this->ySize = 0;
 	}
 
-	/**
-	 * {@inheritdoc}
-	 */
 	public function teleport(Vector3 $pos, ?float $yaw = null, ?float $pitch = null) : bool{
 		if(parent::teleport($pos, $yaw, $pitch)){
 

src/utils/Internet.php

@@ -68,7 +68,7 @@ class Internet{
 	public static bool $online = true;
 
 	/**
-	 * Gets the External IP using an external service, it is cached
+	 * Lazily gets the External IP using an external service and caches the result
 	 *
 	 * @param bool $force default false, force IP check even when cached
 	 *

src/utils/Timezone.php

@@ -208,7 +208,7 @@ abstract class Timezone{
 		//That's been a bug in PHP since 2008!
 		foreach(timezone_abbreviations_list() as $zones){
 			foreach($zones as $timezone){
-				if($timezone['offset'] == $offset){
+				if($timezone['timezone_id'] !== null && $timezone['offset'] == $offset){
 					return $timezone['timezone_id'];
 				}
 			}

src/world/World.php

@@ -67,6 +67,7 @@ use pocketmine\network\mcpe\protocol\BlockActorDataPacket;
 use pocketmine\network\mcpe\protocol\ClientboundPacket;
 use pocketmine\network\mcpe\protocol\types\BlockPosition;
 use pocketmine\network\mcpe\protocol\UpdateBlockPacket;
+use pocketmine\player\ChunkSelector;
 use pocketmine\player\Player;
 use pocketmine\promise\Promise;
 use pocketmine\promise\PromiseResolver;
@@ -318,7 +319,6 @@ class World implements ChunkManager{
 	private int $sleepTicks = 0;
 
 	private int $chunkTickRadius;
-	private int $chunksPerTick;
 	private int $tickedBlocksPerSubchunkPerTick = self::DEFAULT_TICKED_BLOCKS_PER_SUBCHUNK_PER_TICK;
 	/**
 	 * @var true[]
@@ -492,7 +492,11 @@ class World implements ChunkManager{
 
 		$cfg = $this->server->getConfigGroup();
 		$this->chunkTickRadius = min($this->server->getViewDistance(), max(1, $cfg->getPropertyInt("chunk-ticking.tick-radius", 4)));
-		$this->chunksPerTick = $cfg->getPropertyInt("chunk-ticking.per-tick", 40);
+		if($cfg->getPropertyInt("chunk-ticking.per-tick", 40) <= 0){
+			//TODO: this needs l10n
+			$this->logger->warning("\"chunk-ticking.per-tick\" setting is deprecated, but you've used it to disable chunk ticking. Set \"chunk-ticking.tick-radius\" to 0 in \"pocketmine.yml\" instead.");
+			$this->chunkTickRadius = 0;
+		}
 		$this->tickedBlocksPerSubchunkPerTick = $cfg->getPropertyInt("chunk-ticking.blocks-per-subchunk-per-tick", self::DEFAULT_TICKED_BLOCKS_PER_SUBCHUNK_PER_TICK);
 		$this->maxConcurrentChunkPopulationTasks = $cfg->getPropertyInt("chunk-generation.population-queue-size", 2);
 
@@ -1124,7 +1128,7 @@ class World implements ChunkManager{
 	}
 
 	private function tickChunks() : void{
-		if($this->chunksPerTick <= 0 || count($this->tickingLoaders) === 0){
+		if($this->chunkTickRadius <= 0 || count($this->tickingLoaders) === 0){
 			return;
 		}
 
@@ -1133,19 +1137,15 @@ class World implements ChunkManager{
 		/** @var bool[] $chunkTickList chunkhash => dummy */
 		$chunkTickList = [];
 
-		$chunksPerLoader = min(200, max(1, (int) ((($this->chunksPerTick - count($this->tickingLoaders)) / count($this->tickingLoaders)) + 0.5)));
-		$randRange = 3 + $chunksPerLoader / 30;
-		$randRange = (int) ($randRange > $this->chunkTickRadius ? $this->chunkTickRadius : $randRange);
-
+		$selector = new ChunkSelector();
 		foreach($this->tickingLoaders as $loader){
-			$chunkX = (int) floor($loader->getX()) >> Chunk::COORD_BIT_SIZE;
-			$chunkZ = (int) floor($loader->getZ()) >> Chunk::COORD_BIT_SIZE;
-
-			for($chunk = 0; $chunk < $chunksPerLoader; ++$chunk){
-				$dx = mt_rand(-$randRange, $randRange);
-				$dz = mt_rand(-$randRange, $randRange);
-				$hash = World::chunkHash($dx + $chunkX, $dz + $chunkZ);
-				if(!isset($chunkTickList[$hash]) && isset($this->chunks[$hash]) && $this->isChunkTickable($dx + $chunkX, $dz + $chunkZ)){
+			foreach($selector->selectChunks(
+				$this->chunkTickRadius,
+				(int) floor($loader->getX()) >> Chunk::COORD_BIT_SIZE,
+				(int) floor($loader->getZ()) >> Chunk::COORD_BIT_SIZE
+			) as $hash){
+				World::getXZ($hash, $chunkX, $chunkZ);
+				if(!isset($chunkTickList[$hash]) && isset($this->chunks[$hash]) && $this->isChunkTickable($chunkX, $chunkZ)){
 					$chunkTickList[$hash] = true;
 				}
 			}