Release 5.1.1

closes #5802

.github/dependabot.yml

@@ -6,6 +6,12 @@ updates:
     interval: daily
     time: "10:00"
   open-pull-requests-limit: 10
+  ignore:
+    #only allow patch updates for locale-data - this has to be updated manually due to codegen
+    - dependency-name: pocketmine/locale-data
+      update-types:
+        - "version-update:semver-major"
+        - "version-update:semver-minor"
 
 - package-ecosystem: gitsubmodule
   directory: "/"

.github/workflows/build-docker-image.yml

@@ -20,6 +20,13 @@ jobs:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Clone pmmp/PocketMine-Docker repository
         uses: actions/checkout@v3
         with:
@@ -30,68 +37,68 @@ jobs:
         id: tag-name
         run: |
           VERSION=$(echo "${{ github.ref }}" | sed 's{^refs/tags/{{')
-          echo ::set-output name=TAG_NAME::$VERSION
-          echo ::set-output name=MAJOR::$(echo $VERSION | cut -d. -f1)
-          echo ::set-output name=MINOR::$(echo $VERSION | cut -d. -f1-2)
+          echo TAG_NAME=$VERSION >> $GITHUB_OUTPUT
+          echo MAJOR=$(echo $VERSION | cut -d. -f1) >> $GITHUB_OUTPUT
+          echo MINOR=$(echo $VERSION | cut -d. -f1-2) >> $GITHUB_OUTPUT
 
       - name: Download new release information
         run: curl -f -L ${{ github.server_url }}/${{ github.repository }}/releases/download/${{ steps.tag-name.outputs.TAG_NAME }}/build_info.json -o new_build_info.json
 
       - name: Detect channel
         id: channel
-        run: echo ::set-output name=CHANNEL::$(jq -r '.channel' new_build_info.json)
+        run: echo CHANNEL=$(jq -r '.channel' new_build_info.json) >> $GITHUB_OUTPUT
 
       - name: Get name of Docker repository name
         id: docker-repo-name
-        run: echo ::set-output name=NAME::$(echo "${GITHUB_REPOSITORY,,}")
+        run: echo NAME=$(echo "${GITHUB_REPOSITORY,,}") >> $GITHUB_OUTPUT
 
       - name: Build image for tag
-        uses: docker/build-push-action@v3.1.1
+        uses: docker/build-push-action@v4.0.0
         with:
           push: true
           context: ./pocketmine-mp
           tags: |
             ${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.TAG_NAME }}
-#            ghcr.io/${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.TAG_NAME }}
+            ghcr.io/${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.TAG_NAME }}
           build-args: |
             PMMP_TAG=${{ steps.tag-name.outputs.TAG_NAME }}
             PMMP_REPO=${{ github.repository }}
 
       - name: Build image for major tag
         if: steps.channel.outputs.CHANNEL == 'stable'
-        uses: docker/build-push-action@v3.1.1
+        uses: docker/build-push-action@v4.0.0
         with:
           push: true
           context: ./pocketmine-mp
           tags: |
             ${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.MAJOR }}
-#            ghcr.io/${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.MAJOR }}
+            ghcr.io/${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.MAJOR }}
           build-args: |
             PMMP_TAG=${{ steps.tag-name.outputs.TAG_NAME }}
             PMMP_REPO=${{ github.repository }}
 
       - name: Build image for minor tag
         if: steps.channel.outputs.CHANNEL == 'stable'
-        uses: docker/build-push-action@v3.1.1
+        uses: docker/build-push-action@v4.0.0
         with:
           push: true
           context: ./pocketmine-mp
           tags: |
             ${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.MINOR }}
-#            ghcr.io/${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.MINOR }}
+            ghcr.io/${{ steps.docker-repo-name.outputs.NAME }}:${{ steps.tag-name.outputs.MINOR }}
           build-args: |
             PMMP_TAG=${{ steps.tag-name.outputs.TAG_NAME }}
             PMMP_REPO=${{ github.repository }}
 
       - name: Build image for latest tag
         if: steps.channel.outputs.CHANNEL == 'stable'
-        uses: docker/build-push-action@v3.1.1
+        uses: docker/build-push-action@v4.0.0
         with:
           push: true
           context: ./pocketmine-mp
           tags: |
             ${{ steps.docker-repo-name.outputs.NAME }}:latest
-#            ghcr.io/${{ steps.docker-repo-name.outputs.NAME }}:latest
+            ghcr.io/${{ steps.docker-repo-name.outputs.NAME }}:latest
           build-args: |
             PMMP_TAG=${{ steps.tag-name.outputs.TAG_NAME }}
             PMMP_REPO=${{ github.repository }}

.github/workflows/discord-release-embed.php

@@ -18,8 +18,9 @@ require dirname(__DIR__, 2) . '/vendor/autoload.php';
 /**
  * @phpstan-return array<string, mixed>
  */
-function generateDiscordEmbed(string $version, string $channel, string $description, string $detailsUrl, string $sourceUrl, string $pharDownloadUrl, string $buildLogUrl) : array{
+function generateDiscordEmbed(string $version, string $channel, string $description, string $detailsUrl, string $sourceUrl, string $pharDownloadUrl, string $buildLogUrl, int $newsPingRoleId) : array{
 	return [
+		"content" => "<@&$newsPingRoleId> New PocketMine-MP release: $version ($channel)",
 		"embeds" => [
 			[
 				"title" => "New PocketMine-MP release: $version ($channel)",
@@ -35,11 +36,11 @@ DESCRIPTION,
 	];
 }
 
-if(count($argv) !== 5){
-	fwrite(STDERR, "Required arguments: github repo, version, API token\n");
+if(count($argv) !== 6){
+	fwrite(STDERR, "Required arguments: github repo, version, API token, webhook URL, ping role ID\n");
 	exit(1);
 }
-[, $repo, $tagName, $token, $hookURL] = $argv;
+[, $repo, $tagName, $token, $hookURL, $newsPingRoleId] = $argv;
 
 $result = Internet::getURL('https://api.github.com/repos/' . $repo . '/releases/tags/' . $tagName, extraHeaders: [
 	'Authorization: token ' . $token
@@ -86,7 +87,7 @@ $buildLogUrl = $buildInfoJson["build_log_url"];
 
 $description = $releaseInfoJson["body"];
 
-$discordPayload = generateDiscordEmbed($buildInfoJson["base_version"], $buildInfoJson["channel"], $description, $detailsUrl, $sourceUrl, $pharDownloadUrl, $buildLogUrl);
+$discordPayload = generateDiscordEmbed($buildInfoJson["base_version"], $buildInfoJson["channel"], $description, $detailsUrl, $sourceUrl, $pharDownloadUrl, $buildLogUrl, (int) $newsPingRoleId);
 
 $response = Internet::postURL(
 	$hookURL,

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

@@ -13,9 +13,9 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Setup PHP and tools
-        uses: shivammathur/setup-php@2.21.2
+        uses: shivammathur/setup-php@2.25.2
         with:
-          php-version: 8.0
+          php-version: 8.1
 
       - name: Restore Composer package cache
         uses: actions/cache@v3
@@ -32,7 +32,7 @@ jobs:
 
       - name: Get actual tag name
         id: tag-name
-        run: echo ::set-output name=TAG_NAME::$(echo "${{ github.ref }}" | sed 's{^refs/tags/{{')
+        run: echo TAG_NAME=$(echo "${{ github.ref }}" | sed 's{^refs/tags/{{') >> $GITHUB_OUTPUT
 
       - name: Run webhook post script
-        run: php .github/workflows/discord-release-embed.php ${{ github.repository }} ${{ steps.tag-name.outputs.TAG_NAME }} ${{ github.token }} ${{ secrets.DISCORD_RELEASE_WEBHOOK }}
+        run: php .github/workflows/discord-release-embed.php ${{ github.repository }} ${{ steps.tag-name.outputs.TAG_NAME }} ${{ github.token }} ${{ secrets.DISCORD_RELEASE_WEBHOOK }} ${{ secrets.DISCORD_NEWS_PING_ROLE_ID }}

.github/workflows/draft-release.yml

@@ -18,9 +18,9 @@ jobs:
           submodules: true
 
       - name: Setup PHP
-        uses: shivammathur/setup-php@2.21.2
+        uses: shivammathur/setup-php@2.25.2
         with:
-          php-version: 8.0
+          php-version: 8.1
 
       - name: Restore Composer package cache
         uses: actions/cache@v3
@@ -40,7 +40,7 @@ jobs:
         run: |
           BUILD_NUMBER=$((2000+$GITHUB_RUN_NUMBER)) #to stay above jenkins
           echo "Build number: $BUILD_NUMBER"
-          echo ::set-output name=BUILD_NUMBER::$BUILD_NUMBER
+          echo BUILD_NUMBER=$BUILD_NUMBER >> $GITHUB_OUTPUT
 
       - name: Minify BedrockData JSON files
         run: php vendor/pocketmine/bedrock-data/.minify_json.php
@@ -51,10 +51,12 @@ jobs:
       - name: Get PocketMine-MP release version
         id: get-pm-version
         run: |
-          echo ::set-output name=PM_VERSION::$(php -r 'require "vendor/autoload.php"; echo \pocketmine\VersionInfo::BASE_VERSION;')
-          echo ::set-output name=MCPE_VERSION::$(php -r 'require "vendor/autoload.php"; echo \pocketmine\network\mcpe\protocol\ProtocolInfo::MINECRAFT_VERSION_NETWORK;')
-          echo ::set-output name=PM_VERSION_SHORT::$(php -r 'require "vendor/autoload.php"; $v = explode(".", \pocketmine\VersionInfo::BASE_VERSION); array_pop($v); echo implode(".", $v);')
-          echo ::set-output name=PM_VERSION_MD::$(php -r 'require "vendor/autoload.php"; echo str_replace(".", "", \pocketmine\VersionInfo::BASE_VERSION);')
+          echo PM_VERSION=$(php -r 'require "vendor/autoload.php"; echo \pocketmine\VersionInfo::BASE_VERSION;') >> $GITHUB_OUTPUT
+          echo MCPE_VERSION=$(php -r 'require "vendor/autoload.php"; echo \pocketmine\network\mcpe\protocol\ProtocolInfo::MINECRAFT_VERSION_NETWORK;') >> $GITHUB_OUTPUT
+          echo PM_VERSION_SHORT=$(php -r 'require "vendor/autoload.php"; $v = explode(".", \pocketmine\VersionInfo::BASE_VERSION); array_pop($v); echo implode(".", $v);') >> $GITHUB_OUTPUT
+          echo PM_VERSION_MD=$(php -r 'require "vendor/autoload.php"; echo str_replace(".", "", \pocketmine\VersionInfo::BASE_VERSION);') >> $GITHUB_OUTPUT
+          echo CHANGELOG_SUFFIX=$(php -r 'require "vendor/autoload.php"; echo \pocketmine\VersionInfo::BUILD_CHANNEL === "stable" ? "" : "-" . \pocketmine\VersionInfo::BUILD_CHANNEL;') >> $GITHUB_OUTPUT
+          echo PRERELEASE=$(php -r 'require "vendor/autoload.php"; echo \pocketmine\VersionInfo::BUILD_CHANNEL === "stable" ? "false" : "true";') >> $GITHUB_OUTPUT
 
       - name: Generate build info
         run: php build/generate-build-info-json.php ${{ github.sha }} ${{ steps.get-pm-version.outputs.PM_VERSION }} ${{ github.repository }} ${{ steps.build-number.outputs.BUILD_NUMBER }} ${{ github.run_id }} > build_info.json
@@ -69,15 +71,16 @@ jobs:
             ${{ github.workspace }}/build_info.json
 
       - name: Create draft release
-        uses: ncipollo/release-action@v1.10.0
+        uses: ncipollo/release-action@v1.12.0
         with:
           artifacts: ${{ github.workspace }}/PocketMine-MP.phar,${{ github.workspace }}/start.*,${{ github.workspace }}/build_info.json
           commit: ${{ github.sha }}
           draft: true
+          prerelease: ${{ steps.get-pm-version.outputs.PRERELEASE }}
           name: PocketMine-MP ${{ steps.get-pm-version.outputs.PM_VERSION }}
           tag: ${{ steps.get-pm-version.outputs.PM_VERSION }}
           token: ${{ secrets.GITHUB_TOKEN }}
           body: |
             **For Minecraft: Bedrock Edition ${{ steps.get-pm-version.outputs.MCPE_VERSION }}**
 
-            Please see the [changelogs](${{ github.server_url }}/${{ github.repository }}/blob/${{ steps.get-pm-version.outputs.PM_VERSION }}/changelogs/${{ steps.get-pm-version.outputs.PM_VERSION_SHORT }}.md#${{ steps.get-pm-version.outputs.PM_VERSION_MD }}) for details.
+            Please see the [changelogs](${{ github.server_url }}/${{ github.repository }}/blob/${{ steps.get-pm-version.outputs.PM_VERSION }}/changelogs/${{ steps.get-pm-version.outputs.PM_VERSION_SHORT }}${{ steps.get-pm-version.outputs.CHANGELOG_SUFFIX }}.md#${{ steps.get-pm-version.outputs.PM_VERSION_MD }}) for details.

.github/workflows/main.yml

@@ -6,44 +6,25 @@ on:
   workflow_dispatch:
 
 jobs:
-  build-php:
-    name: Prepare PHP
-    runs-on: ${{ matrix.image }}
-
-    strategy:
-      matrix:
-        image: [ubuntu-20.04]
-        php: [8.0.23, 8.1.10]
-
-    steps:
-      - name: Build and prepare PHP cache
-        uses: pmmp/setup-php-action@82a44d659bf5046612c69f036af3e14dc32e3fa8
-        with:
-          php-version: ${{ matrix.php }}
-          install-path: "./bin"
-
   phpstan:
     name: PHPStan analysis
-    needs: build-php
     runs-on: ${{ matrix.image }}
 
     strategy:
       fail-fast: false
       matrix:
         image: [ubuntu-20.04]
-        php: [8.0.23, 8.1.10]
+        php: ["8.1", "8.2"]
 
     steps:
       - uses: actions/checkout@v3
 
       - name: Setup PHP
-        uses: pmmp/setup-php-action@82a44d659bf5046612c69f036af3e14dc32e3fa8
+        uses: pmmp/setup-php-action@2.0.0
         with:
           php-version: ${{ matrix.php }}
           install-path: "./bin"
-
-      - name: Install Composer
-        run: curl -sS https://getcomposer.org/installer | php
+          pm-version-major: "5"
 
       - name: Restore Composer package cache
         uses: actions/cache@v3
@@ -56,32 +37,29 @@ jobs:
             composer-v2-cache-
 
       - name: Install Composer dependencies
-        run: php composer.phar install --prefer-dist --no-interaction
+        run: composer install --prefer-dist --no-interaction
 
       - name: Run PHPStan
         run: ./vendor/bin/phpstan analyze --no-progress --memory-limit=2G
 
   phpunit:
     name: PHPUnit tests
-    needs: build-php
     runs-on: ${{ matrix.image }}
     strategy:
       fail-fast: false
       matrix:
         image: [ubuntu-20.04]
-        php: [8.0.23, 8.1.10]
+        php: ["8.1", "8.2"]
 
     steps:
       - uses: actions/checkout@v3
 
       - name: Setup PHP
-        uses: pmmp/setup-php-action@82a44d659bf5046612c69f036af3e14dc32e3fa8
+        uses: pmmp/setup-php-action@2.0.0
         with:
           php-version: ${{ matrix.php }}
           install-path: "./bin"
-
-      - name: Install Composer
-        run: curl -sS https://getcomposer.org/installer | php
+          pm-version-major: "5"
 
       - name: Restore Composer package cache
         uses: actions/cache@v3
@@ -94,20 +72,19 @@ jobs:
             composer-v2-cache-
 
       - name: Install Composer dependencies
-        run: php composer.phar install --prefer-dist --no-interaction
+        run: composer install --prefer-dist --no-interaction
 
       - name: Run PHPUnit tests
         run: ./vendor/bin/phpunit --bootstrap vendor/autoload.php --fail-on-warning tests/phpunit
 
   integration:
     name: Integration tests
-    needs: build-php
     runs-on: ${{ matrix.image }}
     strategy:
       fail-fast: false
       matrix:
         image: [ubuntu-20.04]
-        php: [8.0.23, 8.1.10]
+        php: ["8.1", "8.2"]
 
     steps:
       - uses: actions/checkout@v3
@@ -115,13 +92,11 @@ jobs:
           submodules: true
 
       - name: Setup PHP
-        uses: pmmp/setup-php-action@82a44d659bf5046612c69f036af3e14dc32e3fa8
+        uses: pmmp/setup-php-action@2.0.0
         with:
           php-version: ${{ matrix.php }}
           install-path: "./bin"
-
-      - name: Install Composer
-        run: curl -sS https://getcomposer.org/installer | php
+          pm-version-major: "5"
 
       - name: Restore Composer package cache
         uses: actions/cache@v3
@@ -134,32 +109,29 @@ jobs:
             composer-v2-cache-
 
       - name: Install Composer dependencies
-        run: php composer.phar install --no-dev --prefer-dist --no-interaction
+        run: composer install --no-dev --prefer-dist --no-interaction
 
       - name: Run integration tests
         run: ./tests/travis.sh -t4
 
   codegen:
     name: Generated Code consistency checks
-    needs: build-php
     runs-on: ${{ matrix.image }}
     strategy:
       fail-fast: false
       matrix:
         image: [ubuntu-20.04]
-        php: [8.0.23, 8.1.10]
+        php: ["8.1", "8.2"]
 
     steps:
       - uses: actions/checkout@v3
 
       - name: Setup PHP
-        uses: pmmp/setup-php-action@82a44d659bf5046612c69f036af3e14dc32e3fa8
+        uses: pmmp/setup-php-action@2.0.0
         with:
           php-version: ${{ matrix.php }}
           install-path: "./bin"
-
-      - name: Install Composer
-        run: curl -sS https://getcomposer.org/installer | php
+          pm-version-major: "5"
 
       - name: Restore Composer package cache
         uses: actions/cache@v3
@@ -172,7 +144,7 @@ jobs:
             composer-v2-cache-
 
       - name: Install Composer dependencies
-        run: php composer.phar install --no-dev --prefer-dist --no-interaction
+        run: composer install --no-dev --prefer-dist --no-interaction
 
       - name: Regenerate registry annotations
         run: php build/generate-registry-annotations.php src
@@ -183,6 +155,9 @@ jobs:
       - name: Regenerate RuntimeEnum(De)serializer
         run: php build/generate-runtime-enum-serializers.php
 
+      - name: Regenerate BedrockData available files constants
+        run: php build/generate-bedrockdata-path-consts.php
+
       - name: Verify code is unchanged
         run: |
           git diff
@@ -198,10 +173,12 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Setup PHP and tools
-        uses: shivammathur/setup-php@2.21.2
+        uses: shivammathur/setup-php@2.25.2
         with:
-          php-version: 8.0
-          tools: php-cs-fixer:3.11
+          php-version: 8.1
+          tools: php-cs-fixer:3.17
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Run PHP-CS-Fixer
         run: php-cs-fixer fix --dry-run --diff --ansi

.github/workflows/support.yml

@@ -8,7 +8,7 @@ jobs:
   support:
     runs-on: ubuntu-latest
     steps:
-      - uses: dessant/support-requests@v2
+      - uses: dessant/support-requests@v3
         with:
           github-token: ${{ github.token }}
           support-label:  "Support request"

.github/workflows/update-php-versions.php

@@ -1,50 +0,0 @@
-<?php
-
-/*
- *
- *  ____            _        _   __  __ _                  __  __ ____
- * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
- * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
- * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
- * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * @author PocketMine Team
- * @link http://www.pocketmine.net/
- *
- *
-*/
-
-declare(strict_types=1);
-
-const VERSIONS = [
-	"8.0",
-	"8.1"
-];
-
-$workflowFile = file_get_contents(__DIR__ . '/main.yml');
-$newWorkflowFile = $workflowFile;
-foreach(VERSIONS as $v){
-	$releaseInfo = file_get_contents("https://secure.php.net/releases?json&version=$v");
-	if($releaseInfo === false){
-		throw new \RuntimeException("Failed to contact php.net API");
-	}
-	$data = json_decode($releaseInfo, true);
-	if(!is_array($data) || !isset($data["version"]) || !is_string($data["version"]) || preg_match('/^\d+\.\d+\.\d+(-[A-Za-z\d]+)?$/', $data["version"]) === 0){
-		throw new \RuntimeException("Invalid data returned by API");
-	}
-	$updated = preg_replace("/$v\.\d+/", $data["version"], $newWorkflowFile);
-	if($updated !== $newWorkflowFile){
-		echo "Updated $v revision to " . $data["version"] . "\n";
-	}
-	$newWorkflowFile = $updated;
-}
-
-if($workflowFile !== $newWorkflowFile){
-	echo "Writing modified workflow file\n";
-	file_put_contents(__DIR__ . '/main.yml', $newWorkflowFile);
-}

.github/workflows/update-updater-api.yml

@@ -15,23 +15,68 @@ jobs:
 
       - uses: actions/checkout@v3
         with:
-          repository: pmmp/update.pmmp.io
+          repository: ${{ github.repository_owner }}/update.pmmp.io
           ssh-key: ${{ secrets.UPDATE_PMMP_IO_DEPLOY_KEY }}
 
       - name: Get actual tag name
         id: tag-name
-        run: echo ::set-output name=TAG_NAME::$(echo "${{ github.ref }}" | sed 's{^refs/tags/{{')
+        run: echo TAG_NAME=$(echo "${{ github.ref }}" | sed 's{^refs/tags/{{') >> $GITHUB_OUTPUT
 
       - name: Download new release information
         run: curl -f -L ${{ github.server_url }}/${{ github.repository }}/releases/download/${{ steps.tag-name.outputs.TAG_NAME }}/build_info.json -o new_build_info.json
 
-      - name: Detect channel
+      - name: Detect channels
         id: channel
-        run: echo ::set-output name=CHANNEL::$(jq -r '.channel' new_build_info.json)
-
-      - name: Copy release information
         run: |
-          cp new_build_info.json channels/${{ steps.channel.outputs.CHANNEL }}.json
+          CHANNEL=$(jq -r '.channel' new_build_info.json)
+          VERSION=${{ steps.tag-name.outputs.TAG_NAME }}
+          echo CHANNEL=$CHANNEL >> $GITHUB_OUTPUT
+          if [ "$CHANNEL" == "stable" ]; then
+            echo MAJOR=$(echo $VERSION | cut -d. -f1) >> $GITHUB_OUTPUT
+            echo MINOR=$(echo $VERSION | cut -d. -f1-2) >> $GITHUB_OUTPUT
+          else
+            echo MAJOR=$(echo $VERSION | cut -d. -f1)-$CHANNEL >> $GITHUB_OUTPUT
+            echo MINOR=$(echo $VERSION | cut -d. -f1-2)-$CHANNEL >> $GITHUB_OUTPUT
+          fi
+
+      - name: Update channel info
+        run: |
+          function version_id() {
+            major=$(echo $1 | cut -d. -f1)
+            minor=$(echo $1 | cut -d. -f2)
+            patch=$(echo $1 | cut -d. -f3)
+            echo $(((major * 1000000) + (minor * 1000) + patch))
+          }
+
+          function update_channel() {
+            local target_file_name="$1"
+            local new_file_name="$2"
+
+            local old_version_id
+            local new_version_id
+
+            if [ ! -f "$target_file_name" ]; then
+              echo "Creating channel file: $target_file_name"
+              cp "$new_file_name" "$target_file_name"
+            else
+              old_version_id=$(version_id "$(jq -r '.base_version' "$target_file_name")")
+              new_version_id=$(version_id "$(jq -r '.base_version' "$new_file_name")")
+
+              echo "Old version ID: $old_version_id"
+              echo "New version ID: $new_version_id"
+
+              if [ $new_version_id -ge $old_version_id ]; then #suffixed versions will have the same version ID - assume they'll always be newer
+                echo "Updating channel file: $target_file_name ($old_version_id -> $new_version_id)"
+                cp "$new_file_name" "$target_file_name"
+              else
+                echo "Version $new_version_id is less than $old_version_id, not updating channel file: $target_file_name"
+              fi
+            fi
+          }
+
+          update_channel "channels/${{ steps.channel.outputs.CHANNEL }}.json" "new_build_info.json"
+          update_channel "channels/${{ steps.channel.outputs.MAJOR }}.json" "new_build_info.json"
+          update_channel "channels/${{ steps.channel.outputs.MINOR }}.json" "new_build_info.json"
           rm new_build_info.json
 
       - name: Commit changes

.idea/codeStyles/Project.xml

@@ -30,6 +30,13 @@
         <option name="USE_TAB_CHARACTER" value="true" />
       </indentOptions>
     </codeStyleSettings>
+    <codeStyleSettings language="Markdown">
+      <indentOptions>
+        <option name="INDENT_SIZE" value="2" />
+        <option name="CONTINUATION_INDENT_SIZE" value="2" />
+        <option name="TAB_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
     <codeStyleSettings language="PHP">
       <option name="CLASS_BRACE_STYLE" value="1" />
       <option name="METHOD_BRACE_STYLE" value="1" />
@@ -62,6 +69,11 @@
         <option name="USE_TAB_CHARACTER" value="true" />
       </indentOptions>
     </codeStyleSettings>
+    <codeStyleSettings language="Shell Script">
+      <indentOptions>
+        <option name="USE_TAB_CHARACTER" value="true" />
+      </indentOptions>
+    </codeStyleSettings>
     <codeStyleSettings language="neon">
       <indentOptions>
         <option name="USE_TAB_CHARACTER" value="true" />

.php-cs-fixer.php

@@ -66,6 +66,9 @@ BODY,
 		],
 		'indentation_type' => true,
 		'logical_operators' => true,
+		'native_constant_invocation' => [
+			'scope' => 'namespaced'
+		],
 		'native_function_invocation' => [
 			'scope' => 'namespaced',
 			'include' => ['@all'],
@@ -92,6 +95,12 @@ BODY,
 			],
 			'sort_algorithm' => 'alpha'
 		],
+		'phpdoc_align' => [
+			'align' => 'vertical',
+			'tags' => [
+				'param',
+			]
+		],
 		'phpdoc_line_span' => [
 			'property' => 'single',
 			'method' => null,

BUILDING.md

@@ -2,13 +2,13 @@
 ## Pre-requisites
 - A bash shell (git bash is sufficient for Windows)
 - [`git`](https://git-scm.com) available in your shell
-- PHP 8.0 or newer available in your shell
+- PHP 8.1 or newer available in your shell
 - [`composer`](https://getcomposer.org) available in your shell
 
 ## Custom PHP binaries
 Because PocketMine-MP requires several non-standard PHP extensions and configuration, PMMP provides scripts to build custom binaries for running PocketMine-MP, as well as prebuilt binaries.
 
-- [Prebuilt binaries](https://jenkins.pmmp.io/job/PHP-8.0-Aggregate)
+- [Prebuilt binaries](https://github.com/pmmp/PHP-Binaries/releases)
 - [Compile scripts](https://github.com/pmmp/php-build-scripts) are provided as a submodule in the path `build/php`
 
 If you use a custom binary, you'll need to replace `composer` usages in this guide with `path/to/your/php path/to/your/composer.phar`.
@@ -29,11 +29,5 @@ Run `composer make-server` using your preferred PHP binary. It'll drop a `Pocket
 
 You can also use the `--out` option to change the output filename.
 
-There is a bug in PHP that might cause an error which looks like this:
-```
-Fatal error: Uncaught BadMethodCallException: unable to create temporary file in PocketMine-MP/build/server-phar.php:119
-```
-You can work around it by setting `ulimit -n` to some bigger number, e.g. `8192`, or by updating your PHP version to at least 8.0.3.
-
 ## Running PocketMine-MP from source code
 Run `src/PocketMine.php` using your preferred PHP binary.

CONTRIBUTING.md

@@ -18,6 +18,59 @@ Larger contributions like feature additions should be preceded by a [Change Prop
 ## Other things you'll need
 - [git](https://git-scm.com/)
 
+## List of `pocketmine` namespaces which are in other repos
+PocketMine-MP has several dependencies which are independent from the main server code. Most of them use the `pocketmine` namespace.
+Some of these add extra classes to packages which already exist in PocketMine-MP.
+
+Take a look at the table below if you can't find the class or function you're looking for.
+
+| Source URL                                                      | Namespace, class or function                                                                                                             |
+|:----------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|
+| [pmmp/BedrockProtocol](https://github.com/pmmp/BedrockProtocol) | `pocketmine\network\mcpe\protocol`                                                                                                       |
+| [pmmp/BinaryUtils](https://github.com/pmmp/BinaryUtils)         | `pocketmine\utils\BinaryDataException`</br>`pocketmine\utils\BinaryStream`</br>`pocketmine\utils\Binary`                                 |
+| [pmmp/Color](https://github.com/pmmp/Color)                     | `pocketmine\color`                                                                                                                       |
+| [pmmp/ErrorHandler](https://github.com/pmmp/ErrorHandler)       | `pocketmine\errorhandler`                                                                                                                |
+| [pmmp/Log](https://github.com/pmmp/Log)                         | `AttachableLogger`</br>`BufferedLogger`</br>`GlobalLogger`</br>`LogLevel`</br>`Logger`</br>`PrefixedLogger`</br>`SimpleLogger`           |
+| [pmmp/Math](https://github.com/pmmp/Math)                       | `pocketmine\math`                                                                                                                        |
+| [pmmp/NBT](https://github.com/pmmp/NBT)                         | `pocketmine\nbt`                                                                                                                         |
+| [pmmp/RakLibIpc](https://github.com/pmmp/RakLibIpc)             | `raklib\server\ipc`                                                                                                                      |
+| [pmmp/RakLib](https://github.com/pmmp/RakLib)                   | `raklib`                                                                                                                                 |
+| [pmmp/Snooze](https://github.com/pmmp/Snooze)                   | `pocketmine\snooze`                                                                                                                      |
+| [pmmp/ext-chunkutils2](https://github.com/pmmp/ext-chunkutils2) | `pocketmine\world\format\LightArray`</br>`pocketmine\world\format\PalettedBlockArray`</br>`pocketmine\world\format\io\SubChunkConverter` |
+| [pmmp/ext-morton](https://github.com/pmmp/ext-morton)           | `morton2d_decode`</br>`morton2d_encode`</br>`morton3d_decode`</br>`morton3d_encode`                                                      |
+| [pmmp/ext-libdeflate](https://github.com/pmmp/ext-libdeflate)   | `libdeflate_deflate_compress`</br>`libdeflate_gzip_compress`</br>`libdeflate_zlib_compress`                                              |
+
+## Choosing a target branch
+PocketMine-MP has three primary branches of development.
+
+| Type of change                                                                              | `stable` |          `minor-next`           | `major-next` |
+|:--------------------------------------------------------------------------------------------|:--------:|:-------------------------------:|:------------:|
+| Bug fixes                                                                                   |    ✔️    |               ✔️                |      ✔️      |
+| Improvements to API docs                                                                    |    ✔️    |               ✔️                |      ✔️      |
+| Cleaning up code                                                                            |    ❌     |               ✔️                |      ✔️      |
+| Changing code formatting or style                                                           |    ❌     |               ✔️                |      ✔️      |
+| Addition of new core features                                                               |    ❌     |    🟡 Only if non-disruptive    |      ✔️      |
+| Changing core behaviour (e.g. making something use threads)                                 |    ❌     |               ✔️                |      ✔️      |
+| Addition of new configuration options                                                       |    ❌     |       🟡 Only if optional       |      ✔️      |
+| Addition of new API classes, methods or constants                                           |    ❌     |               ✔️                |      ✔️      |
+| Deprecating API classes, methods or constants                                               |    ❌     |               ✔️                |      ✔️      |
+| Adding optional parameters to an API method                                                 |    ❌     |               ✔️                |      ✔️      |
+| Changing API behaviour                                                                      |    ❌     | 🟡 Only if backwards-compatible |      ✔️      |
+| Removal of API                                                                              |    ❌     |                ❌                |      ✔️      |
+| Backwards-incompatible API change (e.g. renaming a method)                                  |    ❌     |                ❌                |      ✔️      |
+| Backwards-incompatible internals change (e.g. changing things in `pocketmine\network\mcpe`) |    ❌     |               ✔️                |      ✔️      |
+
+### Notes
+- **Non-disruptive** means that usage should not be significantly altered by the change.
+  - Examples of **non-disruptive** changes include adding new commands, or gameplay features like blocks and items.
+  - Examples of **disruptive** changes include changing the way the server is run, world format changes (since those require downtime for the user to convert their world).
+- **API** includes all public and protected classes, functions and constants (unless marked as `@internal`).
+  - Private members are not part of the API, **unless in a trait**.
+  - The `pocketmine\network\mcpe` package is considered implicitly `@internal` in its entirety (see its [README](src/network/mcpe/README.md) for more details).
+- Minecraft's protocol changes are considered necessary internal changes, and are **not** subject to the same rules.
+  - Protocol changes must always be released in a new minor version, since they disrupt user experience by requiring a client update.
+- BC-breaking changes to the internal network API are allowed, but only in new minor versions. This ensures that plugins which use the internal network API will not break (though they shouldn't use such API anyway).
+
 ## Making a pull request
 The basic procedure to create a pull request is:
 1. [Fork the repository on GitHub](https://github.com/pmmp/PocketMine-MP/fork). This gives you your own copy of the repository to make changes to.

README.md

@@ -14,7 +14,6 @@
 <p align="center">
 	<a href="https://github.com/pmmp/PocketMine-MP/actions/workflows/main.yml"><img src="https://github.com/pmmp/PocketMine-MP/workflows/CI/badge.svg" alt="CI" /></a>
 	<a href="https://github.com/pmmp/PocketMine-MP/releases/latest"><img alt="GitHub release (latest SemVer)" src="https://img.shields.io/github/v/release/pmmp/PocketMine-MP?label=release&sort=semver"></a>
-	<a href="https://hub.docker.com/r/pmmp/pocketmine-mp"><img src="https://img.shields.io/docker/v/pmmp/pocketmine-mp?logo=docker&label=image" alt="Docker image version (latest semver)" /></a>
 	<a href="https://discord.gg/bmSAZBG"><img src="https://img.shields.io/discord/373199722573201408?label=discord&color=7289DA&logo=discord" alt="Discord" /></a>
 	<br>
 	<a href="https://github.com/pmmp/PocketMine-MP/releases"><img alt="GitHub all releases" src="https://img.shields.io/github/downloads/pmmp/PocketMine-MP/total?label=downloads%40total"></a>
@@ -24,7 +23,7 @@
 ## Getting started
 - [Documentation](http://pmmp.readthedocs.org/)
 - [Installation instructions](https://pmmp.readthedocs.io/en/rtfd/installation.html)
-- [Docker image](https://hub.docker.com/r/pmmp/pocketmine-mp)
+- [Docker image](https://github.com/pmmp/PocketMine-MP/pkgs/container/pocketmine-mp)
 - [Plugin repository](https://poggit.pmmp.io/plugins)
 
 ## Discussion/Help
@@ -36,7 +35,7 @@
  * [Building and running from source](BUILDING.md)
  * [Developer documentation](https://devdoc.pmmp.io) - General documentation for PocketMine-MP plugin developers
  * [Latest release API documentation](https://apidoc.pmmp.io) - Doxygen API documentation generated for each release
- * [Latest bleeding-edge API documentation](https://apidoc-dev.pmmp.io) - Doxygen API documentation generated weekly from `next-major` branch
+ * [Latest bleeding-edge API documentation](https://apidoc-dev.pmmp.io) - Doxygen API documentation generated weekly from `major-next` branch
  * [DevTools](https://github.com/pmmp/DevTools/) - Development tools plugin for creating plugins
  * [ExamplePlugin](https://github.com/pmmp/ExamplePlugin/) - Example plugin demonstrating some basic API features
  * [Contributing Guidelines](CONTRIBUTING.md)

build/generate-bedrockdata-path-consts.php

@@ -0,0 +1,128 @@
+<?php
+
+/*
+ *
+ *  ____            _        _   __  __ _                  __  __ ____
+ * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
+ * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
+ * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
+ * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * @author PocketMine Team
+ * @link http://www.pocketmine.net/
+ *
+ *
+ */
+
+declare(strict_types=1);
+
+namespace pocketmine\build\generate_bedrockdata_path_consts;
+
+use Symfony\Component\Filesystem\Path;
+use function dirname;
+use function fclose;
+use function fopen;
+use function fwrite;
+use function is_file;
+use function scandir;
+use function str_replace;
+use function strtoupper;
+use const PHP_EOL;
+use const pocketmine\BEDROCK_DATA_PATH;
+use const SCANDIR_SORT_ASCENDING;
+use const STDERR;
+
+require dirname(__DIR__) . '/vendor/autoload.php';
+
+function constantify(string $permissionName) : string{
+	return strtoupper(str_replace([".", "-"], "_", $permissionName));
+}
+
+$files = scandir(BEDROCK_DATA_PATH, SCANDIR_SORT_ASCENDING);
+if($files === false){
+	fwrite(STDERR, "Couldn't find any files in " . BEDROCK_DATA_PATH . PHP_EOL);
+	exit(1);
+}
+
+$consts = [];
+
+foreach($files as $file){
+	if($file === '.' || $file === '..'){
+		continue;
+	}
+	if($file[0] === '.'){
+		continue;
+	}
+	$path = Path::join(BEDROCK_DATA_PATH, $file);
+	if(!is_file($path)){
+		continue;
+	}
+
+	foreach([
+		'README.md',
+		'LICENSE',
+		'composer.json',
+	] as $ignored){
+		if($file === $ignored){
+			continue 2;
+		}
+	}
+
+	$consts[] = $file;
+}
+
+$output = fopen(dirname(__DIR__) . '/src/data/bedrock/BedrockDataFiles.php', 'wb');
+if($output === false){
+	fwrite(STDERR, "Couldn't open output file" . PHP_EOL);
+	exit(1);
+}
+fwrite($output, <<<'HEADER'
+<?php
+
+/*
+ *
+ *  ____            _        _   __  __ _                  __  __ ____
+ * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
+ * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
+ * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
+ * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * @author PocketMine Team
+ * @link http://www.pocketmine.net/
+ *
+ *
+ */
+
+declare(strict_types=1);
+
+namespace pocketmine\data\bedrock;
+
+use const pocketmine\BEDROCK_DATA_PATH;
+
+final class BedrockDataFiles{
+	private function __construct(){
+		//NOOP
+	}
+
+
+HEADER
+);
+
+foreach($consts as $constName => $fileName){
+	fwrite($output, "\tpublic const " . constantify($fileName) . " = BEDROCK_DATA_PATH . '/$fileName';\n");
+}
+
+fwrite($output, "}\n");
+fclose($output);
+
+echo "Done. Don't forget to run CS fixup after generating code.\n";

build/generate-block-serializer-consts.php

@@ -44,10 +44,13 @@ use function fwrite;
 use function is_string;
 use function ksort;
 use function mb_strtoupper;
+use function preg_replace;
 use function sort;
 use function strrpos;
 use function strtoupper;
 use function substr;
+use const SORT_STRING;
+use const STDERR;
 
 require dirname(__DIR__) . '/vendor/autoload.php';
 
@@ -136,7 +139,7 @@ function generateBlockStateNames(BlockPaletteReport $data) : void{
 
 	fwrite($output, generateClassHeader(BlockStateNames::class));
 	foreach(Utils::stringifyKeys($data->seenStateValues) as $state => $values){
-		$constName = mb_strtoupper($state, 'US-ASCII');
+		$constName = mb_strtoupper(preg_replace("/^minecraft:/", "", $state) ?? throw new AssumptionFailedError("This regex is not invalid"), 'US-ASCII');
 		fwrite($output, "\tpublic const $constName = \"$state\";\n");
 	}
 
@@ -156,7 +159,7 @@ function generateBlockStringValues(BlockPaletteReport $data) : void{
 				continue;
 			}
 			$anyWritten = true;
-			$constName = mb_strtoupper($stateName . "_" . $value, 'US-ASCII');
+			$constName = mb_strtoupper(preg_replace("/^minecraft:/", "", $stateName) . "_" . $value, 'US-ASCII');
 			fwrite($output, "\tpublic const $constName = \"$value\";\n");
 		}
 		if($anyWritten){

build/generate-item-type-names.php

@@ -36,6 +36,8 @@ use function file_get_contents;
 use function fopen;
 use function fwrite;
 use function strtoupper;
+use const SORT_STRING;
+use const STDERR;
 
 require dirname(__DIR__) . '/vendor/autoload.php';
 

build/generate-known-translation-apis.php

@@ -25,7 +25,7 @@ namespace pocketmine\build\generate_known_translation_apis;
 
 use pocketmine\lang\Translatable;
 use pocketmine\utils\Utils;
-use Webmozart\PathUtil\Path;
+use Symfony\Component\Filesystem\Path;
 use function array_map;
 use function count;
 use function dirname;

build/generate-registry-annotations.php

@@ -36,9 +36,10 @@ use function ksort;
 use function mb_strtoupper;
 use function preg_match;
 use function sprintf;
+use function str_ends_with;
 use function str_replace;
-use function substr;
 use const SORT_STRING;
+use const STDERR;
 
 if(count($argv) !== 2){
 	fwrite(STDERR, "Provide a path to process\n");
@@ -120,7 +121,7 @@ require dirname(__DIR__) . '/vendor/autoload.php';
 if(is_dir($argv[1])){
 	/** @var string $file */
 	foreach(new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($argv[1], \FilesystemIterator::SKIP_DOTS | \FilesystemIterator::CURRENT_AS_PATHNAME)) as $file){
-		if(substr($file, -4) !== ".php"){
+		if(!str_ends_with($file, ".php")){
 			continue;
 		}
 

build/generate-runtime-enum-serializers.php

@@ -30,9 +30,10 @@ use pocketmine\block\utils\DirtType;
 use pocketmine\block\utils\DyeColor;
 use pocketmine\block\utils\FroglightType;
 use pocketmine\block\utils\LeverFacing;
+use pocketmine\block\utils\MobHeadType;
 use pocketmine\block\utils\MushroomBlockType;
-use pocketmine\block\utils\SkullType;
 use pocketmine\block\utils\SlabType;
+use pocketmine\item\MedicineType;
 use pocketmine\item\PotionType;
 use pocketmine\item\SuspiciousStewType;
 use function array_key_first;
@@ -48,6 +49,7 @@ use function lcfirst;
 use function log;
 use function ob_get_clean;
 use function ob_start;
+use const SORT_STRING;
 
 require dirname(__DIR__) . '/vendor/autoload.php';
 
@@ -58,13 +60,12 @@ require dirname(__DIR__) . '/vendor/autoload.php';
  * @return string[]
  * @phpstan-return list<string>
  */
-function buildWriterFunc(string $virtualTypeName, string $nativeTypeName, array $memberNames, string &$functionName) : array{
+function buildWriterFunc(string $virtualTypeName, string $nativeTypeName, array $memberNames, string $functionName) : array{
 	$bits = getBitsRequired($memberNames);
 	$lines = [];
 
-	$functionName = lcfirst($virtualTypeName);
-	$lines[] = "public function $functionName(\\$nativeTypeName \$value) : void{";
-	$lines[] = "\t\$this->int($bits, match(\$value){";
+	$lines[] = "public function $functionName(\\$nativeTypeName &\$value) : void{";
+	$lines[] = "\t\$this->writeInt($bits, match(\$value){";
 
 	foreach($memberNames as $key => $memberName){
 		$lines[] = "\t\t$memberName => $key,";
@@ -83,11 +84,10 @@ function buildWriterFunc(string $virtualTypeName, string $nativeTypeName, array
  * @return string[]
  * @phpstan-return list<string>
  */
-function buildReaderFunc(string $virtualTypeName, string $nativeTypeName, array $memberNames, string &$functionName) : array{
+function buildReaderFunc(string $virtualTypeName, string $nativeTypeName, array $memberNames, string $functionName) : array{
 	$bits = getBitsRequired($memberNames);
 	$lines = [];
 
-	$functionName = lcfirst($virtualTypeName);
 	$lines[] = "public function $functionName(\\$nativeTypeName &\$value) : void{";
 	$lines[] = "\t\$value = match(\$this->readInt($bits)){";
 
@@ -101,6 +101,26 @@ function buildReaderFunc(string $virtualTypeName, string $nativeTypeName, array
 	return $lines;
 }
 
+function buildInterfaceFunc(string $nativeTypeName, string $functionName) : string{
+	return "public function $functionName(\\$nativeTypeName &\$value) : void;";
+}
+
+/**
+ * @param string[] $memberNames
+ * @phpstan-param list<string> $memberNames
+ *
+ * @return string[]
+ * @phpstan-return list<string>
+ */
+function buildSizeCalculationFunc(string $nativeTypeName, string $functionName, array $memberNames) : array{
+	$lines = [];
+	$lines[] = "public function $functionName(\\$nativeTypeName &\$value) : void{";
+	$lines[] = "\t\$this->addBits(" . getBitsRequired($memberNames) . ");";
+	$lines[] = "}";
+
+	return $lines;
+}
+
 /**
  * @param mixed[] $members
  */
@@ -120,43 +140,6 @@ function stringifyEnumMembers(array $members, string $enumClass) : array{
 	return array_map(fn(string $enumCaseName) => "\\$enumClass::$enumCaseName()", array_keys($members));
 }
 
-/**
- * @param object[] $enumMembers
- * @phpstan-param array<string, object> $enumMembers
- *
- * @return string[]
- * @phpstan-return list<string>
- */
-function buildEnumWriterFunc(array $enumMembers, string &$functionName) : array{
-	$reflect = new \ReflectionClass($enumMembers[array_key_first($enumMembers)]);
-	return buildWriterFunc(
-		$reflect->getShortName(),
-		$reflect->getName(),
-		stringifyEnumMembers($enumMembers, $reflect->getName()),
-		$functionName
-	);
-}
-
-/**
- * @param object[] $enumMembers
- * @phpstan-param array<string, object> $enumMembers
- *
- * @return string[]
- * @phpstan-return list<string>
- */
-function buildEnumReaderFunc(array $enumMembers, string &$functionName) : array{
-	if(count($enumMembers) === 0){
-		throw new \InvalidArgumentException("Enum members cannot be empty");
-	}
-	$reflect = new \ReflectionClass($enumMembers[array_key_first($enumMembers)]);
-	return buildReaderFunc(
-		$reflect->getShortName(),
-		$reflect->getName(),
-		stringifyEnumMembers($enumMembers, $reflect->getName()),
-		$functionName
-	);
-}
-
 $enumsUsed = [
 	BellAttachmentType::getAll(),
 	CopperOxidation::getAll(),
@@ -165,8 +148,9 @@ $enumsUsed = [
 	DyeColor::getAll(),
 	FroglightType::getAll(),
 	LeverFacing::getAll(),
+	MedicineType::getAll(),
 	MushroomBlockType::getAll(),
-	SkullType::getAll(),
+	MobHeadType::getAll(),
 	SlabType::getAll(),
 	SuspiciousStewType::getAll(),
 	PotionType::getAll()
@@ -179,25 +163,54 @@ $readerFuncs = [
 ];
 $writerFuncs = [
 	"" => [
-		"abstract public function int(int \$bits, int \$value) : void;"
+		"abstract protected function writeInt(int \$bits, int \$value) : void;"
+	]
+];
+$interfaceFuncs = [];
+$sizeCalculationFuncs = [
+	"" => [
+		"abstract protected function addBits(int \$bits) : void;"
 	]
 ];
-$functionName = "";
 
 foreach($enumsUsed as $enumMembers){
-	$writerF = buildEnumWriterFunc($enumMembers, $functionName);
-	/** @var string $functionName */
-	$writerFuncs[$functionName] = $writerF;
-	$readerF = buildEnumReaderFunc($enumMembers, $functionName);
-	/** @var string $functionName */
-	$readerFuncs[$functionName] = $readerF;
+	if(count($enumMembers) === 0){
+		throw new \InvalidArgumentException("Enum members cannot be empty");
+	}
+	$reflect = new \ReflectionClass($enumMembers[array_key_first($enumMembers)]);
+	$virtualTypeName = $reflect->getShortName();
+	$nativeTypeName = $reflect->getName();
+	$functionName = lcfirst($virtualTypeName);
+
+	$stringifiedMembers = stringifyEnumMembers($enumMembers, $nativeTypeName);
+	$writerFuncs[$functionName] = buildWriterFunc(
+		$virtualTypeName,
+		$nativeTypeName,
+		$stringifiedMembers,
+		$functionName
+	);
+	$readerFuncs[$functionName] = buildReaderFunc(
+		$virtualTypeName,
+		$nativeTypeName,
+		$stringifiedMembers,
+		$functionName
+	);
+	$interfaceFuncs[$functionName] = [buildInterfaceFunc(
+		$nativeTypeName,
+		$functionName
+	)];
+	$sizeCalculationFuncs[$functionName] = buildSizeCalculationFunc(
+		$nativeTypeName,
+		$functionName,
+		$stringifiedMembers
+	);
 }
 
 /**
  * @param string[][] $functions
  * @phpstan-param array<string, list<string>> $functions
  */
-function printFunctions(array $functions, string $className) : void{
+function printFunctions(array $functions, string $className, string $classType) : void{
 	ksort($functions, SORT_STRING);
 
 	ob_start();
@@ -235,14 +248,16 @@ namespace pocketmine\data\runtime;
 
 HEADER;
 
-	echo "trait $className{\n\n";
+	echo "$classType $className{\n\n";
 	echo implode("\n\n", array_map(fn(array $functionLines) => "\t" . implode("\n\t", $functionLines), $functions));
 	echo "\n\n}\n";
 
 	file_put_contents(dirname(__DIR__) . '/src/data/runtime/' . $className . '.php', ob_get_clean());
 }
 
-printFunctions($writerFuncs, "RuntimeEnumSerializerTrait");
-printFunctions($readerFuncs, "RuntimeEnumDeserializerTrait");
+printFunctions($writerFuncs, "RuntimeEnumSerializerTrait", "trait");
+printFunctions($readerFuncs, "RuntimeEnumDeserializerTrait", "trait");
+printFunctions($interfaceFuncs, "RuntimeEnumDescriber", "interface");
+printFunctions($sizeCalculationFuncs, "RuntimeEnumSizeCalculatorTrait", "trait");
 
 echo "Done. Don't forget to run CS fixup after generating code.\n";

build/make-release.php

@@ -23,6 +23,7 @@ declare(strict_types=1);
 
 namespace pocketmine\build\make_release;
 
+use pocketmine\utils\Filesystem;
 use pocketmine\utils\Utils;
 use pocketmine\utils\VersionString;
 use pocketmine\VersionInfo;
@@ -30,17 +31,17 @@ use function array_keys;
 use function array_map;
 use function dirname;
 use function fgets;
-use function file_get_contents;
 use function file_put_contents;
 use function fwrite;
 use function getopt;
 use function is_string;
 use function max;
+use function preg_match;
 use function preg_replace;
-use function sleep;
 use function sprintf;
 use function str_pad;
 use function strlen;
+use function strtolower;
 use function system;
 use const STDERR;
 use const STDIN;
@@ -50,7 +51,7 @@ use const STR_PAD_LEFT;
 require_once dirname(__DIR__) . '/vendor/autoload.php';
 
 function replaceVersion(string $versionInfoPath, string $newVersion, bool $isDev, string $channel) : void{
-	$versionInfo = Utils::assumeNotFalse(file_get_contents($versionInfoPath), $versionInfoPath . " should always exist");
+	$versionInfo = Filesystem::fileGetContents($versionInfoPath);
 	$versionInfo = preg_replace(
 		$pattern = '/^([\t ]*public )?const BASE_VERSION = "(\d+)\.(\d+)\.(\d+)(?:-(.*))?";$/m',
 		'$1const BASE_VERSION = "' . $newVersion . '";',
@@ -102,22 +103,43 @@ function main() : void{
 		$filteredOpts[$optName] = $optValue;
 	}
 
+	$channel = $filteredOpts["channel"] ?? null;
 	if(isset($filteredOpts["current"])){
 		$currentVer = new VersionString($filteredOpts["current"]);
 	}else{
 		$currentVer = new VersionString(VersionInfo::BASE_VERSION);
 	}
-	if(isset($filteredOpts["next"])){
-		$nextVer = new VersionString($filteredOpts["next"]);
+
+	$nextVer = isset($filteredOpts["next"]) ? new VersionString($filteredOpts["next"]) : null;
+
+	$suffix = $currentVer->getSuffix();
+	if($suffix !== ""){
+		if($channel === "stable"){
+			fwrite(STDERR, "error: cannot release a suffixed build into the stable channel\n");
+			exit(1);
+		}
+		if(preg_match('/^([A-Za-z]+)(\d+)$/', $suffix, $matches) !== 1){
+			echo "error: invalid current version suffix \"$suffix\"; aborting\n";
+			exit(1);
+		}
+		$nextVer ??= new VersionString(sprintf(
+			"%u.%u.%u-%s%u",
+			$currentVer->getMajor(),
+			$currentVer->getMinor(),
+			$currentVer->getPatch(),
+			$matches[1],
+			((int) $matches[2]) + 1
+		));
+		$channel ??= strtolower($matches[1]);
 	}else{
-		$nextVer = new VersionString(sprintf(
+		$nextVer ??= new VersionString(sprintf(
 			"%u.%u.%u",
 			$currentVer->getMajor(),
 			$currentVer->getMinor(),
 			$currentVer->getPatch() + 1
 		));
+		$channel ??= "stable";
 	}
-	$channel = $filteredOpts["channel"] ?? VersionInfo::BUILD_CHANNEL;
 
 	echo "About to tag version $currentVer. Next version will be $nextVer.\n";
 	echo "$currentVer will be published on release channel \"$channel\".\n";
@@ -137,9 +159,6 @@ function main() : void{
 	replaceVersion($versionInfoPath, $nextVer->getBaseVersion(), true, $channel);
 	systemWrapper('git add "' . $versionInfoPath . '"', "failed to stage changes for post-release commit");
 	systemWrapper('git commit -m "' . $nextVer->getBaseVersion() . ' is next" --include "' . $versionInfoPath . '"', "failed to create post-release commit");
-	echo "pushing changes in 5 seconds\n";
-	sleep(5);
-	systemWrapper('git push origin HEAD ' . $currentVer->getBaseVersion(), "failed to push changes to remote");
 }
 
 main();

build/server-phar.php

@@ -40,12 +40,13 @@ use function rtrim;
 use function sprintf;
 use function str_replace;
 use function unlink;
+use const DIRECTORY_SEPARATOR;
 use const PHP_EOL;
 
 require dirname(__DIR__) . '/vendor/autoload.php';
 
 /**
- * @param string[]    $strings
+ * @param string[] $strings
  *
  * @return string[]
  */

changelogs/4.10.md

@@ -0,0 +1,53 @@
+**For Minecraft: Bedrock Edition 1.19.40**
+
+### 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.10.0
+Released 26th October 2022.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.19.40.
+- 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.
+
+# 4.10.2
+Released 25th November 2022.
+
+## Fixes
+- Fixed crashes on macOS and Linux when using console colours without the `TERM` environment variable set.
+- Fixed crashdumps not being generated when error messages contained invalid UTF-8 characters.
+
+## Documentation
+- Clarified documentation of caching behaviour for `Internet::getIP()`.
+- Added and improved documentation for many `Inventory` methods.
+- Rewritten documentation for `PlayerCreationEvent` with warnings and more detail.
+
+## Internals
+- Non-arrow projectile damage is now unscaled. Scaling according to velocity is only applied to arrows. This currently doesn't cause any observable change in behaviour, but is required for future additions.

changelogs/4.11-beta.md

@@ -0,0 +1,92 @@
+**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.
+
+# 4.11.0-BETA2
+Released 13th November 2022.
+
+## Configuration
+- The `chunk-ticking.per-tick` setting is now deprecated, and will be removed in a future release.
+  - The functionality of this setting has been removed, since it caused more problems than it solved.
+  - Setting it to zero will still disable chunk ticking (for now), but this should now be done by setting `chunk-ticking.tick-radius` to `0` instead.
+
+## Gameplay
+- Improved chunk random ticking:
+  - Removed the limit on chunks ticked per tick, and its associated config option is no longer respected.
+    - This change significantly improves crop and plant growth with large numbers of players, but may cause higher CPU usage.
+    - This limit was causing a linear decrease in chunk ticking speed with larger numbers of players, leading to worsened gameplay experience.
+  - Every chunk within the configured tick radius of a player will be ticked. Previously, chunks were randomly selected from the radius.
+- Implemented Darkness effect.
+
+## API
+### `pocketmine\world`
+- The following new API methods have been added:
+  - `public World->getChunkTickRadius() : int` - returns the world's simulation radius
+  - `public World->setChunkTickRadius(int $radius) : void` - sets the world's simulation radius
+
+## Internals
+- Non-arrow projectile damage is now unscaled. Scaling according to velocity is only applied to arrows. This currently doesn't cause any observable change in behaviour, but is required for future additions.

changelogs/4.11.md

@@ -0,0 +1,106 @@
+**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
+Released 25th 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.
+- User-defined `pocketmine.yml` custom commands now use a generic description which makes clear the command is config-defined.
+- 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`
+  - The file must contain the raw key bytes, and must not end with a newline.
+
+## Configuration
+- The `chunk-ticking.per-tick` setting is now deprecated, and will be removed in a future release.
+  - The functionality of this setting has been removed, since it caused more problems than it solved.
+  - Setting it to zero will still disable chunk ticking (for now), but this should now be done by setting `chunk-ticking.tick-radius` to `0` instead.
+
+## 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 missing sounds when adding, rotating, or removing items in item frames.
+- Fixed modifier values for Instant Damage and Regeneration effects.
+- Implemented Darkness effect.
+- Improved chunk random ticking:
+  - Removed the limit on chunks ticked per tick, and its associated config option is no longer respected.
+    - This change significantly improves crop and plant growth with large numbers of players.
+    - This limit was causing a linear decrease in chunk ticking speed with larger numbers of players, leading to worsened gameplay experience.
+    - **Warning: This change will result in increased CPU usage if players are spread over a very large area.**
+  - Every chunk within the configured tick radius of a player will be ticked. Previously, chunks were randomly selected from the radius.
+
+## 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\event\block`
+- The following new classes have been added:
+  - `BlockDeathEvent` - event called when coral or coral blocks die due to lack of water
+
+### `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\lang`
+- The following new API methods have been added:
+  - `public Language->getAll() : array<string, string>`
+
+### `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
+
+### `pocketmine\world`
+- The following new API methods have been added:
+  - `public World->getChunkTickRadius() : int` - returns the world's simulation radius
+  - `public World->setChunkTickRadius(int $radius) : void` - sets the world's simulation radius
+
+### `pocketmine\world\sound`
+- The following new classes have been added:
+  - `ItemFrameAddItemSound`
+  - `ItemFrameRemoveItemSound`
+  - `ItemFrameRotateItemSound`
+
+## Internals
+- Improved performance of `ContainerTrait` dropping items on block destroy. ([link](https://github.com/pmmp/PocketMine-MP/commits/24e72ec109c1442b09558df89b6833cf2f2e0ec7))
+- Avoid repeated calls to `Position->getWorld()` (use local variables). ([link](https://github.com/pmmp/PocketMine-MP/commit/2940547026db40ce76deb46e992870de3ead79ad))
+- Revamped the way `InventoryManager` handles fake inventory slot mappings for stuff like crafting tables. ([link](https://github.com/pmmp/PocketMine-MP/commit/e90abecf38d9c57635fa0497514bba7e546a2469))
+  - Inventories are now mapped on a per-slot basis. This means that more than one inventory can be mapped to the same window ID, which is necessary for correctly handling "UI" inventories like crafting tables.
+  - `InventoryManager->getWindow(int $windowId) : ?Inventory` is replaced by `locateWindowAndSlot` (see below).
+  - Added `InventoryManager->locateWindowAndSlot(int $windowId, int $netSlotId) : array{Inventory, int}` - accepts a window ID and absolute slot ID, and returns the associated inventory and the slot relative to the inventory's own start (for use with `getItem()` etc.).
+  - Slot offset mapping for "UI" inventories is now handled in `InventoryManager->createComplexSlotMapping()` instead of in `TypeConverter`.
+- Console polling is now done on the main thread (no longer a performance concern). ([link](https://github.com/pmmp/PocketMine-MP/commit/b3f03d7ae645de67a54b7300c09b94eeca16298e))
+- Console reader subprocess should now automatically die if the server main process is killed, instead of persisting as a zombie. ([link](https://github.com/pmmp/PocketMine-MP/commit/2585160ca2c4df5758b8b980331307402ff9f0fb))
+- `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. ([link](https://github.com/pmmp/PocketMine-MP/commit/83e5b0adb6fa0dddec377182bb1c7945ac8f7820))
+- `DelegateInventory` now uses `WeakReference` to track its inventory listener. This allows the delegate to be reused. ([link](https://github.com/pmmp/PocketMine-MP/commit/3feaa18f6c10c3a99c0deca75f57ec2d74b92ab4))
+- Non-arrow projectile damage is now unscaled. Scaling according to velocity is only applied to arrows. This currently doesn't cause any observable change in behaviour, but is required for future additions.

changelogs/4.12.md

@@ -0,0 +1,119 @@
+**For Minecraft: Bedrock Edition 1.19.50**
+
+### 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.12.0
+Released 30th November 2022.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.19.50.
+- Removed support for older versions.
+
+# 4.12.1
+Released 4th December 2022.
+
+## Fixes
+- Fixed items glitching when dragging a stack of items across the crafting grid (desync issues).
+
+# 4.12.2
+Released 15th December 2022.
+
+## Fixes
+- Folder used for plugins (optionally specified by `--plugins`) is no longer required to be writable.
+- Fixed broken writable check for server data folder (`is_writable()` broken on NFS and similar filesystems).
+- `Filesystem::createLockFile()` exceptions now include more information about why the lock file could not be created.
+- Fixed client-side item predictions not being rolled back when cancelling events such as `PlayerItemUseEvent`.
+
+## Dependencies
+- Updated BedrockProtocol to [17.1.0](https://github.com/pmmp/BedrockProtocol/releases/tag/17.1.0+bedrock-1.19.50). This adds some missing `LevelSoundEvent` constants and fixes the values for `ContainerUIIds`.
+
+# 4.12.3
+Released 28th December 2022.
+
+## Fixes
+- Fixed unauthenticated connections taking up player count slots, preventing players from joining.
+- Fixed a possible crash in `World->tickChunk()` when plugins unload chunks during some events.
+- `/gamemode` will now report a failure to change game mode if the player is already in the requested game mode.
+
+# 4.12.4
+Released 3rd January 2023.
+
+## Fixes
+- Added workarounds for an active exploit being used to deny service to servers.
+
+# 4.12.5
+Released 6th January 2023.
+
+## Fixes
+- Removed a workaround for an old client bug in custom form responses. The code contained a denial-of-service vulnerability.
+
+# 4.12.6
+Released 7th January 2023.
+
+## Changes
+- Added a new security measure to `NetworkSession` to detect and ban players who flood the server with packets.
+
+# 4.12.7
+Released 8th January 2023.
+
+## Fixes
+- Fixed players getting kicked when the server lags for too long.
+- Fixed players getting kicked when a debugging session is active and a breakpoint is hit.
+
+# 4.12.8
+Released 9th January 2023.
+
+## Fixes
+- Fixed players getting kicked during PvP.
+- Fixed players randomly getting kicked on Windows (improper rate limit handling wrt. 15ms timer resolution).
+
+# 4.12.9
+Released 16th January 2023.
+
+## Improvements
+### Timings
+- Added new timers:
+  - `Server Mid-Tick Processing` - time spent processing Snooze interrupts between ticks (e.g. incoming network packets)
+  - `Server Tick Update Cycle` - time spent processing regular per-tick updates (e.g. entity movement, world updates, etc.) (`Server->tick()`)
+- `Full Server Tick` timer now counts the total of `Server Mid-Tick Processing` and `Server Tick Update Cycle`, which generates more accurate performance metrics.
+  - Previously, this timer only counted the time spent during regular per-tick updates, and the time recorded by `Server Mid-Tick Processing` was not included in the report at all.
+
+## Fixes
+- Fixed blocks such as pressure plates being able to be placed without the correct supporting blocks if the clicked block was solid.
+- Pressure plates now self-destruct when the block below them is removed.
+- Fixed being unable to place blocks by clicking on the side of a bell (when the click doesn't result in ringing the bell).
+- Fixed various rotation-aware blocks (e.g. stairs) behaving incorrectly when placed by clicking on the side of a replaceable block (e.g. tall grass).
+- Fixed banners being able to be placed on top of blocks such as skulls.
+- Fixed server-side collision boxes of walls and glass (which should connect, but didn't). Note that wall connections still don't show client side - this just fixes the collision boxes.
+- Fixed `PlayerInteractEvent` with `LEFT_CLICK` sometimes firing before `BlockBreakEvent` when breaking blocks.
+
+## Other changes
+- Increased packet batch budget for player sessions.
+
+# 4.12.10
+Released 18th January 2023.
+
+## Fixes
+- Fixed reported server load not including the time spent processing Snooze interrupts between ticks (e.g. incoming network packets).
+- Fixed `Connection Handler` entry in timings report not including time spent receiving packets.
+
+## Note about server load & performance
+This version will report higher apparent server load than previous versions. The actual performance of the server is unchanged; the previous reported load was inaccurate.
+These bugs have been present for nearly 5 years (ever since the first introduction of Snooze in 3.0.0).
+
+# 4.12.11
+Released 22nd January 2023.
+
+## General
+- Code is now tested and analysed using PHP 8.2 in addition to 8.1 and 8.0.
+
+## Fixes
+- Fixed pthreads 5.0.0 incorrectly being treated as compatible.
+- Fixed deprecation errors on PHP 8.2.
+
+## Documentation
+- Updated documentation in `PlayerPreLoginEvent`.

changelogs/4.13-beta.md

@@ -0,0 +1,94 @@
+**For Minecraft: Bedrock Edition 1.19.50**
+
+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.13.0-BETA1
+Released 18th January 2023.
+
+## Gameplay
+- Death message is now shown on the death screen when a player dies.
+- Armour damage is now only increased if the armour reduced the damage taken.
+- Implemented Swift Sneak enchantment.
+- Fixed incorrect collision box calculation of walls and glass/bars when connected. Note: Client-side, wall connections are still broken; this only fixes projectile flight server-side.
+
+## Performance
+- Improved performance of chunk selection for chunk random ticking using a cache. This improves performance of chunk random ticking by 10-20%.
+
+## Localization
+- Added localized description for the `/dumpmemory` command.
+
+## Permissions
+- Added the following new core permissions:
+  - `pocketmine.command.effect.other` - allows the player to use the `/effect` command on other players (default operator only)
+  - `pocketmine.command.effect.self` - allows the player to use the `/effect` command on themselves (default operator only)
+  - `pocketmine.command.enchant.other` - allows the player to use the `/enchant` command on other players (default operator only)
+  - `pocketmine.command.enchant.self` - allows the player to use the `/enchant` command on themselves (default operator only)
+  - `pocketmine.command.gamemode.other` - allows the player to use the `/gamemode` command on other players (default operator only)
+  - `pocketmine.command.gamemode.self` - allows the player to use the `/gamemode` command on themselves (default operator only)
+  - `pocketmine.command.give.other` - allows the player to use the `/give` command on other players (default operator only)
+  - `pocketmine.command.give.self` - allows the player to use the `/give` command on themselves (default operator only)
+  - `pocketmine.command.spawnpoint.other` - allows the player to use the `/spawnpoint` command on other players (default operator only)
+  - `pocketmine.command.spawnpoint.self` - allows the player to use the `/spawnpoint` command on themselves (default operator only)
+  - `pocketmine.command.teleport.other` - allows the player to use the `/teleport` command on other players (default operator only)
+  - `pocketmine.command.teleport.self` - allows the player to use the `/teleport` command on themselves (default operator only)
+  - `pocketmine.command.title.other` - allows the player to use the `/title` command on other players (default operator only)
+  - `pocketmine.command.title.self` - allows the player to use the `/title` command on themselves (default operator only)
+
+## Internals
+- Decoupled `Player->sendMessage()` and `Player->sendTranslation()`.
+- Refactored resource pack loading in `ResourcePackManager` to make it easier to understand.
+- Client-aware translation processing has been moved to `NetworkSession` due to being client-specific.
+- Replaced hardcoded strings with constants in various places.
+- `NetworkSession` destructive cleanup is now deferred to the next session tick. This fixes various `InventoryManager` crashes when kicking players during events.
+- Updated code using `strpos()` to use `str_starts_with()`, `str_ends_with()` and `str_contains()` where appropriate.
+- Added documentation for some internal methods.
+
+## API
+### `pocketmine\command`
+- The following new API methods have been added:
+  - `protected VanillaCommand->fetchPermittedPlayerTarget(...) : ?Player` - fetches a player target according to the given sender permissions, or null if not found or not permitted
+
+### `pocketmine\entity`
+- The following new API methods have been added:
+  - `public Living->getDisplayName() : string` - the name of the entity to be shown in death messages, commands etc.
+
+### `pocketmine\event\world`
+- The following new classes have been added:
+  - `WorldSoundEvent` - called when a sound is played in a world
+  - `WorldParticleEvent` - called when a particle is spawned in a world
+
+### `pocketmine\item`
+- The following new API methods have been added:
+  - `public Item->onInteractEntity(Player $player, Entity $entity, Vector3 $clickVector) : bool` - called when a player interacts with an entity with this item in hand
+
+### `pocketmine\lang`
+- `Language->translate()` and `Language->translateString()` no longer parse nested translation in the "base text". This was never intended behaviour, and didn't work beyond the first level anyway.
+
+### `pocketmine\player`
+- The following new interfaces have been added:
+  - `PlayerDataProvider` - implemented by classes which want to offer storage for player data
+- The following new classes have been added:
+  - `DatFilePlayerDataProvider` - the default player data provider, which stores `.dat` files in the `players` folder
+  - `PlayerDataLoadException` - thrown when an error occurs while loading player data
+  - `PlayerDataSaveException` - thrown when an error occurs while saving player data
+- The following API methods have been deprecated:
+  - `Player->sendTranslation()` - use `Player->sendMessage()` instead with a `Translatable` message
+
+### `pocketmine\resourcepacks`
+- The following new API methods have been added:
+  - `public ResourcePackManager->setResourceStack(list<ResourcePack> $resourceStack) : void` - sets the list of resource packs to be applied by players
+  - `public ResourcePackManager->setPackEncryptionKey(string $id, ?string $key) : void` - sets the encryption key to be used for a resource pack
+
+### `pocketmine\utils`
+- The following new API methods have been added:
+  - `public static Filesystem::fileGetContents(...) : string` - a wrapper around `file_get_contents()` which throws an exception on failure
+
+### `pocketmine\world`
+- The following new API methods have been added:
+  - `public World->requestSafeSpawn(?Vector3 $spawn = null) : Promise<Position>` - an async version of `getSafeSpawn()` which generates all the needed chunks before returning

changelogs/4.13.md

@@ -0,0 +1,94 @@
+**For Minecraft: Bedrock Edition 1.19.50**
+
+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.13.0
+Released 30th January 2023.
+
+## Gameplay
+- Death message is now shown on the death screen when a player dies.
+- Armour damage is now only increased if the armour reduced the damage taken.
+- Implemented Swift Sneak enchantment.
+- Fixed incorrect collision box calculation of walls and glass/bars when connected. Note: Client-side, wall connections are still broken; this only fixes projectile flight server-side.
+
+## Performance
+- Improved performance of chunk selection for chunk random ticking using a cache. This improves performance of chunk random ticking by 10-20%.
+
+## Localization
+- Added localized description for the `/dumpmemory` command.
+
+## Permissions
+- Added the following new core permissions:
+  - `pocketmine.command.effect.other` - allows the player to use the `/effect` command on other players (default operator only)
+  - `pocketmine.command.effect.self` - allows the player to use the `/effect` command on themselves (default operator only)
+  - `pocketmine.command.enchant.other` - allows the player to use the `/enchant` command on other players (default operator only)
+  - `pocketmine.command.enchant.self` - allows the player to use the `/enchant` command on themselves (default operator only)
+  - `pocketmine.command.gamemode.other` - allows the player to use the `/gamemode` command on other players (default operator only)
+  - `pocketmine.command.gamemode.self` - allows the player to use the `/gamemode` command on themselves (default operator only)
+  - `pocketmine.command.give.other` - allows the player to use the `/give` command on other players (default operator only)
+  - `pocketmine.command.give.self` - allows the player to use the `/give` command on themselves (default operator only)
+  - `pocketmine.command.spawnpoint.other` - allows the player to use the `/spawnpoint` command on other players (default operator only)
+  - `pocketmine.command.spawnpoint.self` - allows the player to use the `/spawnpoint` command on themselves (default operator only)
+  - `pocketmine.command.teleport.other` - allows the player to use the `/teleport` command on other players (default operator only)
+  - `pocketmine.command.teleport.self` - allows the player to use the `/teleport` command on themselves (default operator only)
+  - `pocketmine.command.title.other` - allows the player to use the `/title` command on other players (default operator only)
+  - `pocketmine.command.title.self` - allows the player to use the `/title` command on themselves (default operator only)
+
+## Internals
+- Decoupled `Player->sendMessage()` and `Player->sendTranslation()`.
+- Refactored resource pack loading in `ResourcePackManager` to make it easier to understand.
+- Client-aware translation processing has been moved to `NetworkSession` due to being client-specific.
+- Replaced hardcoded strings with constants in various places.
+- `NetworkSession` destructive cleanup is now deferred to the next session tick. This fixes various `InventoryManager` crashes when kicking players during events.
+- Updated code using `strpos()` to use `str_starts_with()`, `str_ends_with()` and `str_contains()` where appropriate.
+- Added documentation for some internal methods.
+
+## API
+### `pocketmine\command`
+- The following new API methods have been added:
+  - `protected VanillaCommand->fetchPermittedPlayerTarget(...) : ?Player` - fetches a player target according to the given sender permissions, or null if not found or not permitted
+
+### `pocketmine\entity`
+- The following new API methods have been added:
+  - `public Living->getDisplayName() : string` - the name of the entity to be shown in death messages, commands etc.
+
+### `pocketmine\event\world`
+- The following new classes have been added:
+  - `WorldSoundEvent` - called when a sound is played in a world
+  - `WorldParticleEvent` - called when a particle is spawned in a world
+
+### `pocketmine\item`
+- The following new API methods have been added:
+  - `public Item->onInteractEntity(Player $player, Entity $entity, Vector3 $clickVector) : bool` - called when a player interacts with an entity with this item in hand
+
+### `pocketmine\lang`
+- `Language->translate()` and `Language->translateString()` no longer parse nested translation in the "base text". This was never intended behaviour, and didn't work beyond the first level anyway.
+
+### `pocketmine\player`
+- The following new interfaces have been added:
+  - `PlayerDataProvider` - implemented by classes which want to offer storage for player data
+- The following new classes have been added:
+  - `DatFilePlayerDataProvider` - the default player data provider, which stores `.dat` files in the `players` folder
+  - `PlayerDataLoadException` - thrown when an error occurs while loading player data
+  - `PlayerDataSaveException` - thrown when an error occurs while saving player data
+- The following API methods have been deprecated:
+  - `Player->sendTranslation()` - use `Player->sendMessage()` instead with a `Translatable` message
+
+### `pocketmine\resourcepacks`
+- The following new API methods have been added:
+  - `public ResourcePackManager->setResourceStack(list<ResourcePack> $resourceStack) : void` - sets the list of resource packs to be applied by players
+  - `public ResourcePackManager->setPackEncryptionKey(string $id, ?string $key) : void` - sets the encryption key to be used for a resource pack
+
+### `pocketmine\utils`
+- The following new API methods have been added:
+  - `public static Filesystem::fileGetContents(...) : string` - a wrapper around `file_get_contents()` which throws an exception on failure
+
+### `pocketmine\world`
+- The following new API methods have been added:
+  - `public World->requestSafeSpawn(?Vector3 $spawn = null) : Promise<Position>` - an async version of `getSafeSpawn()` which generates all the needed chunks before returning

changelogs/4.14.md

@@ -0,0 +1,21 @@
+**For Minecraft: Bedrock Edition 1.19.60**
+
+### 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.14.0
+Released 8th February 2023.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.19.60.
+- Removed support for older versions.
+
+# 4.14.1
+Released 15th February 2023.
+
+## Fixes
+- Fixed all players getting kicked with `Receiving packets too fast` if a server tick takes longer than 5 seconds (e.g. because of autosave or GC).
+- Fixed players getting kicked when linking with entities.

changelogs/4.15.md

@@ -0,0 +1,38 @@
+**For Minecraft: Bedrock Edition 1.19.62**
+
+### 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.15.0
+Released 17th February 2023.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.19.62.
+- Removed support for older versions.
+
+# 4.15.1
+Released 21st February 2023.
+
+## Fixes
+- Fixed dropped items not despawning when in non-ticking chunks.
+- Fixed dropped items not despawning if an infinite pickup delay is set.
+- Fixed infinite despawn delay (never despawn) being ignored for dropped items.
+
+# 4.15.2
+Released 24th February 2023.
+
+## General
+- Accept Minecraft: Bedrock Edition 1.19.63 (identical protocol to 1.19.62, but different version due to Mojang mixup).
+
+## Fixes
+- Fixed `World Population` timer sometimes not being stopped, causing strange results in timings reports.
+
+# 4.15.3
+Released 7th March 2023.
+
+## Fixes
+- Fixed `/dumpmemory` crash when any object contained an `INF` or `NaN` float value.
+- Updated RakLib for security fixes.

changelogs/4.16-beta.md

@@ -0,0 +1,45 @@
+**For Minecraft: Bedrock Edition 1.19.62**
+
+### 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.16.0-BETA1
+Released 4th March 2023.
+
+## General
+- Added granular timings for packet encode, similar to the existing timings for packet decode.
+- Timings now covers several areas of the network system which were previously not counted by network timings, but were counted by total timings. This provides a better insight into the performance of the network system.
+
+## Performance
+- Improved performance of packet batch handling by avoiding unnecessary object allocations.
+- Improved performance of packet broadcasting when the broadcast size is below the batch threshold. Previously, the packets would be encoded once by every recipient, but now they are encoded once and then added to the send buffer of each session in their raw form.
+  - This change mostly affects servers with larger maps, where players are more widely distributed.
+
+## Build system
+- Added a new script `build/generate-bedrockdata-path-consts.php`, which must be run whenever BedrockData is updated. This script generates a class of constants with the file paths of all BedrockData files.
+
+## API
+### `pocketmine\entity`
+- The following new API methods have been added:
+  - `public Entity->getGravity() : float` - returns the entity's gravity acceleration in blocks/tick^2
+  - `public Entity->setGravity(float $gravity) : void` - sets the entity's gravity acceleration in blocks/tick^2
+
+## Internals
+- Now uses [`pocketmine/bedrock-data` 2.0.0](https://github.com/pmmp/BedrockData/releases/tag/2.0.0+bedrock-1.19.60).
+  - This version is now used by both PM4 and PM5, reducing maintenance burden.
+- Now uses [`pocketmine/bedrock-protocol` 19.3.0](https://github.com/pmmp/BedrockProtocol/releases/tag/19.3.0+bedrock-1.19.62).
+  - This version provides new APIs for handling packet batches which enabled improving performance and adding new features, such as detailed packet encode timings.
+- Crafting recipes and creative inventory data are now loaded from `recipes/legacy_recipes.json` and `recipes/legacy_creativeitems.json` respectively. Previously, these were loaded from BedrockData directly, but BedrockData 2.0 now uses a format which can't be supported in 4.x without BC breaks.
+- Added dependencies on [`pocketmine/bedrock-block-upgrade-schema`](https://github.com/pmmp/BedrockBlockUpgradeSchema) and [`pocketmine/bedrock-item-upgrade-schema`](https://github.com/pmmp/BedrockItemUpgradeSchema). These provide mapping files no longer present in BedrockData 2.0.
+- Reduced and/or eliminated most usages of `PacketBatch`, since it only appeared as a throwaway object and was therefore wasting performance.
+- `Compressor` now exposes `getCompressionThreshold()` instead of `willCompress()`, which allows determining whether a batch will be compressed without allocating it.
+- Added `pocketmine\data\bedrock\BedrockDataFiles`, an auto-generated class of constants with the file paths of all BedrockData files. This makes it easier to locate usages, detect unused files and avoid typos.
+
+# 4.16.0-BETA2
+Released 4th March 2023.
+
+## General
+- Fixed incorrect release channel for 4.16.0-BETA1.

changelogs/4.16.md

@@ -0,0 +1,41 @@
+**For Minecraft: Bedrock Edition 1.19.62**
+
+### 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.16.0
+Released 7th March 2023.
+
+## General
+- Added granular timings for packet encode, similar to the existing timings for packet decode.
+- Split `Player Network Send - Compression` timings into two timers, one for `Session Buffer` compression and one for `Broadcast` compression.
+- Timings now covers several areas of the network system which were previously not counted by network timings, but were counted by total timings. This provides a better insight into the performance of the network system.
+
+## Performance
+- Improved performance of packet batch handling by avoiding unnecessary object allocations.
+- Improved performance of packet broadcasting when the broadcast size is below the batch threshold. Previously, the packets would be encoded once by every recipient, but now they are encoded once and then added to the send buffer of each session in their raw form.
+  - This change mostly affects servers with larger maps, where players are more widely distributed.
+- Improved performance of packet broadcasting when the broadcast has only one recipient (allow the session to compress the packet with the rest of its buffer).
+
+## Build system
+- Added a new script `build/generate-bedrockdata-path-consts.php`, which must be run whenever BedrockData is updated. This script generates a class of constants with the file paths of all BedrockData files.
+
+## API
+### `pocketmine\entity`
+- The following new API methods have been added:
+  - `public Entity->getGravity() : float` - returns the entity's gravity acceleration in blocks/tick^2
+  - `public Entity->setGravity(float $gravity) : void` - sets the entity's gravity acceleration in blocks/tick^2
+
+## Internals
+- Now uses [`pocketmine/bedrock-data` 2.0.0](https://github.com/pmmp/BedrockData/releases/tag/2.0.0+bedrock-1.19.60).
+  - This version is now used by both PM4 and PM5, reducing maintenance burden.
+- Now uses [`pocketmine/bedrock-protocol` 19.3.0](https://github.com/pmmp/BedrockProtocol/releases/tag/19.3.0+bedrock-1.19.62).
+  - This version provides new APIs for handling packet batches which enabled improving performance and adding new features, such as detailed packet encode timings.
+- Crafting recipes and creative inventory data are now loaded from `recipes/legacy_recipes.json` and `recipes/legacy_creativeitems.json` respectively. Previously, these were loaded from BedrockData directly, but BedrockData 2.0 now uses a format which can't be supported in 4.x without BC breaks.
+- Added dependencies on [`pocketmine/bedrock-block-upgrade-schema`](https://github.com/pmmp/BedrockBlockUpgradeSchema) and [`pocketmine/bedrock-item-upgrade-schema`](https://github.com/pmmp/BedrockItemUpgradeSchema). These provide mapping files no longer present in BedrockData 2.0.
+- Reduced and/or eliminated most usages of `PacketBatch`, since it only appeared as a throwaway object and was therefore wasting performance.
+- `Compressor` now exposes `getCompressionThreshold()` instead of `willCompress()`, which allows determining whether a batch will be compressed without allocating it.
+- Added `pocketmine\data\bedrock\BedrockDataFiles`, an auto-generated class of constants with the file paths of all BedrockData files. This makes it easier to locate usages, detect unused files and avoid typos.

changelogs/4.17.md

@@ -0,0 +1,39 @@
+**For Minecraft: Bedrock Edition 1.19.70**
+
+### 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.17.0
+Released 14th March 2023.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.19.70.
+- Removed support for older versions.
+
+# 4.17.1
+Released 22nd March 2023.
+
+## General
+- Docker images for PocketMine-MP are now published on [GitHub Container Registry](https://github.com/pmmp/PocketMine-MP/pkgs/container/pocketmine-mp). The Docker Hub images will stop being maintained in the future.
+- Updated translations.
+
+## Fixes
+- Fixed server crash on empty packets in certain cases.
+- Fixed mushroom blocks dropping the wrong items when broken with a silk-touch tool.
+- Fixed mushroom blocks giving the wrong items when block-picked.
+- Fixed missing ability flag `PRIVILEGED_BUILDER`.
+
+## Internals
+- `update-updater-api.yml` workflow now uses `github.repository_owner` to make it easier to test the workflow on forks.
+- Added version-specific channels to `update.pmmp.io`, such as `4`, `4.18-beta`, `4.17`, etc.
+- Replaced deprecated `::set-output` commands in GitHub Actions workflows.
+- `build/make-release.php` no longer automatically pushes changes, to avoid accidents when testing release workflows on forks.
+
+# 4.17.2
+Released 29th March 2023.
+
+## Fixes
+- Fixed players being unable to join due to the appearance of a new `x5t` field in the JWT header of Xbox Live authentication tokens.

changelogs/4.18-alpha.md

@@ -0,0 +1,91 @@
+**For Minecraft: Bedrock Edition 1.19.70**
+
+### Note about API versions
+Plugins which don't touch the `pocketmine\network\mcpe` namespace are 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 `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+### Alpha release warning
+Alpha releases are **experimental**. Features introduced in these releases are subject to change or removal.
+
+APIs which existed **prior** to this version will continue to work as normal, so plugins which use them will continue to work.
+
+### Highlights
+This version makes changes to the internal network system to improve server performance and reduce memory usage.
+
+While these changes don't affect non-internal API, they are still significant enough to warrant a new minor version, as they may break plugins which use the internal network API (not recommended).
+
+# 4.18.0-ALPHA1
+Released 16th March 2023.
+
+## General
+- Improved server performance in congested areas of the world (lots of players and/or entities in the same area).
+
+## API
+### `pocketmine\event\server`
+- The following new classes have been added:
+  - `DataPacketDecodeEvent` - called before a packet is decoded by a `NetworkSession`; useful to mitigate DoS attacks if PocketMine-MP hasn't been patched against new bugs yet
+
+## Internals
+- Introduced new system for broadcasting entity events to network sessions.
+  - This change improves performance when lots of players and/or entities are in the same area.
+  - New interface `EntityEventBroadcaster` and class `StandardEntityEventBroadcaster` have been added to implement this.
+  - All entity-specific `on*()` and `sync*()` methods have been removed from `NetworkSession` (BC break).
+  - `NetworkSession` now accepts an `EntityEventBroadcaster` instance in its constructor.
+  - `NetworkBroadcastUtils::broadcastEntityEvent()` can be used to efficiently broadcast events to unique broadcasters shared by several network sessions.
+- All network sessions now share the same `PacketSerializerContext` and `PacketBroadcaster` by default.
+  - Previously, every session had its own context, meaning that broadcast optimisations were not used, causing significant performance losses compared to 3.x.
+  - This change improves performance in congested areas by allowing reuse of previously encoded packet buffers for all sessions sharing the same context.
+  - Packet broadcasts are automatically encoded separately per unique `PacketSerializerContext` instance. This allows, for example, a multi-version fork to have a separate context for each protocol version, to ensure maximum broadcast efficiency while encoding different packets for different versions.
+  - `PacketSerializerContext` is now passed in `NetworkSession::__construct()`, instead of being created by the session.
+- `StandardPacketBroadcaster` is now locked to a single `PacketSerializer` context, reducing complexity.
+- Introduced `NetworkBroadcastUtils::broadcastPackets()`, replacing `Server->broadcastPackets()`.
+- `Server->broadcastPackets()` has been deprecated. It will be removed in a future version.
+
+# 4.18.0-ALPHA2
+Released 21st March 2023.
+
+## General
+- Included more sections of the network system in Player Network Send timings.
+- Changed the names of some timings to make them more user-friendly.
+- Removed packet IDs from `receivePacket` and `sendPacket` timings, as they were not very useful.
+- Added new specialized timers for the following:
+  - Item entity base ticking (merging)
+  - Player movement processing
+  - Entity movement processing (collision checking section)
+  - Projectile movement (all)
+  - Projectile movement processing (ray tracing section)
+
+## API
+### `pocketmine\crafting`
+- The following new API methods have been added:
+  - `CraftingManager->getCraftingRecipeIndex() : array<int, CraftingRecipe>` - returns a list of all crafting recipes
+  - `CraftingManager->getCraftingRecipeFromIndex(int $index) : ?CraftingRecipe` - returns the crafting recipe at the given index, or null if it doesn't exist
+
+### `pocketmine\inventory\transaction`
+- The following API methods have changed signatures:
+  - `CraftingTransaction->__construct()` now accepts additional arguments `?CraftingRecipe $recipe = null, ?int $repetitions = null`
+- The following new API methods have been added:
+  - `TransactionBuilderInventory->getActualInventory() : Inventory` - returns the actual inventory that this inventory is a proxy for
+
+## Internals
+### Network
+- Introduced support for the `ItemStackRequest` Minecraft: Bedrock network protocol.
+  - This fixes a large number of inventory- and crafting-related bugs.
+  - This also improves server security by closing off many code pathways that might have been used for exploits. `TypeConverter->netItemStackToCore()` is no longer used in server code, and remains for tool usage only.
+  - This system is also significantly more bandwidth-efficient and has lower overhead than the legacy system.
+  - This now opens the gateway to easily implement lots of gameplay features which have been missing for a long time, such as enchanting, anvils, looms, and more.
+  - Significant changes have been made to `pocketmine\network\mcpe\InventoryManager` internals. These shouldn't affect plugins, but may affect plugins which use internal network API.
+  - **No changes have been made to the plugin `InventoryTransaction` API**.
+    - This system has been implemented as a shim for the existing PocketMine-MP transaction system to preserve plugin compatibility. Plugins using `InventoryTransactionEvent` should continue to work seamlessly.
+    - The `InventoryTransaction` API will be redesigned in a future major version to make use of the new information provided by the `ItemStackRequest` system.
+  - `InventoryTransactionPacket` is no longer sent by the client for "regular" inventory actions. However, it is still sent when dropping items, interacting with blocks, and using items.
+- Inventory slot and content syncing is now buffered until the end of the tick. This reduces outbound network usage when the client performs multiple transactions in a single tick (e.g. crafting a stack of items).
+- Renamed some `InventoryManager` internal properties to make them easier to understand.
+- `TypeConverter->createInventoryAction()` has been removed.
+- Packet batch limit has been lowered to `100` packets. With the introduction of `ItemStackRequest`, this is more than sufficient for normal gameplay.
+
+### Other
+- Use `Vector3::zero()` instead of `new Vector3()` in some places.

changelogs/4.18.md

@@ -0,0 +1,123 @@
+**For Minecraft: Bedrock Edition 1.19.70**
+
+### Note about API versions
+Plugins which don't touch the `pocketmine\network\mcpe` namespace are 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 `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+### Highlights
+This version significantly improves server performance with many players and/or entities by making changes to the internal network system.
+
+It also introduces support for the newer `ItemStackRequest` protocol, which fixes many bugs and improves server security.
+
+While these changes don't affect non-internal API, they are still significant enough to warrant a new minor version, as they may break plugins which use the internal network API (not recommended).
+
+# 4.18.0
+Released 25th March 2023.
+
+## General
+- Significantly improved server performance in congested areas of the world (lots of players and/or entities in the same area).
+- Included more sections of the network system in `Player Network Send` performance timings.
+- Changed the names of some performance timings to make them more user-friendly.
+- Removed packet IDs from `receivePacket` and `sendPacket` performance timings, as they were not very useful.
+- Added new specialized performance timings for the following:
+  - Item entity base ticking (merging)
+  - Player movement processing
+  - Entity movement processing (collision checking section)
+  - Projectile movement (all)
+  - Projectile movement processing (ray tracing section)
+
+## API
+### `pocketmine\crafting`
+- The following new API methods have been added:
+  - `CraftingManager->getCraftingRecipeIndex() : array<int, CraftingRecipe>` - returns a list of all crafting recipes
+  - `CraftingManager->getCraftingRecipeFromIndex(int $index) : ?CraftingRecipe` - returns the crafting recipe at the given index, or null if it doesn't exist
+
+### `pocketmine\event\server`
+- The following new classes have been added:
+  - `DataPacketDecodeEvent` - called before a packet is decoded by a `NetworkSession`; useful to mitigate DoS attacks if PocketMine-MP hasn't been patched against new bugs yet
+
+### `pocketmine\inventory\transaction`
+- The following API methods have changed signatures:
+  - `CraftingTransaction->__construct()` now accepts additional arguments `?CraftingRecipe $recipe = null, ?int $repetitions = null`
+- The following new API methods have been added:
+  - `TransactionBuilderInventory->getActualInventory() : Inventory` - returns the actual inventory that this inventory is a proxy for
+
+## Internals
+### Network
+- Introduced new system for broadcasting entity events to network sessions.
+  - This change improves performance when lots of players and/or entities are in the same area.
+  - New interface `EntityEventBroadcaster` and class `StandardEntityEventBroadcaster` have been added to implement this.
+  - All entity-specific `on*()` and `sync*()` methods have been removed from `NetworkSession` (internals backwards compatibility break, not covered by API version guarantee).
+  - `NetworkSession` now accepts an `EntityEventBroadcaster` instance in its constructor.
+  - `NetworkBroadcastUtils::broadcastEntityEvent()` can be used to efficiently broadcast events to unique broadcasters shared by several network sessions.
+- All network sessions now share the same `PacketSerializerContext` and `PacketBroadcaster` by default.
+  - Previously, every session had its own context, meaning that broadcast optimisations were not used, causing significant performance losses compared to 3.x.
+  - This change improves performance in congested areas by allowing reuse of previously encoded packet buffers for all sessions sharing the same context.
+  - Packet broadcasts are automatically encoded separately per unique `PacketSerializerContext` instance. This allows, for example, a multi-version fork to have a separate context for each protocol version, to ensure maximum broadcast efficiency while encoding different packets for different versions.
+  - `PacketSerializerContext` is now passed in `NetworkSession::__construct()`, instead of being created by the session.
+- `StandardPacketBroadcaster` is now locked to a single `PacketSerializer` context, reducing complexity.
+- Introduced `NetworkBroadcastUtils::broadcastPackets()`, replacing `Server->broadcastPackets()`.
+- `Server->broadcastPackets()` has been deprecated. It will be removed in a future version.
+- Introduced support for the `ItemStackRequest` Minecraft: Bedrock network protocol.
+  - This fixes a large number of inventory- and crafting-related bugs.
+  - This also improves server security by closing off many code pathways that might have been used for exploits. `TypeConverter->netItemStackToCore()` is no longer used in server code, and remains for tool usage only.
+  - This system is also significantly more bandwidth-efficient and has lower overhead than the legacy system.
+  - This now opens the gateway to easily implement lots of gameplay features which have been missing for a long time, such as enchanting, anvils, looms, and more.
+  - Significant changes have been made to `pocketmine\network\mcpe\InventoryManager` internals. These shouldn't affect plugins, but may affect plugins which use internal network API.
+  - **No changes have been made to the plugin `InventoryTransaction` API**.
+    - This system has been implemented as a shim for the existing PocketMine-MP transaction system to preserve plugin compatibility. Plugins using `InventoryTransactionEvent` should continue to work seamlessly.
+    - The `InventoryTransaction` API will be redesigned in a future major version to make use of the new information provided by the `ItemStackRequest` system.
+  - `InventoryTransactionPacket` is no longer sent by the client for "regular" inventory actions. However, it is still sent when dropping items, interacting with blocks, and using items.
+- Inventory slot and content syncing is now buffered until the end of the tick. This reduces outbound network usage when the client performs multiple transactions in a single tick (e.g. crafting a stack of items).
+- Renamed some `InventoryManager` internal properties to make them easier to understand.
+- `TypeConverter->createInventoryAction()` has been removed.
+- Packet batch limit has been lowered to `100` packets. With the introduction of `ItemStackRequest`, this is more than sufficient for normal gameplay.
+
+### Other
+- Use `Vector3::zero()` instead of `new Vector3()` in some places.
+
+# 4.18.1
+Released 27th March 2023.
+
+## General
+- `RakLibInterface` now logs the name of the currently active session if a crash occurs when processing a packet. This makes it easier to reproduce bugs, which is important to be able to fix them.
+- Added more detailed debugging information to `InventoryManager->syncSelectedHotbarSlot()`.
+
+## Fixes
+- Fixed server crash when attempting to drop more of an item from a stack than available in the inventory.
+- Fixed packet processing errors when editing writable books.
+- Fixed packet processing errors when shift-clicking on the recipe book to craft recipes which draw from a large number of inventory slots.
+
+# 4.18.2
+Released 29th March 2023.
+
+## Fixes
+- Fixed players being unable to join due to the appearance of a new `x5t` field in the JWT header of Xbox Live authentication tokens.
+- Fixed items' durability appearing to reset when moving them around in the inventory.
+
+# 4.18.3
+Released 5th April 2023.
+
+## Fixes
+- Fixed Average Players not being shown on timings reports when custom player classes are used.
+- Fixed incorrect tick violation calculation in timings reports.
+- Fixed not being able to add or remove items from the offhand slot.
+- Fixed creative inventory item count corruption when taking items (some players would see 64x items in the creative inventory after rejoining or changing gamemode).
+- Fixed not being able to drop items directly from the creative inventory on mobile.
+- Fixed `DataPacketReceiveEvent` not being called for packets sent by `EntityEventBroadcaster`.
+- `CreativeInventory::getItem()` and `CreativeInventory::getAll()` now return cloned itemstacks, to prevent accidental modification of the creative inventory.
+
+# 4.18.4
+Released 10th April 2023.
+
+## Fixes
+- Fixed movement becoming broken when the player moves at high speed (e.g. due to high levels of the Speed effect).
+- Updated dependencies to get fixes in `pocketmine/nbt` and `pocketmine/bedrock-protocol`.
+
+## Internals
+### Network
+- Game packets are now rate-limited in a similar manner to packet batches. This helps to more effectively mitigate certain types of DoS attacks.
+- Added a new class `PacketRateLimiter`, implementing functionality previously baked directly into `NetworkSession` in a more generic way to allow reuse.

changelogs/4.19.md

@@ -0,0 +1,111 @@
+**For Minecraft: Bedrock Edition 1.19.70**
+
+### Note about API versions
+Plugins which don't touch the `pocketmine\network\mcpe` namespace are 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 `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+### Highlights
+This version introduces support for a new, more advanced version of Timings.
+This improved system provides more detail than the old system, and supports being displayed in a tree view, making it much easier to see which timers contribute to which other timers.
+
+In addition, some minor performance improvements have been made, along with a couple of minor API additions.
+
+# 4.19.0
+Released 11th April 2023.
+
+## General
+- Updated the Timings system.
+  - Timings records now include parent information, allowing them to be displayed in a tree view (e.g. https://timings.pmmp.io/?id=303556).
+  - Timings records now include additional information, such as Peak (max time spent on any single tick), and Ticks (number of ticks the timer was active on).
+  - New timings have been added for every event.
+  - A new timer `Player Network Send - Pre-Spawn Game Data` has been added, and covers most of the time spent handling `ResourcePackClientResponsePacket`, giving a clearer picture of what's happening.
+- Improved performance of the plugin event system.
+  - By introducing some caching, the event system now has 90% less overhead than in previous versions.
+- Improved performance of the random chunk ticking system.
+  - The selection of ticked random chunks, and their validation for ticking, is now cached. This significantly reduces the overhead of chunk selection.
+  - Factions servers and other game modes with big maps and sparsely populated areas will see the most benefit from this change.
+  - Real-world performance benefit of this change is anywhere from 0-20%, depending on server type and configuration.
+- The `timings paste` command now logs a debug message with the server response on failure to paste a timings report.
+
+## API
+### `pocketmine\entity\object`
+- The following API constants have been added:
+  - `ExperienceOrb::DEFAULT_DESPAWN_DELAY` - the default delay in ticks before an experience orb despawns
+  - `ExperienceOrb::NEVER_DESPAWN` - magic value for `setDespawnDelay()` to make an experience orb never despawn
+  - `ExperienceOrb::MAX_DESPAWN_DELAY` - the maximum delay in ticks before an experience orb despawns
+- The following API methods have been added:
+  - `public ExperienceOrb->getDespawnDelay() : int` - returns the delay in ticks before this experience orb despawns
+  - `public ExperienceOrb->setDespawnDelay(int $despawnDelay) : void` - sets the delay in ticks before this experience orb despawns
+- The following properties have been deprecated
+  - `ExperienceOrb->age` - superseded by despawn delay methods
+
+### `pocketmine\event`
+- The following API methods have been added:
+  - `public HandlerList->getListenerList() : list<RegisteredListener>` - returns an ordered list of handlers to be called for the event
+
+### `pocketmine\player`
+- The following API methods have behavioural changes:
+  - `ChunkSelector->selectChunks()` now yields the distance in chunks from the center as the key, instead of an incrementing integer.
+- The following classes have been deprecated:
+  - `PlayerChunkLoader` (this was technically internal, but never marked as such)
+
+### `pocketmine\timings`
+- The following API constants have been deprecated:
+  - `Timings::INCLUDED_BY_OTHER_TIMINGS_PREFIX` - this is superseded by timings group support (see `Timings::GROUP_BREAKDOWN`)
+- The following API constants have been added:
+  - `Timings::GROUP_BREAKDOWN` - this group makes a timer appear in the `Minecraft - Breakdown` section of a timings report
+- The following API methods have been added:
+  - `public TimingsHandler->getGroup() : string` - returns the name of the table in which this timer will appear in a timings report
+- The following API methods have changed signatures:
+  - `TimingsHandler->__construct()` now accepts an additional, optional `string $group` parameter, which defaults to `Minecraft`.
+
+### `pocketmine\world`
+#### Highlights
+Ticking chunks is now done using the `ChunkTicker` system, which has a much more fine-grained API than the old `TickingChunkLoader` system, as well as better performance.
+It works similarly to the `ChunkLoader` system, in that chunks will be ticked as long as at least one `ChunkTicker` is registered for them.
+
+#### API changes
+- The following classes have been deprecated:
+  - `TickingChunkLoader` - this has been superseded by the more powerful and performant `ChunkTicker` APIs
+- The following classes have been added:
+  - `ChunkTicker` - an opaque object used for `registerTickingChunk()` to instruct the `World` that we want a chunk to be ticked
+- The following API methods have been added:
+  - `public World->registerTickingChunk(ChunkTicker $ticker, int $chunkX, int $chunkZ) : void` - registers a chunk to be ticked by the given `ChunkTicker`
+  - `public World->unregisterTickingChunk(ChunkTicker $ticker, int $chunkX, int $chunkZ) : void` - unregisters a chunk from being ticked by the given `ChunkTicker`
+
+# 4.19.1
+Released 14th April 2023.
+
+## Fixes
+- Fixed inventory rollbacks when spreading items in ender chests.
+- Fixed inventory rollbacks when shift-clicking to craft and the outputs would have been split across multiple inventory slots.
+- Fixed incorrect spawn terrain generation for newly created worlds.
+- Fixed `chunk-ticking.tick-radius` not disabling chunk ticking when set to `0`.
+- Fixed chunks not being ticked if they previously left a player's simulation distance without leaving their view distance.
+- Fixed height of collision boxes for Grass Path and Farmland blocks.
+
+# 4.19.2
+Released 14th April 2023.
+
+## Fixes
+- Fixed player timings duplication leading to extremely large timings reports when timings runs for a long time with many players.
+- Packet timings are now indexed by class FQN instead of packet ID. This prevents erroneous timer reuse on packet ID reuse (e.g. multi version servers).
+- Fixed entity timings being shared by different classes with the same short name. This led to incorrect timings being reported for some entities when custom entities were used.
+
+# 4.19.3
+Released 21st April 2023.
+
+## General
+- Error IDs for `Packet processing error` disconnects are now split into 4-character chunks to make them easier to type (since they can't be copied from the disconnection screen of a client).
+
+## Fixes
+- Fixed entity-block intersections being checked twice per tick. Besides wasting CPU time, this may have caused unexpected behaviour during entity-block interactions with blocks like water or cacti.
+- Fixed performance issue in network inventory synchronization due item NBT being prepared twice.
+- Fixed `tools/simulate-chunk-selector.php` argument parsing being completely broken (weird behaviour of PHP `getopt()`).
+
+## Internals
+- `TimingsHandler->stopTiming()` now logs an error message if a subtimer wasn't stopped, rather than throwing an exception.
+  - Due to interactions between `try...finally` and unexpected errors, throwing exceptions made it difficult for plugin developers to debug errors in their plugins, since it obscured the original error.

changelogs/4.20.md

@@ -0,0 +1,79 @@
+**For Minecraft: Bedrock Edition 1.19.80**
+
+### Note about API versions
+Plugins which don't touch the `pocketmine\network\mcpe` namespace are 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 `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+### Interim releases
+If you're upgrading from 4.17.x directly to 4.20.x, please also read the following changelogs, as the interim releases contain important changes:
+
+- [4.18.0](https://github.com/pmmp/PocketMine-MP/blob/4.20.0/changelogs/4.18.md#4180) - major performance improvements, internal network changes, minor API additions
+- [4.19.0](https://github.com/pmmp/PocketMine-MP/blob/4.20.0/changelogs/4.19.md#4190) - minor performance improvements, improved timings system, minor API additions
+
+# 4.20.0
+Released 26th April 2023.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.19.80.
+- Removed support for older versions.
+
+## Fixes
+- Fixed packet processing error when attempting to use a stonecutter.
+- Fixed armor slots containing ghost items when cancelling right-click to equip armor.
+- Fixed crash in `HandlerList->getListenersByPriority()` when no listeners are registered at the given priority.
+
+## API
+### `pocketmine\block`
+- The following API methods have been added:
+  - `public BaseSign->getEditorEntityRuntimeId() : int` - returns the entity runtime ID of the player currently editing this sign, or `null` if none
+  - `public BaseSign->setEditorEntityRuntimeId(?int $editorEntityRuntimeId) : $this` - sets the entity runtime ID of the player currently editing this sign
+
+### `pocketmine\player`
+- The following API methods have been added:
+  - `public Player->openSignEditor(Vector3 $position) : void` - opens the client-side sign editor GUI for the given position
+
+# 4.20.1
+Released 27th April 2023.
+
+## Fixes
+- Fixed server crash when firing a bow while holding arrows in the offhand slot.
+
+## Internals
+- `ItemStackContainerIdTranslator::translate()` now requires an additional `int $slotId` parameter and returns `array{int, int}` (translated window ID, translated slot ID) to be used with `InventoryManager->locateWindowAndSlot()`.
+- `InventoryManager->locateWindowAndSlot()` now checks if the translated slot actually exists in the requested inventory, and returns `null` if not. Previously, it would return potentially invalid slot IDs without checking them, potentially leading to crashes.
+
+# 4.20.2
+Released 4th May 2023.
+
+## Fixes
+- Fixed all types of wooden logs appearing as oak in the inventory.
+- Fixed a performance issue in `BaseInventory->canAddItem()` (missing `continue` causing useless logic to run).
+
+# 4.20.3
+Released 6th May 2023.
+
+## Improvements
+- Reduced memory usage of `RuntimeBlockMapping` from 25 MB to 9 MB. Since every thread has its own copy of the block map, this saves a substantial amount of memory.
+
+## Fixes
+- Fixed players falling through blocks in spectator mode.
+- Fixed timings reports getting bloated by prolific usage of `PluginManager->registerEvent()`.
+  - This was caused by creating a new timings handler for each call, regardless of whether a timer already existed for the given event and callback.
+- Fixed `Full Server Tick` and other records being missing from timings reports.
+  - This was caused by timings handler depth not getting reset when timings was disabled and later re-enabled.
+
+# 4.20.4
+Released 6th May 2023.
+
+## Fixes
+- Fixed players being forced into flight mode in every game mode.
+  - Moral of the story: do not assume anything in Mojang internals does what its name suggests...
+
+# 4.20.5
+Released 30th May 2023.
+
+## Fixes
+- Fixed server crash due to a bug in upstream dependency [`netresearch/jsonmapper`](https://github.com/cweiske/JsonMapper).

changelogs/4.21.md

@@ -0,0 +1,77 @@
+**For Minecraft: Bedrock Edition 1.19.80**
+
+### Note about API versions
+Plugins which don't touch the `pocketmine\network\mcpe` namespace, and don't use reflection or any internal methods,
+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 `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+# 4.21.0
+Released 17th May 2023.
+
+## General
+- PHP 8.1 is now required. Most plugins should run without changes, but some might need to be updated due to language-level deprecations.
+- Ticking chunk count is now shown separately from loaded chunk count in the `/status` command, providing useful performance information.
+- Further improved performance of ticking chunk selection.
+- Improved performance of some inventory functions.
+- Reduced server memory footprint in most cases by ~9 MB per thread.
+- Due to large overhead, async network compression is now only used for packets larger than 10 KB by default.
+
+## Configuration
+- Added the following new `pocketmine.yml` configuration options:
+  - `network.async-compression-threshold` - minimum size of packet which will be compressed using `AsyncTask`
+    - Default is 10 KB, which means that very few packets will use async compression in practice. This is because the overhead of compressing async is currently so high that it's not worth it for smaller packets.
+
+## Timings
+- Timings reports no longer include the unused metadata fields `Entities` and `LivingEntities`.
+- Timings reports now correctly calculate the peak time of a timer.
+  - Previously it was incorrectly recorded as the longest time spent in a single tick, rather than the longest time spent in a single activation.
+  - Timings report version has been bumped to `2` to reflect this change.
+- All world-specific timers now have generic aggregate timings, making it much easier to locate performance patterns across all worlds.
+
+## Gameplay
+- Players in spectator mode are no longer able to pick blocks, and now have finite resources similar to survival mode.
+
+## API
+### `pocketmine\world`
+- The following API methods have been added:
+  - `public World->getTickingChunks() : list<int>` - returns a list of chunk position hashes (a la `World::chunkHash()`) which are currently valid for random ticking
+
+### `pocketmine\inventory`
+- The following API methods have been added:
+  - `protected BaseInventory->getMatchingItemCount(int $slot, Item $test, bool $checkDamage, bool $checkTags) : int` - returns the number of items in the given stack if the content of the slot matches the test item, or zero otherwise
+    - This should be overridden if directly extending `BaseInventory` to provide a performance-optimised version. A slow default implementation is provided, but it will be removed in the future.
+  
+## Internals
+### Entity
+- Unused `NameTag` tag is no longer saved for `Human` entities.
+
+### Inventory
+- `BaseInventory` now uses a new internal method `getMatchingItemCount()` to locate items in the inventory without useless cloning. This improves performance of various API methods, such as `addItem()`, `contains()`, and more.
+- Specialization of `Inventory->isSlotEmpty()` in `BaseInventory` subclasses has been added to improve performance of some API methods.
+
+### Network
+- `RuntimeBlockMapping` no longer keeps all block palette NBT data in memory.
+  - This significantly reduces server idle memory footprint.
+  - For multi-version implementations, this will have a significant impact on memory usage, since a different block palette is often required to support each version.
+  - NBT will be lazy-loaded into memory and cached if `getBedrockKnownStates()` is called. However, this is not used by PocketMine-MP under normal circumstances.
+- Removed unnecessary usage of `Utils::validateCallableSignature()` from some internal network pathways, improving performance.
+
+### Scheduler
+- `AsyncPool` no longer double-checks progress updates on completed tasks.
+
+### World
+- Ticking chunks are now tracked in `World->validTickingChunks` and `World->recheckTickingChunks`.
+    - This allows avoiding rechecking every ticking chunk for validity during ticking chunk selection, improving performance.
+    - In some cases, this allows bypassing chunk selection entirely, reducing selection cost to zero.
+- Registered but ineligible ticking chunks are no longer rechecked every tick.
+    - This was causing wasted cycles during async worker backlog.
+    - The internal system must call `markTickingChunkForRecheck()` whenever a ticking chunk's eligibility for ticking has potentially changed, rather than just when it has changed from a yes to a no.
+
+# 4.21.1
+Released 30th May 2023.
+
+## Fixes
+- Fixed server crash due to a bug in upstream dependency [`netresearch/jsonmapper`](https://github.com/cweiske/JsonMapper).

changelogs/4.22.md

@@ -0,0 +1,24 @@
+# 4.22.0
+Released 7th June 2023.
+
+**For Minecraft: Bedrock Edition 1.20.0**
+
+This is a support release for Minecraft: Bedrock Edition 1.20.0.
+
+**Plugin compatibility:** Plugins for previous 4.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## Interim releases
+If you're upgrading from 4.20.x directly to 4.22.x, please also read the following changelogs, as the interim releases contain important changes:
+- [4.21.0](https://github.com/pmmp/PocketMine-MP/blob/4.22.0/changelogs/4.21.md#4210) - PHP 8.1 minimum version, minor performance improvements
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.20.0.
+- Removed support for older versions.
+
+## Fixes
+- Removed deprecated `ReflectionProperty::setAccessible()` calls.
+- Fixed jukebox music not stopping when destroyed by an explosion.

changelogs/4.9.md

@@ -12,3 +12,25 @@ Released 20th September 2022.
 ## General
 - Added support for Minecraft: Bedrock Edition 1.19.30.
 - Removed support for older versions.
+
+# 4.9.1
+Released 11th October 2022.
+
+## Documentation
+- Added and improved documentation for many API methods in `Player` and `Block`.
+- Added missing `@internal` tag for `TaskHandler->setNextRun()`, `TaskHandler->remove()` and `TaskHandler->run()`.
+
+## Fixes
+- Flight state is now locked by the server in spectator mode. This prevents any attempt by the client to toggle flight mode.
+- Fixed entity health exceeding its max health after the expiry of Health Boost effect.
+- Fixed burp sound not being played when a player eats food.
+- Fixed placement conditions for mushrooms - they can now only be placed when the light level at the target is <= 12, or on podzol or mycelium.
+- Fixed sign text appearing to change colour and/or glow when using dye on a sign - since this feature is not yet implemented, no change should occur.
+- Fixed players drowning when sprint-swimming on the surface of water.
+
+## Internals
+- Added more detailed debug logging during the player login sequence.
+- Silenced debug spam during `PreSpawnPacketHandler`, considerably reducing debug noise when players join.
+- Fixed an edge case in `InventoryManager->removeWindow()`. This bug didn't have any effect on stable versions, but caused a `next-minor` development version to crash.
+- `Item`s returned by event getters are now cloned if modifying the result will have no useful side effects.
+- Updated `pocketmine/bedrock-data` to [`1.11.1`](https://github.com/pmmp/BedrockData/tree/1.11.1%2Bbedrock-1.19.30), which reduces bandwidth consumption during logins by not sending useless biome generation data.

changelogs/5.0-alpha.md

@@ -618,3 +618,421 @@ Released 24th September 2022.
 ### Effects
 - Updated damage modifier amounts for Instant Damage to be more in line with vanilla.
 - Updated duration modifier amounts for Regeneration to be more like vanilla.
+
+# 5.0.0-ALPHA5
+Released 13th November 2022.
+
+**This release includes changes from [4.11.0-BETA2](https://github.com/pmmp/PocketMine-MP/releases/4.11.0-BETA2) and earlier, which may not be listed here.**
+
+## General
+- Added support for Minecraft: Bedrock 1.19.40.
+- Removed support for earlier versions.
+
+## API
+### `pocketmine\block`
+- `FallableTrait` now includes a default implementation of `tickFalling()`.
+
+### `pocketmine\event`
+- The following API methods have been removed:
+  - `PlayerCommandPreprocessEvent`
+- The following API methods have been added:
+  - `public DataPacketSendEvent->setPackets(list<ClientboundPacket> $packets) : void`
+
+## Gameplay
+### General
+- Fixed dyeing leather armour in cauldrons.
+
+### Blocks
+- Copper blocks now play the correct scrape sound when using an axe on them.
+
+## Internals
+- Moved command timings to `Timings`.
+
+# 5.0.0-ALPHA6
+Released 19th December 2022.
+
+**This release includes changes from the following releases, which may not be mentioned:**
+- [4.10.2](https://github.com/pmmp/PocketMine-MP/releases/tag/4.10.2)
+- [4.11.0](https://github.com/pmmp/PocketMine-MP/releases/tag/4.11.0)
+- [4.12.0](https://github.com/pmmp/PocketMine-MP/releases/tag/4.12.0)
+- [4.12.1](https://github.com/pmmp/PocketMine-MP/releases/tag/4.12.1)
+- [4.12.2](https://github.com/pmmp/PocketMine-MP/releases/tag/4.12.2)
+
+## General
+- Fixed the Bedrock client asking to upgrade worlds exported from PocketMine-MP to Bedrock (missing level.dat fields).
+- Added support for 1.19.40 and newer Bedrock worlds.
+- Commands are now enabled by default in worlds exported from PocketMine-MP to Bedrock.
+
+## Gameplay
+### Blocks
+- Added the following new blocks:
+  - Twisting Vines
+  - Weeping Vines
+- Anvils are now damaged when they hit the ground after falling.
+- Added missing sounds for anvils hitting the ground after falling.
+- Fixed missing sounds when a projectile strikes an amethyst block.
+- Fixed some blocks being incorrectly able to be placed on top of a candle cake.
+
+### Items
+- Added the following new items:
+  - Music Disc (5)
+  - Music Disc (Otherside)
+  - Music Disc (Pigstep)
+- Implemented Swift Sneak enchantment.
+- Armour durability is now only reduced when the wearer receives a type of damage that the armour can protect against.
+
+## API
+### General
+- Union and mixed native parameter, return and property types are now used where appropriate.
+
+### `pocketmine\block`
+- The following new API methods have been added:
+  - `public Furnace->getType() : utils\FurnaceType`
+- The following interfaces have new requirements:
+  - `utils\Fallable` now requires `onHitGround()` to be implemented (although filled by default implementation in `FallableTrait`).
+  - `utils\Fallable` now requires `getLandSound()` to be implemented (although filled by default implementation in `FallableTrait`).
+- The following new API constants have been added:
+  - `public BlockTypeTags::FIRE` - used by fire and soul fire
+
+### `pocketmine\crafting`
+- The `$type` parameter of `ShapelessRecipe->__construct()` is now mandatory.
+
+### `pocketmine\entity`
+- The following new API methods have been added:
+  - `public Living->getDisplayName() : string`
+- The following API methods have changed signatures:
+  - `EntityFactory->register()` no longer accepts a `$legacyMcpeSaveId` parameter (now handled by internal conversions instead).
+
+### `pocketmine\event`
+- The following classes have been renamed:
+  - `entity\ExplosionPrimeEvent` -> `entity\EntityPreExplodeEvent`
+- The following new classes have been added:
+  - `world\WorldParticleEvent` - called when a particle is spawned in a world
+  - `world\WorldSoundEvent` - called when a sound is played in a world
+- The following API methods have changed signatures:
+  - `entity\EntityPreExplodeEvent->__construct()` has the `$force` parameter renamed to `$radius`
+  - `entity\EntityPreExplodeEvent->getForce() : float` -> `entity\EntityPreExplodeEvent->getRadius() : float`
+  - `entity\EntityPreExplodeEvent->setForce(float $force) : void` -> `entity\EntityPreExplodeEvent->setRadius(float $radius) : void`
+
+### `pocketmine\item`
+- The following new API methods have been added:
+  - `public Item->keepOnDeath() : bool` - returns whether this item will be retained when a player carrying it dies
+  - `public Item->onInteractEntity(Player $player, Entity $entity, Vector3 $clickPos) : bool` - called when a player interacts with an entity with this item in their hand
+  - `public Item->setKeepOnDeath(bool $keepOnDeath) : void` - sets whether this item will be retained when a player carrying it dies
+  - `public StringToItemParser->lookupAliases(Item $item) : list<string>` - returns a list of all registered aliases for the given item
+  - `public StringToItemParser->lookupBlockAliases(Block $block) : list<string>` - returns a list of all registered aliases for the given block
+
+### `pocketmine\resourcepacks`
+- The following new API methods have been added:
+  - `public ResourcePackManager->setPackEncryptionKey(string $id, ?string $key) : void` - sets the encryption key to be used for the resource pack identified by the given UUID
+  - `public ResourcePackManager->setResourceStack(list<ResourcePack> $resourceStack) : void` - sets the resource stack to be used by the server
+
+### `pocketmine\world`
+- The following API methods have changed signatures:
+  - `Explosion->__construct()` has the `$size` parameter renamed to `$radius`
+- The following public properties have been renamed:
+  - `Explosion->size` -> `Explosion->radius`
+
+## Internals
+- `EntityLegacyIds` has been removed. Legacy entity IDs found during world loading are now converted via `LegacyEntityIdToStringIdMap`.
+- All usages of NBT keys now use class constants instead of hardcoded strings (except for an occasional overlooked one).
+- All members of `BlockTypeTags` now have a `pocketmine:` prefix on the value. This does not affect constant usages.
+
+# 5.0.0-ALPHA7
+Released 18th January 2023.
+
+**This release includes changes from the following releases, which may not be mentioned:**
+- [4.12.3](https://github.com/pmmp/PocketMine-MP/releases/tag/4.12.3)
+- [4.12.4](https://github.com/pmmp/PocketMine-MP/releases/tag/4.12.4)
+- [4.12.5](https://github.com/pmmp/PocketMine-MP/releases/tag/4.12.5)
+- [4.12.6](https://github.com/pmmp/PocketMine-MP/releases/tag/4.12.6)
+- [4.12.7](https://github.com/pmmp/PocketMine-MP/releases/tag/4.12.7)
+- [4.12.8](https://github.com/pmmp/PocketMine-MP/releases/tag/4.12.8)
+- [4.12.9](https://github.com/pmmp/PocketMine-MP/releases/tag/4.12.9)
+- [4.12.10](https://github.com/pmmp/PocketMine-MP/releases/tag/4.12.10)
+- [4.13.0-BETA1](https://github.com/pmmp/PocketMine-MP/releases/tag/4.13.0-BETA1)
+
+## Fixes
+- Fixed glowing item frame placement creating the wrong tile, causing invisible items.
+
+## Localization
+- Localized disconnect messages are now used in the following cases:
+  - Server full
+  - Player not on the server whitelist
+  - Player on the server ban list
+  - Invalid skin
+  - Invalid username
+  - Kicked using `/kick`
+  - Banned using `/ban`
+  - Failure to find a safe spawn position
+- Session open, session close and session player name discovery messages are now localized.
+- All permissions now have localized descriptions. These are not currently used by PocketMine-MP, but may be useful for plugins.
+
+## Gameplay
+### Worlds
+- Added support for 3D biomes. This isn't used by PocketMine-MP yet, but is necessary to be able to fully load 1.18 worlds.
+
+### Blocks
+- Added the following new blocks:
+  - Chain
+  - Sculk
+
+### Items
+- Added the following new items:
+  - Eye Drops (from Education Edition)
+  - Antidote (from Education Edition)
+  - Elixir (from Education Edition)
+  - Tonic (from Education Edition)
+
+## API
+### Overview
+- Biome-related APIs have changed to accommodate 3D biomes.
+- Disconnect-related APIs have changed to accommodate localized disconnect messages.
+- New, more powerful chat formatting API introduced to `PlayerChatEvent`.
+- Glowing item frames moved to a separate block type instead of being a property of regular item frames (due to technical limitations).
+
+### `pocketmine\block`
+- The following API methods have been removed:
+  - `ItemFrame->isGlowing() : bool`
+  - `ItemFrame->setGlowing(bool $glowing) : void`
+- The following new API methods have been added:
+  - `public static VanillaBlocks::GLOWING_ITEM_FRAME() : ItemFrame`
+- The following constants have been added:
+  - `BlockTypeIds::GLOWING_ITEM_FRAME`
+  - `BlockTypeIds::CHAIN`
+  - `BlockTypeIds::SCULK`
+- The following new classes have been added:
+  - `Chain`
+  - `Sculk`
+
+### `pocketmine\event\player`
+- The following API methods have changed signatures:
+  - `PlayerDuplicateLoginEvent->getDisconnectMessage()` now returns `Translatable|string` instead of `string`
+  - `PlayerDuplicateLoginEvent->setDisconnectMessage()` now accepts `Translatable|string` instead of `string`
+  - `PlayerKickEvent->getReason()` now returns `Translatable|string` instead of `string`
+  - `PlayerKickEvent->setReason()` now accepts `Translatable|string` instead of `string`
+  - `PlayerLoginEvent->getKickMessage()` now returns `Translatable|string` instead of `string`
+  - `PlayerLoginEvent->setKickMessage()` now accepts `Translatable|string` instead of `string`
+  - `PlayerPreLoginEvent->getFinalKickMessage()` now returns `Translatable|string` instead of `string`
+  - `PlayerPreLoginEvent->getKickMessage()` now returns `Translatable|string|null` instead of `string|null`
+  - `PlayerPreLoginEvent->setKickReason()` now accepts `Translatable|string` for the `$message` parameter instead of `string`
+  - `PlayerQuitEvent->getQuitReason()` now returns `Translatable|string` instead of `string`
+- The following API methods have been removed:
+  - `PlayerChatEvent->getFormat()` (use `PlayerChatEvent->getChatFormatter()` instead)
+  - `PlayerChatEvent->setFormat()` (use `PlayerChatEvent->setChatFormatter()` instead)
+- The following new API methods have been added:
+  - `public PlayerChatEvent->setChatFormatter(\pocketmine\player\chat\ChatFormatter $formatter) : void` - sets the chat formatter to be used for this event
+  - `public PlayerChatEvent->getChatFormatter() : \pocketmine\player\chat\ChatFormatter` - returns the chat formatter to be used for this event
+
+### `pocketmine\item`
+- The following new classes have been added:
+  - `Medicine`
+  - `MedicineType`
+- The following new class constants have been added:
+  - `ItemTypeIds::MEDICINE`
+
+### `pocketmine\network\query`
+- The following API methods have changed signatures:
+  - `QueryInfo->getPlayerList()` now returns `list<string>` instead of `list<Player>`
+  - `QueryInfo->setPlayerList()` now accepts `list<string>` instead of `list<Player>`
+
+### `pocketmine\player`
+- The following API methods have changed signatures:
+  - `Player->kick()` now accepts `Translatable|string` for `$reason` instead of `string` (to allow localized kick messages)
+  - `Player->disconnect()` now accepts `Translatable|string` for `$reason` instead of `string` (to allow localized disconnect messages)
+  - `Player->sendJukeboxPopup()` now accepts `Translatable|string` instead of `string, string[]`
+
+#### `pocketmine\player\chat`
+- The following new classes have been added:
+  - `ChatFormatter` - interface implemented by chat formatters
+  - `StandardChatFormatter` - formats chat messages in the vanilla Minecraft style
+  - `LegacyRawChatFormatter` - implements the same behaviour previously used by `PlayerChatEvent->setFormat()`
+
+### `pocketmine\world`
+- The following API methods have changed signatures:
+  - `World->getBiome()` now accepts `int $x, int $y, int $z` instead of `int $x, int $z`
+  - `World->getBiomeId()` now accepts `int $x, int $y, int $z` instead of `int $x, int $z`
+  - `World->setBiomeId()` now accepts `int $x, int $y, int $z` instead of `int $x, int $z`
+
+#### `pocketmine\world\format`
+- The following new API methods have been added:
+  - `public SubChunk->getBiomeArray() : PalettedBlockArray`
+- The following API methods have changed signatures:
+  - `Chunk->getBiomeId()` now accepts `int $x, int $y, int $z` instead of `int $x, int $z`
+  - `Chunk->setBiomeId()` now accepts `int $x, int $y, int $z` instead of `int $x, int $z`
+  - `Chunk->__construct()` no longer accepts `BiomeArray` as a parameter (contained in each subchunk instead)
+  - `SubChunk->__construct()` now accepts `int $emptyBlockId, list<PalettedBlockArray> $blocks, PalettedBlockArray $biomes, ?LightArray $blockLight, ?LightArray $skyLight` instead of `int, list<PalettedBlockArray>, ?LightArray, ?LightArray` 
+- The following classes have been removed
+  - `BiomeArray`
+
+## Internals
+- Built-in commands now declare their names inside the class constructor, rather than accepting them as parameters. This improves code consistency.
+- `NetworkSession` disconnect APIs now accept `Translatable|string` instead of `string` to allow localized disconnect messages.
+- All external usages of `KnownTranslationKeys` are now removed. All localized messages are now sent using `Translatable` objects (usually from `KnownTranslationFactory`).
+
+# 5.0.0-ALPHA8
+Released 23rd January 2023.
+
+## Core
+- Updated `ext-pthreads` requirement to `^5.1.0`. This version improves performance, memory usage, includes BC-breaking API changes, and removes a lot of confusing behaviour.
+  - See [`ext-pthreads` 5.0.0 release](https://github.com/pmmp/pthreads/releases/tag/5.0.0) for more information.
+  - For the most part, plugins will be unaffected, unless using `Threaded` objects directly, or directly interacting with other pthreads APIs.
+
+## API
+### Overview
+- It's now possible to specify a different disconnect reason and disconnection screen message. This is useful if you want to display a fancy disconnect screen, but don't want to spam the server log with useless information.
+
+### `pocketmine\event\player`
+- The following API methods have been removed:
+  - `PlayerKickEvent->getReason()` - replaced by `getDisconnectReason()` and `getDisconnectScreenMessage()`
+  - `PlayerKickEvent->setReason()` - replaced by `setDisconnectReason()` and `setDisconnectScreenMessage()`
+  - `PlayerDuplicateLoginEvent->getDisconnectMessage()` - replaced by `getDisconnectReason()` and `getDisconnectScreenMessage()`
+  - `PlayerDuplicateLoginEvent->setDisconnectMessage()` - replaced by `setDisconnectReason()` and `setDisconnectScreenMessage()`
+- The following new API methods have been added:
+  - `public PlayerKickEvent->getDisconnectReason() : Translatable|string` - returns the reason for the disconnection displayed in the console and server log
+  - `public PlayerKickEvent->setDisconnectReason(Translatable|string $disconnectReason) : void` - sets the reason for the disconnection displayed in the console and server log
+  - `public PlayerKickEvent->getDisconnectScreenMessage() : Translatable|string|null` - returns the message to be displayed on the disconnect screen (the message in `getDisconnectReason()` is used if null is returned)
+  - `public PlayerKickEvent->setDisconnectScreenMessage(Translatable|string|null $disconnectScreenMessage) : void` - sets the message to be displayed on the disconnect screen (the message in `setDisconnectReason()` is used if null is passed)
+  - `public PlayerDuplicateLoginEvent->getDisconnectReason() : Translatable|string` - returns the reason for the disconnection displayed in the console and server log
+  - `public PlayerDuplicateLoginEvent->setDisconnectReason(Translatable|string $disconnectReason) : void` - sets the reason for the disconnection displayed in the console and server log
+  - `public PlayerDuplicateLoginEvent->getDisconnectScreenMessage() : Translatable|string|null` - returns the message to be displayed on the disconnect screen (the message in `getDisconnectReason()` is used if null is returned)
+  - `public PlayerDuplicateLoginEvent->setDisconnectScreenMessage(Translatable|string|null $disconnectScreenMessage) : void` - sets the message to be displayed on the disconnect screen (the message in `setDisconnectReason()` is used if null is passed)
+
+### `pocketmine\network`
+- The following API methods have changed signatures:
+  - `NetworkSessionManager->close()` now accepts an additional `Translatable|string|null $disconnectScreenMessage` parameter.
+
+### `pocketmine\player`
+- The following API methods have changed signatures:
+  - `Player->kick()` now accepts an additional `Translatable|string|null $disconnectScreenMessage` parameter, which is the message to be displayed on the disconnect screen (the message in `$reason` is used if null is passed)
+  - `Player->disconnect()` now accepts an additional `Translatable|string|null $disconnectScreenMessage` parameter, which is the message to be displayed on the disconnect screen (the message in `$reason` is used if null is passed)
+
+## Internals
+- `NetworkSession` disconnect methods have been altered to allow specifying a different disconnect reason and disconnection screen message.
+
+# 5.0.0-ALPHA9
+Released 21st February 2023.
+
+## Core
+- Introduced timings for individual packet encoding.
+- Network timings now cover more parts of the network system which weren't previously accounted for.
+
+## API
+### `pocketmine\block`
+- Blocks are no longer required to explicitly specify how many type or state data bits they require. This is now automatically calculated using `RuntimeDataSizeCalculator`.
+- The following API methods have changed signatures:
+  - `Block->describeState()` now accepts `RuntimeDataDescriber` instead of `RuntimeDataReader|RuntimeDataWriter`
+  - `Block->describeType()` now accepts `RuntimeDataDescriber` instead of `RuntimeDataReader|RuntimeDataWriter`
+  - `Block->getRequiredStateDataBits()` is now `final`.
+  - `Block->getRequiredTypeDataBits()` is now `final`.
+  - `Leaves->__construct()` now `LeavesType $leavesType` instead of `TreeType $treeType`
+- The following API methods have been added:
+  - `public Leaves->getLeavesType() : LeavesType` - returns the type of leaves
+- The following classes have been added:
+  - `LeavesType` - an enum of all the different types of leaves
+- The following classes have been renamed:
+  - `BlockFactory` -> `RuntimeBlockStateRegistry` - this more accurately describes the purpose of the class
+- The following API methods have changed behaviour:
+  - `RuntimeBlockStateRegistry->register()` now throws a `LogicException` if a block does not properly reject invalid state data.
+
+### `pocketmine\command`
+- `SimpleCommandMap` now requires all commands to have a permission set when registered.
+  - If you actually want to allow everyone to use your command (not advised), you can add a new permission to the `pocketmine.group.user` group, or use `default: true` for `plugin.yml` permissions.
+- The following API methods have changed behaviour:
+  - `Command->testPermissionSilent()` now returns `false` if there are no permissions associated with the command. This is to prevent commands with no permissions being usable by everyone, which has previously been a source of security issues.
+- The following API methods have been added:
+  - `public Command->getPermissions() : list<string>` - returns a list of permissions which grant usage access to this command. A user with one or more of these permissions will be able to invoke the command's `execute()` method
+  - `public Command->setPermissions(list<string> $permissions) : void` - sets the permissions which grant usage access to this command. This should be used instead of `setPermission()` with `;` separators (which is now deprecated)
+
+### `pocketmine\data\bedrock\block`
+- The following API methods have been added:
+  - `public static BlockStateData::current(string $name, array<string, Tag> $states) : BlockStateData` - creates a new `BlockStateData` instance with the current blockstate version
+
+### `pocketmine\data\bedrock\block\upgrade`
+- Blockstate upgrade schemas are now indexed by schema ID instead of Minecraft version. This is because the Minecraft blockstate version isn't consistently bumped when changes are made.
+- `BlockStateUpgrader` now requires that every schema added must have a unique schema ID.
+- The following API methods have been removed:
+  - `BlockStateUpgradeSchema->getPriority()`
+- The following API methods have been added:
+  - `public BlockStateUpgradeSchema->getSchemaId() : int` - returns the schema ID of this upgrade schema, usually the number at the start of the JSON filename
+- The following API methods have changed signatures:
+  - `BlockStateUpgradeSchemaUtils::fromJsonModel()` now accepts `int $schemaId` instead of `int $priority`
+  - `BlockStateUpgradeSchemaUtils::loadSchemaFromString()` now accepts `int $schemaId` instead of `int $priority`
+  - `BlockStateUpgradeSchemaUtils::loadSchemas()` now accepts `int $maxSchemaId` instead of `int $currentVersion`
+
+### `pocketmine\data\bedrock\item\upgrade`
+- The following API methods have changed signatures:
+  - `ItemUpgradeSchemaUtils::loadSchemas()` now accepts `int $maxSchemaId`
+- The following API methods have been renamed:
+  - `ItemIdMetaUpgradeSchema->getPriority()` -> `ItemIdMetaUpgradeSchema->getSchemaId()`
+- The following classes have been added:
+  - `ItemIdMetaUpgrader` - encapsulates handling for upgrading item string IDs and meta to newer versions
+- The following API methods have been moved:
+  - `ItemDataUpgrader->addIdMetaUpgradeSchema()` -> `ItemIdMetaUpgrader->addSchema()`
+  - `ItemDataUpgrader->upgradeItemStringIdMeta()` -> `ItemIdMetaUpgrader->upgrade()`
+
+### `pocketmine\data\runtime`
+- The following interfaces have been added:
+  - `RuntimeDataDescriber` - contract for symmetric APIs exposed by `RuntimeDataReader`, `RuntimeDataWriter` and `RuntimeDataSizeCalculator`
+
+### `pocketmine\event\player`
+- `PlayerPreLoginEvent` now supports setting separate log reasons (disconnect reason) and disconnect screen messages.
+- The following classes have inheritance changes:
+  - `PlayerPreLoginEvent` no longer implements `Cancellable`. This caused unexpected behaviour for most plugin devs due to default-ignoring cancelled events, forcing people to usually have to use `@handleCancelled` to handle the event when they wanted to use it.
+- The following API methods have been added:
+  - `public PlayerPreLoginEvent->getDisconnectScreenMessage(int $flag) : Translatable|string|null` - returns the message to be displayed on the disconnect screen for the specified kick flag, if set
+  - `public PlayerPreLoginEvent->getFinalDisconnectScreenMessage() : Translatable|string|null` - returns the message to be displayed on the disconnect screen, taking into account the kick flags set
+- The following API constants have been renamed:
+  - `PlayerPreLoginEvent::KICK_REASON_BANNED` -> `PlayerPreLoginEvent::KICK_FLAG_BANNED`
+  - `PlayerPreLoginEvent::KICK_REASON_PLUGIN` -> `PlayerPreLoginEvent::KICK_FLAG_PLUGIN`
+  - `PlayerPreLoginEvent::KICK_REASON_PRIORITY` -> `PlayerPreLoginEvent::KICK_FLAG_PRIORITY`
+  - `PlayerPreLoginEvent::KICK_REASON_SERVER_FULL` -> `PlayerPreLoginEvent::KICK_FLAG_SERVER_FULL`
+  - `PlayerPreLoginEvent::KICK_REASON_SERVER_WHITELISTED` -> `PlayerPreLoginEvent::KICK_FLAG_SERVER_WHITELISTED`
+- The following API methods have been renamed:
+  - `PlayerPreLoginEvent->clearAllKickReasons()` -> `PlayerPreLoginEvent->clearAllKickFlags()`
+  - `PlayerPreLoginEvent->clearKickReason()` -> `PlayerPreLoginEvent->clearKickFlag()`
+  - `PlayerPreLoginEvent->getFinalKickMessage()` -> `PlayerPreLoginEvent->getFinalDisconnectReason()` (now used for logs only, if a disconnect screen message is set for the highest priority flag)
+  - `PlayerPreLoginEvent->getKickMessage()` -> `PlayerPreLoginEvent->getDisconnectReason()` (now used for logs only, if a disconnect screen message is set for the flag)
+  - `PlayerPreLoginEvent->getKickReasons()` -> `PlayerPreLoginEvent->getKickFlags()`
+  - `PlayerPreLoginEvent->isKickReasonSet()` -> `PlayerPreLoginEvent->isKickFlagSet()`
+  - `PlayerPreLoginEvent->setKickReason()` -> `PlayerPreLoginEvent->setKickFlag()`
+- The following API methods have changed signatures:
+  - `PlayerPreLoginEvent->setKickFlag()` (previously `setKickReason()`) now accepts `Translatable|string $disconnectReason, Translatable|string|null $disconnectScreenMessage = null` instead of `Translatable|string $message`
+
+### `pocketmine\event\block`
+- The following classes have inheritance changes:
+  - `BlockPlaceEvent` no longer extends `BlockEvent`, and therefore no longer has `getBlock()`.
+- The following API methods have been removed:
+  - `BlockPlaceEvent->getBlockReplaced()` - this information is now provided in the `BlockTransaction` object returned by `BlockPlaceEvent->getTransaction()`
+- The following API methods have been added:
+  - `public BlockPlaceEvent->getTransaction() : BlockTransaction` - returns the transaction containing a list of changed block positions and the blockstates they will be changed to
+- The following API methods have changed signatures:
+  - `BlockPlaceEvent->__construct()` now accepts `BlockTransaction $transaction` instead of `Block $blockPlace, Block $blockReplace`
+
+### `pocketmine\item`
+- The following API methods have signature changes:
+  - `Item->describeType()` now accepts `RuntimeDataDescriber` instead of `RuntimeDataReader|RuntimeDataWriter`
+
+### `pocketmine\world\format`
+- The following API methods have been renamed:
+  - `Chunk->getFullBlock()` -> `Chunk->getBlockStateId()`
+  - `Chunk->setFullBlock()` -> `Chunk->setBlockStateId()`
+  - `SubChunk->getFullBlock()` -> `SubChunk->getBlockStateId()`
+  - `SubChunk->setFullBlock()` -> `SubChunk->setBlockStateId()`
+
+## Gameplay
+### Blocks
+- The following new blocks have been added:
+  - Mangrove Leaves
+  - Azalea Leaves
+  - Flowering Azalea Leaves
+  - Reinforced Deepslate
+- Fixed incorrect drops of deepslate when mined without a Silk Touch tool.
+- Bells now ring when hit by a projectile.
+
+## Internals
+- `build/generate-runtime-enum-serializers.php` now generates the following additional classes:
+  - `interface RuntimeEnumDescriber`
+  - `trait RuntimeEnumSizeCalculatorTrait`
+- Block type/state data required bits are now calculated from `Block->describeType()` using `RuntimeDataSizeCalculator`.
+- Commands now use an array for permissions internally, instead of a string separated by `;`.

changelogs/5.0-beta.md

@@ -0,0 +1,215 @@
+**For Minecraft: Bedrock Edition 1.19.62**
+
+5.0.0 is a major update to PocketMine-MP, including many new features and API changes. It is **not** compatible with plugins written for previous versions of PocketMine-MP.
+
+**During the beta phase, no new features will be added.**
+
+This stage of development is focused on stability and cleaning up any major issues introduced during the alpha stage.
+
+## WARNING
+**This is a BETA release.** This means that it may be unstable, and is not yet ready for production use.
+
+Since this version has undergone substantial changes compared to 4.x, plugins written for 4.x will need to be updated to work on this version.
+
+Breaking API changes may still occur during the beta phase, but only if they are strictly necessary to fix a problem prior to full release.
+
+**BACK UP your data before testing this.** This version will work with worlds and player data from 4.x,
+BUT any world or player data loaded in 5.0.0 will not work in 4.x due to backwards-incompatible storage format changes.
+
+# 5.0.0-BETA1
+Released 7th March 2023.
+
+**This release includes changes from the following releases:**
+- [All 5.0.0 alpha releases](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA1/changelogs/5.0-alpha.md)
+- [4.15.2](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA1/changelogs/4.15.md#4152)
+- [4.15.3](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA1/changelogs/4.15.md#4153)
+- [4.16.0](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA1/changelogs/4.16.md#4160)
+
+## API
+### `pocketmine\block`
+- Improved documentation for the following methods:
+  - `Block->getTypeId()`
+  - `Block->getStateId()`
+  - `Block->describeType()`
+  - `Block->describeState()`
+
+### `pocketmine\command`
+- The following API methods have been renamed:
+  - `Command->getPermission()` -> `Command->getPermissions()`
+
+## Internals
+- The following methods have been renamed:
+  - `Block->computeStateData()` -> `Block->computeTypeAndStateData()`
+  - `Block->decodeStateData()` -> `Block->decodeTypeAndStateData()`
+- Wall state data now packs connections into 7 bits instead of 8.
+
+# 5.0.0-BETA2
+Released 11th April 2023.
+
+**This release includes changes from the following releases:**
+- [4.17.0](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA2/changelogs/4.17.md#4170)
+- [4.17.1](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA2/changelogs/4.17.md#4171)
+- [4.17.2](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA2/changelogs/4.17.md#4172)
+- [4.18.0](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA2/changelogs/4.18.md#4180)
+- [4.18.1](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA2/changelogs/4.18.md#4181)
+- [4.18.2](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA2/changelogs/4.18.md#4182)
+- [4.18.3](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA2/changelogs/4.18.md#4183)
+- [4.18.4](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA2/changelogs/4.18.md#4184)
+- [4.19.0](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA2/changelogs/4.19.md#4190)
+
+## Tools
+- Added script `tools/generate-bedrock-data-from-packets.php`. This tool accepts a txt file containing base64-encoded packet dumps.
+  - This script has been used to generate data for [BedrockData](https://github.com/pmmp/BedrockData) for several years, but has only now been open-sourced.
+  - It's used to generate data such as crafting recipes, creative inventory data, and various other blobs of data needed to support the current version of Minecraft: Bedrock Edition.
+
+## Gameplay
+- Anvils now damage entities when they fall on top of them.
+
+## API
+### `pocketmine\block\utils`
+- The following API interface requirements have been added (BC breaking):
+  - `public Fallable->getFallDamagePerBlock() : float` (default implementation provided by `FallableTrait`)
+  - `public Fallable->getMaxFallDamage() : float` (default implementation provided by `FallableTrait`)
+
+### `pocketmine\data\bedrock\block`
+- The following new API methods have been added:
+  - `public BlockStateData->getVersionAsString() : string`
+
+#### `pocketmine\data\bedrock\block\upgrade\model`
+- `BlockStateUpgradeSchemaModelBlockRemap` now accepts `null` for `oldState` and `newState`. This makes it easier to generate portable schemas for other languages to read.
+
+### `pocketmine\event\entity`
+- The following new API constants have been added:
+  - `EntityDamageEvent::CAUSE_FALLING_BLOCK`
+  - `EntityDamageEvent::MODIFIER_ARMOR_HELMET`
+
+### `pocketmine\item`
+- The following API methods have signature changes:
+  - `ItemTypeIds::toBlockTypeId()` may now return `null` if the item type ID is not a block.
+
+### `pocketmine\player`
+- The following classes have been removed:
+  - `PlayerChunkLoader` - deprecated in 4.19.0 (this was technically internal, but never marked as such)
+
+## Internals
+- Make use of `Item->canStackWith()` instead of `Item->equals()` wherever possible, to make the code more readable.
+
+# 5.0.0-BETA3
+Released 17th May 2023.
+
+**This release includes changes from the following releases:**
+- [4.19.1](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA3/changelogs/4.19.md#4191)
+- [4.19.2](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA3/changelogs/4.19.md#4192)
+- [4.19.3](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA3/changelogs/4.19.md#4193)
+- [4.20.0](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA3/changelogs/4.20.md#4200)
+- [4.20.1](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA3/changelogs/4.20.md#4201)
+- [4.20.2](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA3/changelogs/4.20.md#4202)
+- [4.20.3](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA3/changelogs/4.20.md#4203)
+- [4.20.4](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA3/changelogs/4.20.md#4204)
+- [4.21.0](https://github.com/pmmp/PocketMine-MP/blob/5.0.0-BETA3/changelogs/4.21.md#4210)
+
+## General
+- Improved light propagation performance by 10-15%.
+
+## Fixes
+- Fixed late initialization of coral type in `BaseCoral`.
+
+## Tools
+- `tools/generate-blockstate-upgrade-schema.php` has the following improvements:
+  - Now generates better errors when inconsistent blockstate versions are encountered.
+  - Now generates more stable outputs when re-run on the same input.
+  - Output now uses `copiedState` in `remappedStates` where possible. This significantly reduces the size of the output for blocks with partially flattened states.
+
+## Gameplay
+- The following blocks have been added:
+  - Cave Vines
+- The following items have been added:
+  - Glow Berries
+  - Mangrove Boat (incomplete)
+- Fixed flower pots being able to be placed inside flower pots.
+
+## API
+### `pocketmine\block`
+- The following API methods have been renamed:
+  - `Block->isSameType()` -> `Block->hasSameTypeId()`
+  - `Block->describeType()` -> `Block->describeBlockItemState()`
+  - `Block->describeState()` -> `Block->describeBlockOnlyState()`
+- The following API methods have been removed:
+  - `Block->getRequiredTypeDataBits()`
+  - `Block->getRequiredStateDataBits()`
+- The following API methods have been added:
+  - `public Block->generateStatePermutations() : \Generator<int, Block, void, void>` - yields all possible states this block type can be in (used for `RuntimeBlockStateRegistry`)
+- The following API methods have signature changes:
+  - `Sapling::__construct()` now accepts `SaplingType $saplingType` instead of `TreeType $treeType`
+  - `RuntimeBlockStateRegistry->register()` no longer accepts an `$override` parameter.
+- The following classes have been added:
+  - `utils\SaplingType` - enum of all sapling types
+- `utils\TreeType` has been moved to `pocketmine\world\generator\object` namespace.
+
+### `pocketmine\data\bedrock\item\upgrade`
+- The following API methods have been added:
+  - `public ItemIdMetaUpgrader->getSchemas() : array<int, BlockStateUpgradeSchema>` - returns a list of loaded schemas indexed by schema ID
+  - `public ItemIdMetaUpgradeSchema->getRenamedIds() : array<string, string>` - returns a map of old ID -> new ID
+  - `public ItemIdMetaUpgradeSchema->getRemappedMetas() : array<string, array<int, string>>` - returns a map of old ID -> list of old meta -> new ID
+
+### `pocketmine\event\block`
+- The following API methods have been added:
+  - `public BlockGrowEvent->getPlayer() : ?Player` - returns the player that triggered the block growth, or `null` if it was not triggered by a player
+- The following API methods have signature changes:
+  - `BlockGrowEvent::__construct()` now accepts an optional `?Player $player` parameter.
+
+### `pocketmine\event\world`
+- The following classes have been added:
+  - `WorldDisplayNameChangeEvent` - called when a world's display name is changed
+
+### `pocketmine\item`
+- `Boat` now uses a new `BoatType` enum instead of `TreeType`. This is because not all tree types have an associated boat type, and some boat types are not made from tree materials (e.g. bamboo raft).
+  - The following API methods have been removed:
+    - `Boat->getWoodType()`
+  - The following API methods have been added:
+    - `public Boat->getType() : BoatType`
+    - `public Item->getStateId() : int` - returns an encoded ID containing the item type ID and encoded item state
+  - The following API methods have been renamed:
+    - `Item->describeType()` -> `Item->describeState()`
+  - The following classes have been added:
+    - `BoatType` - enum of all boat types
+  - The following API methods have signature changes:
+    - `BoatType::__construct()` now accepts `BoatType $boatType` instead of `TreeType $woodType`.
+
+### `pocketmine\world`
+- The following API methods have been added:
+  - `public World->setDisplayName(string $name) : void`
+
+### `pocketmine\world\format`
+- Fixed outdated documentation for various methods of `Chunk`.
+
+### `pocketmine\world\format\io\data`
+- The following API interface requirements have been added:
+  - `public WorldData->setDisplayName(string $value) : void`
+
+## Internals
+- Reduced global usage in world providers. In the future, we want to have blockstate deserializers etc. injected rather than being global singletons.
+- `BlockStateUpgrader` now always updates the blockstate version, even if no changes were made. PM itself doesn't require this, but it's useful for tools to know whether to upgrade the data again (e.g. in testing scenarios).
+- `BlockStateDictionary` memory usage is now reduced from 9 MB to 3.5 MB using various techniques, including string reuse and binary-encoded states.
+- `RuntimeBlockMapping` has been renamed to `BlockTranslator`.
+- Singletons in the `pocketmine\network\mcpe\convert` package have been centralized under `TypeConverter`. In the future, this will be injected where needed, allowing different converters to be used for different sessions (useful for multiversion).
+- Overriding of serializers and deserializers of items and blocks is now consistently disallowed. Due to the lack of a good reason to allow overriding built-in blocks and items, this is no longer allowed.
+
+# 5.0.0-BETA4
+Released 23rd May 2023.
+
+## General
+- [`ext-pmmpthread` version 6.0.0](https://github.com/pmmp/ext-pmmpthread/releases/6.0.0) (renamed from `ext-pthreads`) is now required. This version has API changes compared to pthreads v5. Please read the linked changelog for details.
+- [`pocketmine/snooze` version 0.5.0](https://github.com/pmmp/Snooze/releases/0.5.0) is now required.
+- `pocketmine/classloader` and `pocketmine/log-pthreads` packages have been removed. The relevant classes from these packages are now included in-house in the `pocketmine/thread` namespace.
+  - `BaseClassLoader` is replaced with `pocketmine\thread\ThreadSafeClassLoader`
+  - `ThreadedLogger` is replaced by `pocketmine\thread\ThreadSafeLogger`
+  - `AttachableThreadedLogger` is replaced by `pocketmine\thread\AttachableThreadSafeLogger`
+  - `ThreadedLoggerAttachment` is replaced by `pocketmine\thread\ThreadSafeLoggerAttachment`
+
+## Fixes
+- Fixed crash on unknown blocks due to late initialization of properties in `UnknownBlock`.
+
+## API changes
+### `pocketmine\scheduler`
+- `AsyncTask->setResult()` now works with thread-safe objects. This was previously not possible due to limitations in the `pthreads` extension.

changelogs/5.0.md

@@ -0,0 +1,791 @@
+# 5.0.0
+Released 1st June 2023.
+
+**For Minecraft: Bedrock Edition 1.19.80**
+
+5.0.0 is a major feature update to PocketMine-MP, including support for Bedrock worlds from 1.13 onwards, a large array of new blocks and items, and various changes to the plugin API.
+
+It is **not** compatible with plugins written for 4.x.y, and plugins may require code changes to work with it.
+
+**As this changelog is quite large, its accuracy and completeness cannot be guaranteed.**
+Make sure you're looking at the [latest revision](https://github.com/pmmp/PocketMine-MP/blob/stable/changelogs/5.0.md), as it may be amended after release.
+
+## Core
+- Worlds are now saved according to the Bedrock 1.19.80 format.
+- Worlds generated by Bedrock from 1.13.0 and up are now supported (previously, only worlds up to 1.12 were supported).
+- `/particle` now accepts strings for particle data instead of integers.
+- `/particle` no longer accepts integers for block or item IDs.
+- The usage of `blockcrack`, `iconcrack` and `blockdust` particle types in `/particle` now follows the same pattern as
+  other particle types, with the data for each being passed in the `data` parameter instead of being baked into the
+  particle name.
+- Commands are now enabled by default in worlds exported from PocketMine-MP to Bedrock.
+
+## Build system
+- `build/generate-block-serializer-consts.php` has been added to generate `BlockTypeNames`, `BlockStateNames` and `BlockStateStringValues` in the `pocketmine\data\bedrock\block` package.
+- `build/generate-item-type-names.php` has been added to generate `ItemTypeNames` in the `pocketmine\data\bedrock\item` package.
+- `build/generate-runtime-enum-serializers.php` has been added to generate `RuntimeEnumSerializer`, `RuntimeEnumSerializerTrait`, and `RuntimeEnumSizeCalculatorTrait` in `pocketmine\data\runtime` package.
+
+## Localization
+- Localized disconnect messages are now used in the following cases:
+  - Server full
+  - Player not on the server whitelist
+  - Player on the server ban list
+  - Invalid skin
+  - Invalid username
+  - Kicked using `/kick`
+  - Banned using `/ban`
+  - Failure to find a safe spawn position
+- Session open, session close and session player name discovery messages are now localized.
+- All permissions now have localized descriptions. These are not currently used by PocketMine-MP, but may be useful for plugins.
+
+## Performance
+- Improved performance of dropping block inventory contents when the block is destroyed.
+- Improved light propagation performance by 10-15%.
+- [`ext-pmmpthread` version 6.0.0](https://github.com/pmmp/ext-pmmpthread/releases/tag/6.0.0) is now used, featuring significant performance improvements for thread-safe objects and various threading use-cases.
+
+## Tools
+- The following tool scripts have been added:
+  - `generate-block-palette-spec.php` - generates a JSON file with a readable overview of blocks, their state
+    properties, and their possible values
+  - `generate-blockstate-upgrade-schema.php` - generates JSON blockstate upgrade schemas like those found
+    in [BedrockBlockUpgradeSchema](https://github.com/pmmp/BedrockBlockUpgradeSchema)
+  - `generate-item-upgrade-schema.php` - generates JSON item ID/meta upgrade schemas like those found
+    in [BedrockItemUpgradeSchema](https://github.com/pmmp/BedrockItemUpgradeSchema)
+  - `generate-bedrock-data-from-packets.php` - generates various files for [BedrockData](https://github.com/pmmp/BedrockData)
+    - This script accepts a txt file containing base64-encoded packet dumps.
+    - This script has been in use for several years, but has only now been open-sourced.
+    - It's used to generate data such as crafting recipes, creative inventory data, and various other blobs of data needed to support the current version of Minecraft: Bedrock Edition.
+
+## Gameplay
+### Blocks
+- Added the following new blocks:
+  - Amethyst Block
+  - Ancient Debris
+  - Azalea Leaves
+  - Basalt
+  - Blackstone blocks, slabs, stairs, and walls
+  - Cakes with Candle & Dyed Candle
+  - Calcite
+  - Candle & Dyed Candle
+  - Cartography Table (not currently usable due to maps not being implemented)
+  - Cauldron
+  - Cave Vines
+  - Chain
+  - Chiseled Deepslate
+  - Chiseled Nether Bricks
+  - Chiseled Polished Blackstone
+  - Chorus Flower
+  - Chorus Plant
+  - Cobbled Deepslate blocks, slabs, stairs, and walls
+  - Copper Ore
+  - Copper block (random oxidation not yet implemented)
+  - Crached Deepslate Tiles
+  - Cracked Deepslate Bricks
+  - Cracked Nether Bricks
+  - Cracked Polished Blackstone Bricks
+  - Crimson buttons, doors, fences, fence gates, hyphae, planks, pressure plates, signs, slabs, stairs, stems, and trapdoors
+  - Crying Obsidian
+  - Cut Copper block, stairs and slabs (random oxidation not yet implemented)
+  - Deepslate
+  - Deepslate Bricks blocks, slabs, stairs, and walls
+  - Deepslate Ores (coal, copper, diamond, emerald, gold, iron, lapis lazuli, redstone)
+  - Deepslate Tiles blocks, slabs, stairs, and walls
+  - Flowering Azalea Leaves
+  - Froglight (pearlescent, verdant, ochre)
+  - Gilded Blackstone
+  - Glow Item Frame
+  - Hanging Roots
+  - Honeycomb Block
+  - Light Block
+  - Lightning Rod
+  - Mangrove Leaves
+  - Mangrove Roots
+  - Mangrove buttons, doors, fences, fence gates, logs, planks, pressure plates, signs, slabs, stairs, trapdoors, and wood
+  - Mud Bricks blocks, slabs, stairs, and walls
+  - Muddy Mangrove Roots
+  - Nether Gold Ore
+  - Netherite Block
+  - Polished Basalt
+  - Polished Blackstone Bricks blocks, slabs, stairs, and walls
+  - Polished Blackstone blocks, buttons, pressure plates, slabs, stairs, and walls
+  - Polished Deepslate blocks, slabs, stairs, and walls
+  - Quartz Bricks
+  - Reinforced Deepslate
+  - Rooted Dirt
+  - Sculk
+  - Shroomlight
+  - Smithing Table
+  - Smooth Basalt
+  - Soul Fire
+  - Soul Lantern
+  - Soul Soil
+  - Soul Torch
+  - Spore Blossom
+  - Tinted Glass
+  - Tuff
+  - Twisting Vines
+  - Warped Wart Block
+  - Warped buttons, doors, fences, fence gates, hyphae, planks, pressure plates, signs, slabs, stairs, stems, and trapdoors
+  - Weeping Vines
+  - Wither Rose
+- Added support for basalt generators
+- Added support for dyeing sign text and making it glow.
+- All-sided logs ("wood", for want of a better name) can now be placed in X, Y, and Z orientations.
+- Coral and coral fans now behave correctly when placed out of water (they no longer immediately die).
+- Fixed dead bush being able to be placed on some invalid blocks (e.g. stone).
+- Fixed lava setting entities on fire for an incorrect duration (Java vs Bedrock inconsistency).
+- Fixed sugarcane not being able to be placed on some blocks.
+- Iron Ore and Gold Ore now drop Raw Iron and Raw Gold respectively, instead of the ore blocks.
+- Item frames can now be placed on the top and bottom of blocks.
+- Stripping logs by right-clicking them with an axe is now supported.
+- TNT can now be ignited by fire charges.
+- Vines can now only be placed on the side of full-cube blocks.
+- Walls now connect when placed, following the pre-1.16 logic. (1.16 logic is planned to be implemented, but currently low priority.)
+- Anvils are now damaged when they hit the ground after falling.
+- Added missing sounds for anvils hitting the ground after falling.
+- Anvils now damage entities when they fall on top of them.
+
+### Items
+- Added the following new items:
+  - Amethyst Shard
+  - Antidote (from Education Edition)
+  - Copper Ingot
+  - Disc Fragment (5)
+  - Echo Shard
+  - Elixir (from Education Edition)
+  - Eye Drops (from Education Edition)
+  - Fire Charge
+  - Glow Berries
+  - Glow Ink Sac
+  - Honey Bottle
+  - Honeycomb
+  - Mangrove Boat (incomplete)
+  - Music Disc (5)
+  - Music Disc (Otherside)
+  - Music Disc (Pigstep)
+  - Netherite Axe
+  - Netherite Boots
+  - Netherite Chestplate
+  - Netherite Helmet
+  - Netherite Ingot
+  - Netherite Leggings
+  - Netherite Pickaxe
+  - Netherite Scrap
+  - Netherite Shovel
+  - Netherite Sword
+  - Phantom Membrane
+  - Raw Copper
+  - Raw Gold
+  - Raw Iron
+  - Spyglass
+  - Suspicious Stew
+  - Tonic (from Education Edition)
+- Glass bottles can now be filled with water by clicking on a water source block.
+- Implemented Swift Sneak enchantment.
+- Armour durability is now only reduced when the wearer receives a type of damage that the armour can protect against.
+- Bells now ring when hit by a projectile.
+
+### Worlds
+- World height of -64 to 319 is now supported.
+- Added support for 3D biomes. This isn't used by PocketMine-MP yet, but is necessary to be able to fully load 1.18 worlds.
+
+## API
+### General
+- Union and mixed native parameter, return and property types are now used where appropriate.
+- Protected and public properties now use native property types wherever possible.
+- Parameter and return typehints have been applied in many places where it wasn't previously possible.
+
+### Dependencies
+- [`ext-pmmpthread` version 6.0.0](https://github.com/pmmp/ext-pmmpthread/releases/6.0.0) (renamed from `ext-pthreads`) is now required. This version features major API changes and improvements. Please read the [upgrading guide](https://github.com/pmmp/ext-pmmpthread/blob/fork/docs/UPGRADING_4.x_to_6.0.md) for details.
+- [`pocketmine/snooze` version 0.5.0](https://github.com/pmmp/Snooze/releases/0.5.0) is now required.
+- [`pocketmine/raklib` version 0.15.0](https://github.com/pmmp/RakLib/releases/0.15.0) is now required.
+- [`pocketmine/raklib-ipc` version 0.2.0](https://github.com/pmmp/RakLibIpc/releases/0.2.0) is now required.
+- `pocketmine/classloader` and `pocketmine/log-pthreads` packages have been removed. The relevant classes from these packages are now included in-house in the `pocketmine/thread` namespace.
+  - `BaseClassLoader` is replaced with `pocketmine\thread\ThreadSafeClassLoader`
+  - `ThreadedLogger` is replaced by `pocketmine\thread\ThreadSafeLogger`
+  - `AttachableThreadedLogger` is replaced by `pocketmine\thread\AttachableThreadSafeLogger`
+  - `ThreadedLoggerAttachment` is replaced by `pocketmine\thread\ThreadSafeLoggerAttachment`
+- `webmozart/path-util` has been removed (replaced by [`symfony/filesystem`](https://github.com/symfony/filesystem)).
+
+### `pocketmine\block`
+#### Highlights
+- Blocks no longer use internal Minecraft IDs and metadata to identify themselves. All APIs associated with legacy IDs
+  and meta have been removed.
+- A new set of runtime IDs generated from `VanillaBlocks` is used to identify block types. These IDs are defined
+  in `BlockTypeIds`.
+  - These new IDs are used for runtime representation of blocks on chunks, and for type comparison purposes.
+  - Block type IDs are used at **runtime only**. **Do not store them in configs or databases**, as they are subject to
+    change without warning.
+  - Block type IDs are **specific to PocketMine-MP** and have no relation to the IDs used by Minecraft.
+  - Block type IDs cannot be negative
+  - Block type IDs must not be reused, even if overriding an already defined block
+- Block state properties (e.g. facing, colour, etc.) are now represented by PM-specific state data instead of legacy
+  metadata. The state data consists of:
+  - Block-item state properties - retained by items when the block is broken (colour, wet/dry, coral type, etc.) - handled by `Block->describeBlockItemState()`
+  - Block-only state data - discarded when the block is broken (facing direction, lit/unlit, powered/unpowered, etc.) - handled by `Block->describeBlockOnlyState()`
+- Chunks now store dynamic state ID derived from the runtime type ID and runtime (PocketMine-MP defined) state data.
+- Introduced "type tags" concept, which allows marking certain blocks as having certain behaviours.
+  - The idea for this system was borrowed from the Minecraft Java tags system.
+  - It's still in very early concept stage, but is currently used for deciding which types of blocks plants can be placed on without needing to enumerate every single ID in every class, eliminating a bunch of boilerplate code and improving consistency.
+- All `Block` descendents now accept `BlockTypeInfo` in the constructor, instead of `BlockBreakInfo`. This allows for future additions without needing to change dozens of overridden constructors.
+- `&$returnedItems` reference parameter is now used in some places such as `Block->onInteract()` to enable actions to return items to players without caring about whether they are in creative or anything else.
+  - This eliminates boilerplate code of deciding whether to set the player's held item or not, as well as automatically dropping any overflow items that don't fit into the inventory.
+  - This is currently used when filling/emptying cauldrons using buckets or glass bottles.
+- Dependency between `RuntimeBlockStateRegistry` (previously `BlockFactory`) and `VanillaBlocks` has been inverted.
+  - Now, blocks types are defined in `VanillaBlocks`
+  - `RuntimeBlockStateRegistry` automatically registers states for blocks defined in `VanillaBlocks`.
+  - Manual registration in `RuntimeBlockStateRegistry` is still required for custom blocks (see section below about registering new blocks).
+- `RuntimeBlockStateRegistry` now has only one purpose - to map internal blockstate IDs to `Block` objects when reading blocks from chunks. It should not be used by plugins unless registering new blocks.
+  - To get a block at runtime, e.g. stone, use `VanillaBlocks::STONE()`
+  - To load a block from **old** config or database data:
+    1. Use `GlobalBlockStateHandlers::getUpgrader()->upgradeIntIdMeta()` to convert it to modern data
+    2. Pass the data to `GlobalBlockStateHandlers::getDeserializer()` to get a blockstate ID
+    3. Pass the blockstate ID to `RuntimeBlockStateRegistry::fromStateId()` to get a `Block` instance
+  - Prefer using `StringToItemParser` wherever possible for configs and databases (see `lookupAliases()` and `lookupBlockAliases()`).
+
+#### Registering new blocks
+##### In a plugin
+To add a vanilla block in a plugin which isn't yet supported by PocketMine-MP, do the following:
+
+1. Get a new type ID using `BlockTypeIds::newId()` - _you'll want to keep this in a property somewhere if you want to
+   compare using `getTypeId()` later_
+2. Set up the block type somewhere - _this can be anywhere you like, e.g. a plugin main class property, but using
+   a `RegistryTrait` class is recommended - you'll need this later to create new instances of the block_
+3. Register the block in `RuntimeBlockStateRegistry` - _this informs the server of all the block's possible states so
+   that it can be read from chunks at runtime_
+4. Register a deserializer for the block's Minecraft ID in `BlockStateToObjectDeserializer` - _needed for the block to
+   be recognized when loaded from disk_
+5. Register a serializer for the block in `BlockObjectToStateSerializer` - _needed for the block to be saved to disk,
+   and to be sent over the network_
+6. Optionally, register a string alias for the block in `StringToItemParser` - _so that it can be given via `/give`_
+
+To see a demo of how to do this in a plugin, see [this example plugin](https://github.com/pmmp/RegisterBlocksDemoPM5).
+
+Registering custom blocks follows a similar process, but requires additional steps to modify `BlockStateDictionary`
+which won't be covered here.
+Since this is not currently officially supported by PocketMine-MP, this won't be covered here.
+
+This is admittedly rather more of a hassle than in PM4, but this system offers significantly more flexibility than the
+old system.
+
+##### As a PocketMine-MP core contribution
+To register a new vanilla block into the core, the process is slightly different:
+
+1. Instead of using `BlockTypeIds::newId()`, add a new constant for the block to `BlockTypeIds`
+2. Register the new block in `VanillaBlocks` - `RuntimeBlockStateRegistry` will automagically take notice of all blocks
+   defined in `VanillaBlocks`
+3. Follow steps 4 onwards above
+
+#### Change list
+- The following classes have been removed:
+  - `BlockIdentifierFlattened`
+  - `BlockLegacyIdHelper`
+  - `BlockLegacyIds`
+  - `BlockLegacyMetadata`
+  - `utils\BlockDataSerializer`
+  - `utils\ColorInMetadataTrait` - `utils\ColoredTrait` now implements colour type data serialization uniformly
+  - `utils\InvalidBlockStateException` - this has been superseded by `pocketmine\data\runtime\InvalidSerializedRuntimeDataException`
+  - `utils\NormalHorizontalFacingInMetadataTrait` - `utils\HorizontalFacingTrait` now implements facing type data serialization uniformly
+  - `utils\PillarRotationInMetadataTrait` - `utils\PillarRotationTrait` now implements rotation type data serialization uniformly
+- The following classes have been renamed:
+  - `BlockFactory` -> `RuntimeBlockStateRegistry` - this class is now exclusively used for mapping state IDs to block instances for runtime chunk block reading
+  - `Skull` -> `MobHead`
+  - `utils\SkullType` -> `utils\MobHeadType`
+  - `utils\TreeType` -> `pocketmine\world\generator\object\TreeType`
+- The following classes have been added:
+  - `BaseCake`
+  - `BaseFire`
+  - `BlockTypeIds` - list of type IDs, one for each entry in `VanillaBlocks`
+  - `BlockTypeInfo`
+  - `BlockTypeTags`
+  - `CakeWithCandle`
+  - `CakeWithDyedCandle`
+  - `Candle`
+  - `CartographyTable`
+  - `Chain`
+  - `CopperOre`
+  - `CopperSlab`
+  - `CopperStairs`
+  - `Copper`
+  - `DyedCandle`
+  - `GildedBlackstone`
+  - `GoldOre`
+  - `HangingRoots`
+  - `IronOre`
+  - `Light`
+  - `LightningRod`
+  - `NetherGoldOre`
+  - `Sculk`
+  - `SmithingTable`
+  - `SoulFire`
+  - `WitherRose`
+  - `utils\CandleTrait`
+  - `utils\CopperOxidation`
+  - `utils\CopperTrait`
+  - `utils\SaplingType` - enum of all sapling types
+  - `utils\WallConnectionType` - enum of all possible wall connection types
+  - `utils\WoodTypeTrait`
+  - `utils\WoodType` - enum of all possible wood types, used for wood material blocks like planks and logs
+- The following API methods have been removed:
+  - `Block->getId()` - for type comparisons, use `Block->getTypeId()` instead
+  - `Block->getMeta()` - for state comparisons, use `Block->getStateId()` instead
+  - `Block->getStateBitmask()`
+  - `Block->readStateFromData()`
+  - `Block->writeStateToItemMeta()`
+  - `Block->writeStateToMeta()`
+  - `BlockFactory->get()` - see notes above about `RuntimeBlockStateRegistry`
+  - `BlockIdentifier->getAllBlockIds()`
+  - `BlockIdentifier->getBlockId()`
+  - `BlockIdentifier->getItemId()`
+  - `BlockIdentifier->getVariant()`
+  - `Door->isPowered()`
+  - `Door->setPowered()`
+  - `MobHead->isNoDrops()` (previously `Skull->isNoDrops()`)
+  - `MobHead->setNoDrops()` (previously `Skull->setNoDrops()`)
+  - `VanillaBlocks::*_GLAZED_TERRACOTTA()` - use `VanillaBlocks::GLAZED_TERRACOTTA()->setColor(DyeColor::WHATEVER())` instead
+  - `utils\FallableTrait->getId()` is no longer required
+  - `utils\FallableTrait->getMeta()` is no longer required
+  - `utils\MobHeadType->getMagicNumber()` (previously `utils\SkullType->getMagicNumber()`)
+  - `utils\MobHeadType::fromMagicNumber()` (previously `utils\SkullType::fromMagicNumber()`)
+- The following constants have been removed:
+  - `Block::INTERNAL_METADATA_BITS`
+  - `Block::INTERNAL_METADATA_MASK`
+- The following API methods have been renamed:
+  - `Block->getFullId()` -> `Block->getStateId()`
+  - `Block->isSameType()` -> `Block->hasSameTypeId()`
+  - `MobHead->getSkullType()` -> `MobHead->getMobHeadType()` (previously `Skull->getSkullType()`)
+  - `MobHead->setSkullType()` -> `MobHead->setMobHeadType()` (previously `Skull->setSkullType()`)
+- The following API methods have signature changes:
+  - `Block->onBreak()` now accepts `array<Item> &$returnedItems` reference parameter.
+  - `Block->onInteract()` now accepts `array<Item> &$returnedItems` reference parameter.
+  - `Block->readStateFromWorld()` now returns `Block` - this allows blocks to replace themselves with a different block entirely based on world conditions.
+  - `BlockIdentifier->__construct()` now accepts `int $blockTypeId`, and no longer accepts `int $blockId, int $variant, ?int $itemId`
+  - `ItemFrame->getFacing()` may now return `Facing::UP` and `Facing::DOWN`
+  - `ItemFrame->setFacing()` now accepts `Facing::UP` and `Facing::DOWN`
+  - `Leaves->__construct()` now accepts `LeavesType $leavesType` instead of `TreeType $treeType`
+  - `RuntimeBlockStateRegistry->register()` no longer accepts an `$override` parameter.
+  - `Sapling::__construct()` now accepts `SaplingType $saplingType` instead of `TreeType $treeType`
+  - `utils\SignText::__construct()` now accepts two new optional parameters: `?Color $baseColor` and `bool $glowing`
+  - `utils\SignText::fromBlob()` now accepts two new optional parameters: `?Color $baseColor` and `bool $glowing`
+- The following API methods have been added:
+  - `protected Block->describeBlockOnlyState(RuntimeDataDescriber $w) : void` - describes state properties which are discarded when the block is broken or block-picked, such as facing, powered, etc.
+  - `public Block->describeBlockItemState(RuntimeDataDescriber $w) : void` - describes state properties which are kept by the item when the block is broken or block-picked, such as dye color
+  - `public Block->generateStatePermutations() : \Generator<int, Block, void, void>` - yields all possible states this block type can be in (used for `RuntimeBlockStateRegistry`)
+  - `public Block->getTypeTags() : array<string>`
+  - `public Block->hasTypeTag(string $tag) : bool`
+  - `public Block->isFireProofAsItem() : bool`
+  - `public Block->onProjectileHit(Projectile $projectile, RayTraceResult $hitResult) : void`
+  - `public BlockIdentifier->getBlockTypeId() : int` - returns the block's type ID according to `BlockTypeIds`
+  - `public Furnace->getFurnaceType() : utils\FurnaceType`
+  - `public GlazedTerracotta->getColor() : utils\DyeColor` (from `ColoredTrait`) - this was previously unsupported due to legacy limitations
+  - `public GlazedTerracotta->setColor(utils\DyeColor $color) : $this` (from `ColoredTrait`) - this was previously unsupported due to legacy limitations
+  - `public Leaves->getLeavesType() : utils\LeavesType` - returns the type of leaves
+  - `public Wall->getConnection(int $face) : utils\WallConnectionType`
+  - `public Wall->getConnections() : array<int, utils\WallConnectionType>` - returns the wall's connections and their types (see `utils\WallConnectionType`)
+  - `public Wall->isPost() : bool`
+  - `public Wall->setConnection(int $face, ?utils\WallConnectionType $type) : $this`
+  - `public Wall->setConnections()` - sets the wall's connections and their types (see `utils\WallConnectionType`)
+  - `public Wall->setPost(bool $post) : $this`
+  - `public Wood->isStripped() : bool`
+  - `public Wood->setStripped(bool $stripped) : $this`
+  - `public static BlockBreakInfo::axe(float $hardness, ?ToolTier $toolTier = null, ?float $blastResistance = null) : BlockBreakInfo`
+  - `public static BlockBreakInfo::pickaxe(float $hardness, ?ToolTier $toolTier = null, ?float $blastResistance = null) : BlockBreakInfo`
+  - `public static BlockBreakInfo::shovel(float $hardness, ?ToolTier $toolTier = null, ?float $blastResistance = null) : BlockBreakInfo`
+  - `public static BlockBreakInfo::tier(float $hardness, int $toolType, ToolTier $toolTier, ?float $blastResistance = null) : BlockBreakInfo`
+  - `public tile\Spawnable->getRenderUpdateBugWorkaroundStateProperties(Block $block) : array<string, Tag>` - allows spawnable tiles to spoof block state properties to work around client-side rendering bugs without actually changing the block server-side
+  - `public utils\SignText->getBaseColor() : \pocketmine\color\Color`
+  - `public utils\SignText->isGlowing() : bool`
+- The following classes now use new traits, adding API methods and/or properties:
+  - `FenceGate` uses `utils\WoodTypeTrait`
+  - `GlazedTerracotta` uses `utils\ColoredTrait`
+  - `Planks` uses `utils\WoodTypeTrait`
+  - `Wood` uses `utils\WoodTypeTrait`
+  - `WoodenButton` uses `utils\WoodTypeTrait`
+  - `WoodenDoor` uses `utils\WoodTypeTrait`
+  - `WoodenFence` uses `utils\WoodTypeTrait`
+  - `WoodenPressurePlate` uses `utils\WoodTypeTrait`
+  - `WoodenSlab` uses `utils\WoodTypeTrait`
+  - `WoodenStairs` uses `utils\WoodTypeTrait`
+  - `WoodenTrapdoor` uses `utils\WoodTypeTrait`
+- The following API interface requirements have been added (BC breaking):
+  - `public utils\Fallable->getFallDamagePerBlock() : float` (default implementation provided by `utils\FallableTrait`)
+  - `public utils\Fallable->getLandSound() : ?Sound` (default implementation provided by `utils\FallableTrait`)
+  - `public utils\Fallable->getMaxFallDamage() : float` (default implementation provided by `utils\FallableTrait`)
+  - `public utils\Fallable->onHitGround(FallingBlock $blockEntity) : bool` (default implementation provided by `utils\FallableTrait`)
+
+### `pocketmine\command`
+- Command permissions are now always checked by the server when running a command.
+  - This only affects commands implemented by extending `Command`. Plugins using `PluginBase->onCommand()` are not affected by this change, since they already had permissions checked by the server anyway.
+  - Previously, direct inheritors of `Command` were responsible for checking permissions, which required developers to duplicate the same code in every command, and opened lots of potential for security vulnerabilities.
+  - If you want to do something on permission denied (e.g. sending a special message, or audit logging), you can do so by overriding `Command->testPermission()`, instead of baking the code directly into `Command->execute()`.
+  - If you don't want to use permissions at all, just create a permission with a default of `true` (or belonging to `pocketmine.group.user`) and assign that.
+- `SimpleCommandMap` now requires all commands to have a permission set when registered.
+  - If you actually want to allow everyone to use your command (not advised), you can add a new permission to the `pocketmine.group.user` group, or use `default: true` for `plugin.yml` permissions.
+- The following API methods have changed behaviour:
+  - `Command->testPermissionSilent()` now returns `false` if there are no permissions associated with the command. This is to prevent commands with no permissions being usable by everyone, which has previously been a source of security issues.
+- The following API methods have been added:
+  - `public Command->getPermissions() : list<string>` - returns a list of permissions which grant usage access to this command. A user with one or more of these permissions will be able to invoke the command's `execute()` method
+  - `public Command->setPermissions(list<string> $permissions) : void` - sets the permissions which grant usage access to this command. This should be used instead of `setPermission()` with `;` separators (which is now deprecated)
+
+### `pocketmine\crafting`
+- JSON models have been updated to reflect updated crafting data format.
+- The following enum classes have new members:
+  - `ShapelessRecipeType` has new members `CARTOGRAPHY` and `SMITHING`
+- The following classes have been added:
+  - `ExactRecipeIngredient` - matches an exact item
+  - `MetaWildcardRecipeIngredient` - matches an item with the given legacy Minecraft ID, but any metadata value
+  - `RecipeIngredient` interface
+  - `TagWildcardRecipeIngredient` - matches an item based on its Minecraft tags, e.g. `minecraft:wooden_tier`
+- The following API methods have signature changes:
+  - `FurnaceRecipe->__construct()` now accepts `RecipeIngredient` instead of `Item`
+  - `FurnaceRecipe->getInput()` now returns `RecipeIngredient` instead of `Item`
+  - `PotionContainerChangeRecipe->__construct()` now accepts `string, RecipeIngredient, string` (using Minecraft string IDs instead of legacy integers).
+  - `PotionContainerChangeRecipe->getIngredient()` now returns `RecipeIngredient` instead of `Item`.
+  - `PotionContainerChangeRecipe->getInputItemId()` now returns `string` (using Minecraft string IDs instead of legacy integers).
+  - `PotionContainerChangeRecipe->getOutputItemId()` now returns `string` (using Minecraft string IDs instead of legacy integers).
+  - `PotionTypeRecipe->__construct()` now accepts `RecipeIngredient` instead of `Item`
+  - `PotionTypeRecipe->getIngredient()` now returns `RecipeIngredient` instead of `Item`
+  - `PotionTypeRecipe->getInput()` now returns `RecipeIngredient` instead of `Item`
+  - `ShapedRecipe->__construct()` now accepts `RecipeIngredient` instead of `Item`
+  - `ShapedRecipe->getIngredient()` now returns `?RecipeIngredient` instead of `?Item`
+  - `ShapedRecipe->getIngredientList()` now returns `RecipeIngredient[]` instead of `Item[]`
+  - `ShapedRecipe->getIngredientMap()` now returns `RecipeIngredient[][]` instead of `Item[][]`
+  - `ShapelessRecipe->__construct()` `$type` parameter is now mandatory.
+  - `ShapelessRecipe->__construct()` now accepts `RecipeIngredient` instead of `Item`
+  - `ShapelessRecipe->getIngredientList()` now returns `RecipeIngredient[]` instead of `Item[]`
+
+### `pocketmine\data`
+- New packages `bedrock\block` and `bedrock\item` have been added. These packages contain all the necessary code for loading and saving Bedrock blocks and items from disk.
+- New package `runtime` has been added. This package contains code for serializing runtime data for blocks and items.
+- `LegacyToStringBidirectionalIdMap` has been reduced to `LegacyToStringIdMap`.
+  - Since we never map from string ID to legacy ID, bidirectional mapping is no longer necessary.
+  - This affects the following subclasses:
+    - `LegacyBiomeIdToStringIdMap`
+    - `LegacyBlockIdToStringIdMap`
+    - `LegacyEntityIdToStringIdMap`
+    - `LegacyItemIdToStringIdMap`
+- The following internal API methods have been added:
+  - `public LegacyToStringIdMap->add(string $string, int $legacy) : void` - adds a mapping from a custom legacy ID to custom string ID, needed for upgrading old saved data
+
+### `pocketmine\entity`
+- `Entity` now declares new abstract methods which must be implemented by subclasses:
+  - `public Entity->getInitialDragMultiplier() : float`
+  - `public Entity->getInitialGravity() : float`
+- The following new API methods have been added:
+  - `public Living->getDisplayName() : string`
+- The following API methods have changed signatures:
+  - `EntityFactory->register()` no longer accepts a `$legacyMcpeSaveId` parameter (now handled by internal conversions instead).
+- The following API methods have been renamed:
+  - `Entity->isImmobile()` -> `Entity->hasNoClientPredictions()`
+  - `Entity->setImmobile()` -> `Entity->setNoClientPredictions()`
+- The following internal fields have been renamed:
+  - `Entity->immobile` -> `Entity->noClientPredictions`
+- The following classes have been removed:
+  - `EntityLegacyIds`
+
+### `pocketmine\event`
+- The following classes have inheritance changes:
+  - `block\BlockPlaceEvent` no longer extends `BlockEvent`, and therefore no longer has `getBlock()`. Use `getTransaction()` instead (may contain multiple blocks).
+- `BlockFormEvent` now includes information about the block which caused the event.
+
+- The following new classes have been added:
+  - `world\WorldDisplayNameChangeEvent` - called when a world's display name is changed
+- The following classes have been renamed:
+  - `entity\ExplosionPrimeEvent` -> `entity\EntityPreExplodeEvent`
+- The following API methods have been added:
+  - `public block\BlockFormEvent->getCausingBlock() : Block`
+  - `public block\BlockGrowEvent->getPlayer() : ?Player` - returns the player that triggered the block growth, or `null` if it was not triggered by a player
+  - `public block\BlockPlaceEvent->getTransaction() : BlockTransaction` - returns the transaction containing a list of changed block positions and the blockstates they will be changed to
+  - `public server\DataPacketSendEvent->setPackets(list<ClientboundPacket> $packets) : void`
+- The following API methods have changed signatures:
+  - `block\BlockPlaceEvent->__construct()` now accepts `BlockTransaction $transaction` instead of `Block $blockPlace, Block $blockReplace`
+  - `entity\EntityPreExplodeEvent->__construct()` has the `$force` parameter renamed to `$radius`
+  - `entity\EntityPreExplodeEvent->getForce() : float` -> `entity\EntityPreExplodeEvent->getRadius() : float`
+  - `entity\EntityPreExplodeEvent->setForce(float $force) : void` -> `entity\EntityPreExplodeEvent->setRadius(float $radius) : void`
+- The following API methods have been removed:
+  - `block\BlockPlaceEvent->getBlockReplaced()` - this information is now provided in the `BlockTransaction` object returned by `BlockPlaceEvent->getTransaction()`
+- The following new API constants have been added:
+  - `entity\EntityDamageEvent::CAUSE_FALLING_BLOCK`
+  - `entity\EntityDamageEvent::MODIFIER_ARMOR_HELMET`
+
+### `pocketmine\event\player`
+- `PlayerPreLoginEvent`, `PlayerDuplicateLoginEvent` and `PlayerKickEvent` now supports setting separate log reasons (disconnect reason) and disconnect screen messages.
+- The following classes have been removed:
+  - `PlayerCommandPreprocessEvent`
+- The following API methods have changed signatures:
+  - `PlayerDuplicateLoginEvent->getDisconnectMessage()` now returns `Translatable|string` instead of `string`
+  - `PlayerDuplicateLoginEvent->setDisconnectMessage()` now accepts `Translatable|string` instead of `string`
+  - `PlayerKickEvent->getReason()` now returns `Translatable|string` instead of `string`
+  - `PlayerKickEvent->setReason()` now accepts `Translatable|string` instead of `string`
+  - `PlayerLoginEvent->getKickMessage()` now returns `Translatable|string` instead of `string`
+  - `PlayerLoginEvent->setKickMessage()` now accepts `Translatable|string` instead of `string`
+  - `PlayerPreLoginEvent->getFinalKickMessage()` now returns `Translatable|string` instead of `string`
+  - `PlayerPreLoginEvent->getKickMessage()` now returns `Translatable|string|null` instead of `string|null`
+  - `PlayerPreLoginEvent->setKickFlag()` (previously `setKickReason()`) now accepts `Translatable|string $disconnectReason, Translatable|string|null $disconnectScreenMessage = null` instead of `Translatable|string $message`
+  - `PlayerPreLoginEvent->setKickReason()` now accepts `Translatable|string` for the `$message` parameter instead of `string`
+  - `PlayerQuitEvent->getQuitReason()` now returns `Translatable|string` instead of `string`
+- The following API methods have been removed:
+  - `PlayerChatEvent->getFormat()` (use `PlayerChatEvent->getChatFormatter()` instead)
+  - `PlayerChatEvent->setFormat()` (use `PlayerChatEvent->setChatFormatter()` instead)
+  - `PlayerDuplicateLoginEvent->getDisconnectMessage()` - replaced by `getDisconnectReason()` and `getDisconnectScreenMessage()`
+  - `PlayerDuplicateLoginEvent->setDisconnectMessage()` - replaced by `setDisconnectReason()` and `setDisconnectScreenMessage()`
+  - `PlayerKickEvent->getReason()` - replaced by `getDisconnectReason()` and `getDisconnectScreenMessage()`
+  - `PlayerKickEvent->setReason()` - replaced by `setDisconnectReason()` and `setDisconnectScreenMessage()`
+- The following new API methods have been added:
+  - `public PlayerChatEvent->getChatFormatter() : \pocketmine\player\chat\ChatFormatter` - returns the chat formatter to be used for this event
+  - `public PlayerChatEvent->setChatFormatter(\pocketmine\player\chat\ChatFormatter $formatter) : void` - sets the chat formatter to be used for this event
+  - `public PlayerDeathEvent->getDeathScreenMessage() : Translatable|string` - returns the message to be displayed on the death screen
+  - `public PlayerDeathEvent->setDeathScreenMessage(Translatable|string $deathScreenMessage) : void` - sets the message to be displayed on the death screen
+  - `public PlayerDuplicateLoginEvent->getDisconnectReason() : Translatable|string` - returns the reason for the disconnection displayed in the console and server log
+  - `public PlayerDuplicateLoginEvent->getDisconnectScreenMessage() : Translatable|string|null` - returns the message to be displayed on the disconnect screen (the message in `getDisconnectReason()` is used if null is returned)
+  - `public PlayerDuplicateLoginEvent->setDisconnectReason(Translatable|string $disconnectReason) : void` - sets the reason for the disconnection displayed in the console and server log
+  - `public PlayerDuplicateLoginEvent->setDisconnectScreenMessage(Translatable|string|null $disconnectScreenMessage) : void` - sets the message to be displayed on the disconnect screen (the message in `setDisconnectReason()` is used if null is passed)
+  - `public PlayerKickEvent->getDisconnectReason() : Translatable|string` - returns the reason for the disconnection displayed in the console and server log
+  - `public PlayerKickEvent->getDisconnectScreenMessage() : Translatable|string|null` - returns the message to be displayed on the disconnect screen (the message in `getDisconnectReason()` is used if null is returned)
+  - `public PlayerKickEvent->setDisconnectReason(Translatable|string $disconnectReason) : void` - sets the reason for the disconnection displayed in the console and server log
+  - `public PlayerKickEvent->setDisconnectScreenMessage(Translatable|string|null $disconnectScreenMessage) : void` - sets the message to be displayed on the disconnect screen (the message in `setDisconnectReason()` is used if null is passed)
+  - `public PlayerPreLoginEvent->getDisconnectScreenMessage(int $flag) : Translatable|string|null` - returns the message to be displayed on the disconnect screen for the specified kick flag, if set
+  - `public PlayerPreLoginEvent->getFinalDisconnectScreenMessage() : Translatable|string|null` - returns the message to be displayed on the disconnect screen, taking into account the kick flags set
+- The following classes have inheritance changes:
+  - `PlayerPreLoginEvent` no longer implements `Cancellable`. This caused unexpected behaviour for most plugin devs due to default-ignoring cancelled events, forcing people to usually have to use `@handleCancelled` to handle the event when they wanted to use it.
+- The following API constants have been renamed:
+  - `PlayerPreLoginEvent::KICK_REASON_BANNED` -> `PlayerPreLoginEvent::KICK_FLAG_BANNED`
+  - `PlayerPreLoginEvent::KICK_REASON_PLUGIN` -> `PlayerPreLoginEvent::KICK_FLAG_PLUGIN`
+  - `PlayerPreLoginEvent::KICK_REASON_PRIORITY` -> `PlayerPreLoginEvent::KICK_FLAG_PRIORITY`
+  - `PlayerPreLoginEvent::KICK_REASON_SERVER_FULL` -> `PlayerPreLoginEvent::KICK_FLAG_SERVER_FULL`
+  - `PlayerPreLoginEvent::KICK_REASON_SERVER_WHITELISTED` -> `PlayerPreLoginEvent::KICK_FLAG_SERVER_WHITELISTED`
+- The following API methods have been renamed:
+  - `PlayerPreLoginEvent->clearAllKickReasons()` -> `PlayerPreLoginEvent->clearAllKickFlags()`
+  - `PlayerPreLoginEvent->clearKickReason()` -> `PlayerPreLoginEvent->clearKickFlag()`
+  - `PlayerPreLoginEvent->getFinalKickMessage()` -> `PlayerPreLoginEvent->getFinalDisconnectReason()` (now used for logs only, if a disconnect screen message is set for the highest priority flag)
+  - `PlayerPreLoginEvent->getKickMessage()` -> `PlayerPreLoginEvent->getDisconnectReason()` (now used for logs only, if a disconnect screen message is set for the flag)
+  - `PlayerPreLoginEvent->getKickReasons()` -> `PlayerPreLoginEvent->getKickFlags()`
+  - `PlayerPreLoginEvent->isKickReasonSet()` -> `PlayerPreLoginEvent->isKickFlagSet()`
+  - `PlayerPreLoginEvent->setKickReason()` -> `PlayerPreLoginEvent->setKickFlag()`
+
+### `pocketmine\item`
+#### Highlights
+- `ItemFactory` has been removed. Vanilla item registration is now done via `VanillaItems`.
+  - To get an item at runtime, e.g. iron ingot, use `VanillaItems::IRON_INGOT()`
+  - To get a block as an item, e.g. stone, use `VanillaBlocks::STONE()->asItem()`
+  - To load an item from legacy ID and meta:
+    1. Use `GlobalItemDataHandlers::getUpgrader()->upgradeItemTypeDataInt()` to convert the legacy ID and meta to `SavedItemStackData`
+    2. Pass the itemstack data to `GlobalItemDataHandlers::getDeserializer()` to get an `Item` instance
+- Items no longer use internal Minecraft string IDs and metadata to identify themselves. All APIs associated with legacy
+  IDs and/or meta have been removed.
+- A new set of runtime item IDs generated from `VanillaItems` is now used to identify item types. These IDs are defined
+  in `ItemTypeIds`.
+  - These new IDs are primarily intended for type comparison purposes.
+  - Item type IDs are used at **runtime only**. They should **NOT** be stored in configs or databases, as they are not
+    guaranteed to remain the same between versions.
+- In some cases, items may have additional "type data" which provides extra type information about an item. This
+  replaces item metadata in some cases.
+  - Type data may be used to store dynamic type information such as dye colour, potion type, etc.
+  - Items must have the same type ID **and** type data in order to be stackable.
+- Blocks, when represented as items:
+  - retain their block type data, but not state data (for example, different colours of concrete don't stack, but things
+    like facing don't affect stackability)
+  - use the negative of their block type ID (e.g. a block with type ID `1` will have an item type ID of `-1`).
+- Durable items (e.g. tools, armour) now use NBT `Damage` tag to store durability (like Minecraft 1.13+), instead of
+  legacy meta values.
+- `&$returnedItems` reference parameter is now used in some places (e.g. `onInteractBlock()`) to enable actions to return items to players without caring about whether they are in creative or anything else.
+  - This eliminates boilerplate code of deciding whether to set the player's held item or not, as well as automatically dropping any overflow items that don't fit into the inventory.
+  - This is used for things like filling/emptying buckets and bottles, and equipping armor.
+- Blocks which previously had separate items, such as mob heads and beds, no longer do. Their item form can be acquired using `Block->asItem()` in the same way as every other block. This is facilitated by the new serializer system.
+
+#### Implementing new items
+##### In a plugin
+This follows a similar process to registering blocks.
+
+1. Get a new type ID using `ItemTypeIds::newId()` - _you'll want to keep this in a property somewhere if you want to
+   compare using `getTypeId()` later_
+2. Set up the item type somewhere - _this can be anywhere you like, e.g. a plugin main class property, but using
+   a `RegistryTrait` class is recommended - you'll need this later to create new instances of the item_
+3. Register a deserializer in `ItemDeserializer` - _needed for the item to be recognized when loaded from disk_
+4. Register a serializer in `ItemSerializer` - _needed for the item to be saved to disk, and to be sent over the
+   network_
+5. Optionally, register a string alias for the item in `StringToItemParser` - _so that it can be given via `/give`_
+
+To see a demo of how to do this in a plugin, see [this example plugin](https://github.com/pmmp/RegisterBlocksDemoPM5).
+
+Again, it's acknowledged this is rather more cumbersome than it should be, but this is an ongoing process.
+
+##### As a PocketMine-MP core contribution
+
+To register a new vanilla item into the core, the process is slightly different:
+
+1. Instead of using `ItemTypeIds::newId()`, add a new constant for the block to `ItemTypeIds`
+2. Register the new item in `VanillaItems`
+3. Follow steps 3 onwards from the plugin instructions above
+
+#### Change list
+- `Item` is no longer `json_encode()`-able.
+  - The original purpose of this was to allow items to be serialized to JSON for crafting data generated from `CraftingDataPacket`. Due to changes in the generation methodology, bypassing `Item`s entirely, this is no longer necessary.
+  - In addition, `jsonSerialize()` required the item to know about the method by which it will be serialized (since there is no way to inject context), creating a cyclic dependency between the `Item` implementation and its serialization method.
+  - It's relatively easy to write a replacement method to encode items to JSON as you desire.
+  - `Item::legacyJsonDeserialize()` (previously `Item::jsonDeserialize()`) is retained to allow loading legacy data, although it may be removed in the future.
+- The following classes have been removed:
+  - `Bed`
+  - `ItemFactory`
+  - `ItemIds`
+  - `Skull`
+- The following classes have been added:
+  - `BoatType` - enum of all boat types
+  - `CoralFan`
+  - `HoneyBottle`
+  - `MedicineType`
+  - `Medicine`
+  - `Spyglass`
+  - `SuspiciousStewType`
+  - `SuspiciousStew`
+- The following API methods have been added:
+  - `protected Item->describeState(RuntimeDataDescriber $w) : void` 
+  - `public Armor->clearCustomColor() : $this` - clears the custom color of an armor item
+  - `public ArmorTypeInfo->getToughness() : int`
+  - `public ArmorTypeInfo->isFireProof() : bool`
+  - `public Boat->getType() : BoatType`
+  - `public Dye->setColor(\pocketmine\block\utils\DyeColor $color) : $this`
+  - `public Item->getStateId() : int` - returns a runtime numeric state ID for comparisons including information such as coral type, dye color, etc. - DO NOT save this to disk or databases
+  - `public Item->getTypeId() : int` - returns a runtime numeric type ID for comparisons - DO NOT save this to disk or databases
+  - `public Item->isFireProof() : bool`
+  - `public ItemIdentifer->getTypeId() : int`
+  - `public Potion->setType(PotionType $type) : $this`
+  - `public SplashPotion->setType(PotionType $type) : $this`
+  - `public StringToItemParser->lookupAliases(Item $item) : list<string>` - returns a list of all registered aliases for the given item
+  - `public StringToItemParser->lookupBlockAliases(Block $block) : list<string>` - returns a list of all registered aliases for the given block
+  - `public static ItemIdentifier::fromBlock(Block $block) : self`
+- The following API methods have been removed:
+  - `Boat->getWoodType()`
+  - `Item->getId()` - for type comparisons, use `Item->getTypeId()` instead
+  - `Item->getMeta()` - use the item's specific API methods to compare information such as colour, potion type etc.
+  - `Item->hasAnyDamageValue()` - for meta wildcard recipe ingredients, use `pocketmine\crafting\MetaWildcardRecipeIngredient` instead
+  - `ItemIdentifier->getId()`
+  - `ItemIdentifier->getMeta()`
+- The following API methods have been renamed:
+  - `Item::jsonDeserialize()` -> `Item::legacyJsonDeserialize()`
+- The following API methods have signature changes:
+  - `ArmorTypeInfo->__construct()` now accepts optional parameters `int $toughness` and `bool $fireProof`
+  - `BoatType::__construct()` now accepts `BoatType $boatType` instead of `TreeType $woodType`.
+  - `Item->onAttackEntity()` now accepts `array<Item> &$returnedItems` reference parameter.
+  - `Item->onClickAir()` now accepts `array<Item> &$returnedItems` reference parameter.
+  - `Item->onDestroyBlock()` now accepts `array<Item> &$returnedItems` reference parameter.
+  - `Item->onInteractBlock()` now accepts `array<Item> &$returnedItems` reference parameter.
+  - `Item->onReleaseUsing()` now accepts `array<Item> &$returnedItems` reference parameter.
+  - `ItemIdentifier->__construct()` no longer accepts a `$variant` parameter, and now expects an item type ID for the ID parameter
+  - `LegacyStringToItemParser->addMapping()` now accepts a string for ID, instead of an integer
+- The following API methods have behaviour changes:
+  - `Item->equals()`'s `$checkDamage` parameter is now ignored, as tool damage is now stored as an NBT tag. This parameter wasn't removed due to being followed by a second `bool` parameter, which would potentially end up in the wrong place and silently cause bugs in updated plugins.
+  - `Item->equals()`'s `$checkTags` parameter will now cause tool and armor damage to be checked if true.
+- The following enums have new members:
+  - `ToolTier` has new member `NETHERITE`
+
+### `pocketmine\network`
+- The following API methods have changed signatures:
+  - `NetworkSessionManager->close()` now accepts an additional `Translatable|string|null $disconnectScreenMessage` parameter.
+- The following API methods have changed signatures:
+  - `query\QueryInfo->getPlayerList()` now returns `list<string>` instead of `list<Player>`
+  - `query\QueryInfo->setPlayerList()` now accepts `list<string>` instead of `list<Player>`
+
+### `pocketmine\player`
+- The following API methods have changed signatures:
+  - `Player->disconnect()` now accepts `Translatable|string` for `$reason` instead of `string` (to allow localized disconnect messages)
+  - `Player->disconnect()` now accepts an additional `Translatable|string|null $disconnectScreenMessage` parameter, which is the message to be displayed on the disconnect screen (the message in `$reason` is used if null is passed)
+  - `Player->kick()` now accepts `Translatable|string` for `$reason` instead of `string` (to allow localized kick messages)
+  - `Player->kick()` now accepts an additional `Translatable|string|null $disconnectScreenMessage` parameter, which is the message to be displayed on the disconnect screen (the message in `$reason` is used if null is passed)
+  - `Player->sendJukeboxPopup()` now accepts `Translatable|string` instead of `string, string[]`
+- The following classes have been removed:
+  - `PlayerChunkLoader` - deprecated in 4.19.0 (this was technically internal, but never marked as such)
+
+### `pocketmine\player\chat`
+- The following new classes have been added:
+  - `ChatFormatter` - interface implemented by chat formatters - this is far more powerful than the old API
+  - `LegacyRawChatFormatter` - implements the same behaviour previously used by `PlayerChatEvent->setFormat()`
+  - `StandardChatFormatter` - formats chat messages in the vanilla Minecraft style
+
+### `pocketmine\scheduler`
+- `AsyncTask->setResult()` now works with thread-safe objects. This was previously not possible due to limitations in the `pthreads` extension.
+
+### `pocketmine\world`
+- The following API methods have been added:
+  - `public World->setDisplayName(string $name) : void`
+- The following API methods have changed signatures:
+  - `Explosion->__construct()` has the `$size` parameter renamed to `$radius`
+- The following public properties have been renamed:
+  - `Explosion->size` -> `Explosion->radius`
+
+### `pocketmine\world\format`
+- Chunks are now considered dirty (modified) by default, unless loaded from a `WorldProvider` by `World`. Previously, chunks were considered unmodified by default, which allowed several pathways to bugs.
+- The following classes have been added:
+  - `io\GlobalBlockStateHandlers` - gives access to block data serializer, deserializer, and upgraders
+  - `io\GlobalItemDataHandlers` - gives access to item data serializer, deserializer, and upgraders
+  - `io\LoadedChunkData` - represents a chunk loaded from disk, along with information such as whether the chunk was upgraded and what fixes it requires
+- The following new API methods have been added:
+  - `public SubChunk->getBiomeArray() : PalettedBlockArray`
+- The following classes have been removed:
+  - `BiomeArray` - `PalettedBlockArray` is now used for 3D biome data
+- The following API methods have changed signatures:
+  - `Chunk->getBiomeId()` now accepts `int $x, int $y, int $z` instead of `int $x, int $z`
+  - `Chunk->setBiomeId()` now accepts `int $x, int $y, int $z` instead of `int $x, int $z`
+  - `Chunk->__construct()` no longer accepts `BiomeArray` as a parameter (contained in each subchunk instead)
+  - `SubChunk->__construct()` now accepts `int $emptyBlockId, list<PalettedBlockArray> $blockLayers, PalettedBlockArray $biomes, ?LightArray $blockLight, ?LightArray $skyLight` instead of `int, list<PalettedBlockArray>, ?LightArray, ?LightArray`
+  - `io\WorldProvider->loadChunk()` now returns `LoadedChunkData` instead of `ChunkData`
+  - `io\WorldProvider->getAllChunks()` now yields `LoadedChunkData` instead of `ChunkData`
+  - `io\ChunkData->__construct()` now accepts `array<int, SubChunk>, bool $populated` instead of `Chunk $chunk`
+- The following API methods have been renamed:
+  - `Chunk->getFullBlock()` -> `Chunk->getBlockStateId()`
+  - `Chunk->setFullBlock()` -> `Chunk->setBlockStateId()`
+  - `SubChunk->getFullBlock()` -> `SubChunk->getBlockStateId()`
+  - `SubChunk->setFullBlock()` -> `SubChunk->setBlockStateId()`
+- The following API interface requirements have been added:
+  - `public io\data\WorldData->setDisplayName(string $value) : void`
+
+### `pocketmine\world\generator\object`
+- The following API methods have been removed:
+  - `TreeType::fromMagicNumber()`
+  - `TreeType->getMagicNumber()`
+
+### `pocketmine\world\sound`
+- The following classes have been added:
+  - `CopperWaxApplySound`
+  - `CopperWaxRemoveSound`
+  - `DyeUseSound`
+  - `InkSacUseSound`
+- The following enums have new members:
+  - `NoteInstrument` has new members `BELL`, `FLUTE`, `CHIME`, `XYLOPHONE`, `IRON_XYLOPHONE`, `COW_BELL`, `DIDGERIDOO`, `BIT`, `BANJO`, `PLING`
+- The following API methods have been removed:
+  - `NoteInstrument::fromMagicNumber()`
+  - `NoteInstrument->getMagicNumber()`
+
+## Internals
+- All external usages of `KnownTranslationKeys` are now removed. All localized messages are now sent using `Translatable` objects (usually from `KnownTranslationFactory`).
+- All usages of NBT keys now use class constants instead of hardcoded strings (except for an occasional overlooked one).
+- Built-in commands now declare their names inside the class constructor, rather than accepting them as parameters. This improves code consistency.
+- Commands now use an array for permissions internally, instead of a string separated by `;`.
+- Make use of `Item->canStackWith()` instead of `Item->equals()` wherever possible, to make the code more readable.
+- Moved command timings to `Timings`.
+- Overriding of serializers and deserializers of items and blocks is now consistently disallowed. Since overriding stuff is non-cooperative, it doesn't make any sense in plugins, which must coexist with other plugins. If you want to modify the functionality of built-in stuff, you have several alternative options:
+    - Use existing API (e.g. events, API methods) - most uses of overrides in PM4 and earlier were abuses that could have been done with events
+    - Submit feature proposals or pull requests for new API to be added (e.g. new events)
+    - Register completely custom items, and reuse behaviour from the item you want to mimic
+    - Fork PocketMine-MP and alter the code directly - this way your plugins aren't pretending to be cooperative with other plugins
+- `level.dat`, block, item, entity, tile and chunk data are now tagged with a version ID as per `VersionInfo::WORLD_DATA_VERSION`. This allows the server to apply fixes to older worlds if necessary.
+- Protocol creative inventory entries are now cached in `CreativeInventoryCache` to improve performance of initial join and game mode changes.
+- Singletons in the `pocketmine\network\mcpe\convert` package have been centralized under `TypeConverter`. In the future, this will be injected where needed, allowing different converters to be used for different sessions (useful for multiversion).
+- `BlockStateDictionary` memory usage is now reduced from 9 MB to 3.5 MB using various techniques, including string reuse and binary-encoded states.
+- `NetworkSession` disconnect APIs now accept `Translatable|string` instead of `string` to allow localized disconnect messages.
+- `NetworkSession` disconnect methods have been altered to allow specifying a different disconnect reason and disconnection screen message.
+- `RuntimeBlockMapping` has been renamed to `BlockTranslator`.
+
+# 5.0.1
+Released 3rd June 2023.
+
+## Changes
+- [`ext-pmmpthread` version 6.0.1](https://github.com/pmmp/ext-pmmpthread/releases/tag/6.0.1) is now required (for bug fixes).
+
+## Fixes
+- Fixed server crash when breaking blocks placed in the same session (mishandled default block states).
+- Fixed spore blossoms not dropping when broken.
+- Fixed jukebox music not stopping when destroyed by an explosion.
+
+## Documentation
+- Added documentation for `BlockSpreadEvent->__construct()` parameters.

changelogs/5.1.md

@@ -0,0 +1,22 @@
+# 5.1.0
+Released 7th June 2023.
+
+**For Minecraft: Bedrock Edition 1.20.0**
+
+This is a support release for Minecraft: Bedrock Edition 1.20.0.
+
+**Plugin compatibility:** Plugins for previous 5.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## General
+- Added support for Minecraft: Bedrock Edition 1.20.0.
+- Removed support for older versions.
+
+# 5.1.1
+Released 7th June 2023.
+
+## Fixes
+- Fixed blockstates being saved with the wrong version ID for 1.20.0.

composer.json

@@ -5,7 +5,7 @@
    "homepage": "https://pmmp.io",
    "license": "LGPL-3.0",
    "require": {
-      "php": "^8.0",
+      "php": "^8.1",
       "php-64bit": "*",
       "ext-chunkutils2": "^0.3.1",
       "ext-crypto": "^0.3.1",
@@ -22,7 +22,7 @@
       "ext-openssl": "*",
       "ext-pcre": "*",
       "ext-phar": "*",
-      "ext-pthreads": "^4.0",
+      "ext-pmmpthread": "^6.0.1",
       "ext-reflection": "*",
       "ext-simplexml": "*",
       "ext-sockets": "*",
@@ -33,32 +33,30 @@
       "composer-runtime-api": "^2.0",
       "adhocore/json-comment": "^1.1",
       "fgrosse/phpasn1": "^2.3",
-      "netresearch/jsonmapper": "^4.0",
-      "pocketmine/bedrock-block-upgrade-schema": "dev-master@dev",
-      "pocketmine/bedrock-data": "dev-modern-world-support@dev",
-      "pocketmine/bedrock-item-upgrade-schema": "dev-master",
-      "pocketmine/bedrock-protocol": "~13.0.0+bedrock-1.19.30",
+      "pocketmine/netresearch-jsonmapper": "~v4.2.999",
+      "pocketmine/bedrock-block-upgrade-schema": "~2.2.0+bedrock-1.20.0",
+      "pocketmine/bedrock-data": "~2.3.0+bedrock-1.20.0",
+      "pocketmine/bedrock-item-upgrade-schema": "~1.3.0+bedrock-1.20.0",
+      "pocketmine/bedrock-protocol": "~22.0.0+bedrock-1.20.0",
       "pocketmine/binaryutils": "^0.2.1",
       "pocketmine/callback-validator": "^1.0.2",
-      "pocketmine/classloader": "^0.2.0",
-      "pocketmine/color": "^0.2.0",
+      "pocketmine/color": "^0.3.0",
       "pocketmine/errorhandler": "^0.6.0",
-      "pocketmine/locale-data": "~2.8.0 <2.8.9",
+      "pocketmine/locale-data": "~2.19.0",
       "pocketmine/log": "^0.4.0",
-      "pocketmine/log-pthreads": "^0.4.0",
       "pocketmine/math": "^0.4.0",
       "pocketmine/nbt": "^0.3.2",
-      "pocketmine/raklib": "^0.14.2",
-      "pocketmine/raklib-ipc": "^0.1.0",
-      "pocketmine/snooze": "^0.3.0",
+      "pocketmine/raklib": "^0.15.0",
+      "pocketmine/raklib-ipc": "^0.2.0",
+      "pocketmine/snooze": "^0.5.0",
       "ramsey/uuid": "^4.1",
-      "webmozart/path-util": "^2.3"
+      "symfony/filesystem": "^6.2"
    },
    "require-dev": {
-      "phpstan/phpstan": "1.8.5",
+      "phpstan/phpstan": "1.10.16",
       "phpstan/phpstan-phpunit": "^1.1.0",
       "phpstan/phpstan-strict-rules": "^1.2.0",
-      "phpunit/phpunit": "^9.2"
+      "phpunit/phpunit": "^10.1"
    },
    "autoload": {
       "psr-4": {
@@ -76,7 +74,7 @@
    },
    "config": {
       "platform": {
-         "php": "8.0.0"
+         "php": "8.1.0"
       },
       "sort-packages": true
    },

phpstan.neon.dist

@@ -1,11 +1,9 @@
 includes:
 	- tests/phpstan/analyse-for-current-php-version.neon.php
 	- tests/phpstan/configs/actual-problems.neon
-	- tests/phpstan/configs/gc-hacks.neon
 	- tests/phpstan/configs/impossible-generics.neon
 	- tests/phpstan/configs/php-bugs.neon
 	- tests/phpstan/configs/phpstan-bugs.neon
-	- tests/phpstan/configs/runtime-type-checks.neon
 	- tests/phpstan/configs/spl-fixed-array-sucks.neon
 	- vendor/phpstan/phpstan-phpunit/extension.neon
 	- vendor/phpstan/phpstan-phpunit/rules.neon
@@ -46,7 +44,7 @@ parameters:
 		- tests/phpstan/stubs/JsonMapper.stub
 		- tests/phpstan/stubs/leveldb.stub
 		- tests/phpstan/stubs/phpasn1.stub
-		- tests/phpstan/stubs/pthreads.stub
+		- tests/phpstan/stubs/pmmpthread.stub
 	reportUnmatchedIgnoredErrors: false #no other way to silence platform-specific non-warnings
 	staticReflectionClassNamePatterns:
 		- "#^COM$#"

resources/pocketmine.yml

@@ -85,8 +85,11 @@ network:
   batch-threshold: 256
   #Compression level used when sending batched packets. Higher = more CPU, less bandwidth usage
   compression-level: 6
-  #Use AsyncTasks for compression. Adds half/one tick delay, less CPU load on main thread
+  #Use AsyncTasks for compression during the main game session. Increases latency, but may reduce main thread load
   async-compression: false
+  #Threshold for async compression, in bytes. Only packets larger than this will be compressed asynchronously
+  #Due to large overhead of AsyncTask, async compression isn't worth it except for large packets
+  async-compression-threshold: 10000
   #Experimental. Use UPnP to automatically port forward
   upnp-forwarding: false
   #Maximum size in bytes of packets sent over the network (default 1492 bytes). Packets larger than this will be
@@ -119,8 +122,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

resources/resource_packs.yml

@@ -10,3 +10,4 @@ resource_stack:
   # - natural.zip
   # - vanilla.zip
   #If you want to force clients to use vanilla resources, you must place a vanilla resource pack in your resources folder and add it to the stack here.
+  #To specify a resource encryption key, put the key in the <resource>.key file alongside the resource pack. Example: vanilla.zip.key

src/MemoryManager.php

@@ -30,7 +30,7 @@ use pocketmine\scheduler\GarbageCollectionTask;
 use pocketmine\timings\Timings;
 use pocketmine\utils\Process;
 use pocketmine\utils\Utils;
-use Webmozart\PathUtil\Path;
+use Symfony\Component\Filesystem\Path;
 use function arsort;
 use function count;
 use function fclose;
@@ -49,6 +49,7 @@ use function ini_get;
 use function ini_set;
 use function intdiv;
 use function is_array;
+use function is_float;
 use function is_object;
 use function is_resource;
 use function is_string;
@@ -69,6 +70,10 @@ use const JSON_UNESCAPED_SLASHES;
 use const SORT_NUMERIC;
 
 class MemoryManager{
+	private const DEFAULT_CHECK_RATE = Server::TARGET_TICKS_PER_SECOND;
+	private const DEFAULT_CONTINUOUS_TRIGGER_RATE = Server::TARGET_TICKS_PER_SECOND * 2;
+	private const DEFAULT_TICKS_PER_GC = 30 * 60 * Server::TARGET_TICKS_PER_SECOND;
+
 	private int $memoryLimit;
 	private int $globalMemoryLimit;
 	private int $checkRate;
@@ -113,20 +118,12 @@ class MemoryManager{
 			if($m <= 0){
 				$defaultMemory = 0;
 			}else{
-				switch(mb_strtoupper($matches[2])){
-					case "K":
-						$defaultMemory = intdiv($m, 1024);
-						break;
-					case "M":
-						$defaultMemory = $m;
-						break;
-					case "G":
-						$defaultMemory = $m * 1024;
-						break;
-					default:
-						$defaultMemory = $m;
-						break;
-				}
+				$defaultMemory = match(mb_strtoupper($matches[2])){
+					"K" => intdiv($m, 1024),
+					"M" => $m,
+					"G" => $m * 1024,
+					default => $m,
+				};
 			}
 		}
 
@@ -139,11 +136,11 @@ class MemoryManager{
 		}
 
 		$this->globalMemoryLimit = $config->getPropertyInt("memory.global-limit", 0) * 1024 * 1024;
-		$this->checkRate = $config->getPropertyInt("memory.check-rate", 20);
+		$this->checkRate = $config->getPropertyInt("memory.check-rate", self::DEFAULT_CHECK_RATE);
 		$this->continuousTrigger = $config->getPropertyBool("memory.continuous-trigger", true);
-		$this->continuousTriggerRate = $config->getPropertyInt("memory.continuous-trigger-rate", 30);
+		$this->continuousTriggerRate = $config->getPropertyInt("memory.continuous-trigger-rate", self::DEFAULT_CONTINUOUS_TRIGGER_RATE);
 
-		$this->garbageCollectionPeriod = $config->getPropertyInt("memory.garbage-collection.period", 36000);
+		$this->garbageCollectionPeriod = $config->getPropertyInt("memory.garbage-collection.period", self::DEFAULT_TICKS_PER_GC);
 		$this->garbageCollectionTrigger = $config->getPropertyBool("memory.garbage-collection.low-memory-trigger", true);
 		$this->garbageCollectionAsync = $config->getPropertyBool("memory.garbage-collection.collect-async-worker", true);
 
@@ -285,10 +282,8 @@ class MemoryManager{
 
 	/**
 	 * Static memory dumper accessible from any thread.
-	 *
-	 * @param mixed   $startingObject
 	 */
-	public static function dumpMemory($startingObject, string $outputFolder, int $maxNesting, int $maxStringSize, \Logger $logger) : void{
+	public static function dumpMemory(mixed $startingObject, string $outputFolder, int $maxNesting, int $maxStringSize, \Logger $logger) : void{
 		$hardLimit = Utils::assumeNotFalse(ini_get('memory_limit'), "memory_limit INI directive should always exist");
 		ini_set('memory_limit', '-1');
 		gc_disable();
@@ -319,9 +314,6 @@ class MemoryManager{
 					continue;
 				}
 
-				if(!$property->isPublic()){
-					$property->setAccessible(true);
-				}
 				if(!$property->isInitialized()){
 					continue;
 				}
@@ -398,7 +390,7 @@ class MemoryManager{
 
 		do{
 			$continue = false;
-			foreach($objects as $hash => $object){
+			foreach(Utils::stringifyKeys($objects) as $hash => $object){
 				if(!is_object($object)){
 					continue;
 				}
@@ -445,9 +437,6 @@ class MemoryManager{
 									continue;
 								}
 							}
-							if(!$property->isPublic()){
-								$property->setAccessible(true);
-							}
 							if(!$property->isInitialized($object)){
 								continue;
 							}
@@ -479,13 +468,15 @@ class MemoryManager{
 	}
 
 	/**
-	 * @param mixed    $from
-	 * @param object[] $objects reference parameter
+	 * @param object[] $objects   reference parameter
 	 * @param int[]    $refCounts reference parameter
 	 *
-	 * @return mixed
+	 * @phpstan-param array<string, object> $objects
+	 * @phpstan-param array<string, int> $refCounts
+	 * @phpstan-param-out array<string, object> $objects
+	 * @phpstan-param-out array<string, int> $refCounts
 	 */
-	private static function continueDump($from, array &$objects, array &$refCounts, int $recursion, int $maxNesting, int $maxStringSize){
+	private static function continueDump(mixed $from, array &$objects, array &$refCounts, int $recursion, int $maxNesting, int $maxStringSize) : mixed{
 		if($maxNesting <= 0){
 			return "(error) NESTING LIMIT REACHED";
 		}
@@ -518,6 +509,8 @@ class MemoryManager{
 			$data = "(string) len(" . strlen($from) . ") " . substr(Utils::printable($from), 0, $maxStringSize);
 		}elseif(is_resource($from)){
 			$data = "(resource) " . print_r($from, true);
+		}elseif(is_float($from)){
+			$data = "(float) $from";
 		}else{
 			$data = $from;
 		}

src/PocketMine.php

@@ -26,6 +26,7 @@ namespace pocketmine {
 	use Composer\InstalledVersions;
 	use pocketmine\errorhandler\ErrorToExceptionHandler;
 	use pocketmine\thread\ThreadManager;
+	use pocketmine\thread\ThreadSafeClassLoader;
 	use pocketmine\utils\Filesystem;
 	use pocketmine\utils\MainLogger;
 	use pocketmine\utils\Process;
@@ -34,20 +35,23 @@ namespace pocketmine {
 	use pocketmine\utils\Timezone;
 	use pocketmine\utils\Utils;
 	use pocketmine\wizard\SetupWizard;
-	use Webmozart\PathUtil\Path;
+	use Symfony\Component\Filesystem\Path;
 	use function defined;
 	use function extension_loaded;
 	use function function_exists;
 	use function getcwd;
+	use function is_dir;
+	use function mkdir;
 	use function phpversion;
 	use function preg_match;
 	use function preg_quote;
 	use function realpath;
 	use function version_compare;
+	use const DIRECTORY_SEPARATOR;
 
 	require_once __DIR__ . '/VersionInfo.php';
 
-	const MIN_PHP_VERSION = "8.0.0";
+	const MIN_PHP_VERSION = "8.1.0";
 
 	/**
 	 * @param string $message
@@ -100,7 +104,7 @@ namespace pocketmine {
 			"openssl" => "OpenSSL",
 			"pcre" => "PCRE",
 			"phar" => "Phar",
-			"pthreads" => "pthreads",
+			"pmmpthread" => "pmmpthread",
 			"reflection" => "Reflection",
 			"sockets" => "Sockets",
 			"spl" => "SPL",
@@ -115,12 +119,9 @@ namespace pocketmine {
 			}
 		}
 
-		if(($pthreads_version = phpversion("pthreads")) !== false){
-			if(substr_count($pthreads_version, ".") < 2){
-				$pthreads_version = "0.$pthreads_version";
-			}
-			if(version_compare($pthreads_version, "4.0.0") < 0 || version_compare($pthreads_version, "5.0.0") > 0){
-				$messages[] = "pthreads ^4.0.0 is required, while you have $pthreads_version.";
+		if(($pmmpthread_version = phpversion("pmmpthread")) !== false){
+			if(version_compare($pmmpthread_version, "6.0.1") < 0 || version_compare($pmmpthread_version, "7.0.0") >= 0){
+				$messages[] = "pmmpthread ^6.0.1 is required, while you have $pmmpthread_version.";
 			}
 		}
 
@@ -201,6 +202,22 @@ JIT_WARNING
 		ini_set('assert.exception', '1');
 	}
 
+	function getopt_string(string $opt) : ?string{
+		$opts = getopt("", ["$opt:"]);
+		if(isset($opts[$opt])){
+			if(is_string($opts[$opt])){
+				return $opts[$opt];
+			}
+			if(is_array($opts[$opt])){
+				critical_error("Cannot specify --$opt multiple times");
+			}else{
+				critical_error("Missing value for --$opt");
+			}
+			exit(1);
+		}
+		return null;
+	}
+
 	/**
 	 * @return void
 	 */
@@ -246,33 +263,45 @@ JIT_WARNING
 				exit(1);
 			}
 		}
-		if(extension_loaded('parallel')){
-			\parallel\bootstrap(\pocketmine\COMPOSER_AUTOLOADER_PATH);
-		}
 
 		ErrorToExceptionHandler::set();
 
-		$opts = getopt("", ["data:", "plugins:", "no-wizard", "enable-ansi", "disable-ansi"]);
-
 		$cwd = Utils::assumeNotFalse(realpath(Utils::assumeNotFalse(getcwd())));
-		$dataPath = isset($opts["data"]) ? $opts["data"] . DIRECTORY_SEPARATOR : $cwd . DIRECTORY_SEPARATOR;
-		$pluginPath = isset($opts["plugins"]) ? $opts["plugins"] . DIRECTORY_SEPARATOR : $cwd . DIRECTORY_SEPARATOR . "plugins" . DIRECTORY_SEPARATOR;
+		$dataPath = getopt_string("data") ?? $cwd;
+		$pluginPath = getopt_string("plugins") ?? $cwd . DIRECTORY_SEPARATOR . "plugins";
 		Filesystem::addCleanedPath($pluginPath, Filesystem::CLEAN_PATH_PLUGINS_PREFIX);
 
-		if(!file_exists($dataPath)){
-			mkdir($dataPath, 0777, true);
+		if(!@mkdir($dataPath, 0777, true) && !is_dir($dataPath)){
+			critical_error("Unable to create/access data directory at $dataPath. Check that the target location is accessible by the current user.");
+			exit(1);
 		}
+		//this has to be done after we're sure the data path exists
+		$dataPath = realpath($dataPath) . DIRECTORY_SEPARATOR;
 
 		$lockFilePath = Path::join($dataPath, 'server.lock');
-		if(($pid = Filesystem::createLockFile($lockFilePath)) !== null){
+		try{
+			$pid = Filesystem::createLockFile($lockFilePath);
+		}catch(\InvalidArgumentException $e){
+			critical_error($e->getMessage());
+			critical_error("Please ensure that there is enough space on the disk and that the current user has read/write permissions to the selected data directory $dataPath.");
+			exit(1);
+		}
+		if($pid !== null){
 			critical_error("Another " . VersionInfo::NAME . " instance (PID $pid) is already using this folder (" . realpath($dataPath) . ").");
 			critical_error("Please stop the other server first before running a new one.");
 			exit(1);
 		}
 
+		if(!@mkdir($pluginPath, 0777, true) && !is_dir($pluginPath)){
+			critical_error("Unable to create plugin directory at $pluginPath. Check that the target location is accessible by the current user.");
+			exit(1);
+		}
+		$pluginPath = realpath($pluginPath) . DIRECTORY_SEPARATOR;
+
 		//Logger has a dependency on timezone
 		Timezone::init();
 
+		$opts = getopt("", ["no-wizard", "enable-ansi", "disable-ansi"]);
 		if(isset($opts["enable-ansi"])){
 			Terminal::init(true);
 		}elseif(isset($opts["disable-ansi"])){
@@ -299,7 +328,7 @@ JIT_WARNING
 			/*
 			 * We now use the Composer autoloader, but this autoloader is still for loading plugins.
 			 */
-			$autoloader = new \BaseClassLoader();
+			$autoloader = new ThreadSafeClassLoader();
 			$autoloader->register(false);
 
 			new Server($autoloader, $logger, $dataPath, $pluginPath);
@@ -307,7 +336,7 @@ JIT_WARNING
 			$logger->info("Stopping other threads");
 
 			$killer = new ServerKiller(8);
-			$killer->start(PTHREADS_INHERIT_NONE);
+			$killer->start();
 			usleep(10000); //Fixes ServerKiller not being able to start on single-core machines
 
 			if(ThreadManager::getInstance()->stopAll() > 0){

src/Server.php

@@ -43,27 +43,26 @@ use pocketmine\event\player\PlayerCreationEvent;
 use pocketmine\event\player\PlayerDataSaveEvent;
 use pocketmine\event\player\PlayerLoginEvent;
 use pocketmine\event\server\CommandEvent;
-use pocketmine\event\server\DataPacketSendEvent;
 use pocketmine\event\server\QueryRegenerateEvent;
 use pocketmine\lang\KnownTranslationFactory;
 use pocketmine\lang\Language;
 use pocketmine\lang\LanguageNotFoundException;
 use pocketmine\lang\Translatable;
-use pocketmine\nbt\BigEndianNbtSerializer;
-use pocketmine\nbt\NbtDataException;
 use pocketmine\nbt\tag\CompoundTag;
-use pocketmine\nbt\TreeRoot;
 use pocketmine\network\mcpe\compression\CompressBatchPromise;
 use pocketmine\network\mcpe\compression\CompressBatchTask;
 use pocketmine\network\mcpe\compression\Compressor;
 use pocketmine\network\mcpe\compression\ZlibCompressor;
+use pocketmine\network\mcpe\convert\TypeConverter;
 use pocketmine\network\mcpe\encryption\EncryptionContext;
+use pocketmine\network\mcpe\EntityEventBroadcaster;
 use pocketmine\network\mcpe\NetworkSession;
 use pocketmine\network\mcpe\PacketBroadcaster;
-use pocketmine\network\mcpe\protocol\ClientboundPacket;
 use pocketmine\network\mcpe\protocol\ProtocolInfo;
-use pocketmine\network\mcpe\protocol\serializer\PacketBatch;
+use pocketmine\network\mcpe\protocol\serializer\PacketSerializerContext;
 use pocketmine\network\mcpe\raklib\RakLibInterface;
+use pocketmine\network\mcpe\StandardEntityEventBroadcaster;
+use pocketmine\network\mcpe\StandardPacketBroadcaster;
 use pocketmine\network\Network;
 use pocketmine\network\NetworkInterfaceStartException;
 use pocketmine\network\query\DedicatedQueryNetworkInterface;
@@ -72,9 +71,13 @@ use pocketmine\network\query\QueryInfo;
 use pocketmine\network\upnp\UPnPNetworkInterface;
 use pocketmine\permission\BanList;
 use pocketmine\permission\DefaultPermissions;
+use pocketmine\player\DatFilePlayerDataProvider;
 use pocketmine\player\GameMode;
 use pocketmine\player\OfflinePlayer;
 use pocketmine\player\Player;
+use pocketmine\player\PlayerDataLoadException;
+use pocketmine\player\PlayerDataProvider;
+use pocketmine\player\PlayerDataSaveException;
 use pocketmine\player\PlayerInfo;
 use pocketmine\plugin\PharPluginLoader;
 use pocketmine\plugin\Plugin;
@@ -89,10 +92,13 @@ use pocketmine\resourcepacks\ResourcePackManager;
 use pocketmine\scheduler\AsyncPool;
 use pocketmine\snooze\SleeperHandler;
 use pocketmine\stats\SendUsageTask;
+use pocketmine\thread\log\AttachableThreadSafeLogger;
+use pocketmine\thread\ThreadSafeClassLoader;
 use pocketmine\timings\Timings;
 use pocketmine\timings\TimingsHandler;
 use pocketmine\updater\UpdateChecker;
 use pocketmine\utils\AssumptionFailedError;
+use pocketmine\utils\BroadcastLoggerForwarder;
 use pocketmine\utils\Config;
 use pocketmine\utils\Filesystem;
 use pocketmine\utils\Internet;
@@ -104,17 +110,18 @@ use pocketmine\utils\SignalHandler;
 use pocketmine\utils\Terminal;
 use pocketmine\utils\TextFormat;
 use pocketmine\utils\Utils;
-use pocketmine\world\format\Chunk;
 use pocketmine\world\format\io\WorldProviderManager;
 use pocketmine\world\format\io\WritableWorldProviderManagerEntry;
 use pocketmine\world\generator\Generator;
 use pocketmine\world\generator\GeneratorManager;
 use pocketmine\world\generator\InvalidGeneratorOptionsException;
+use pocketmine\world\Position;
 use pocketmine\world\World;
 use pocketmine\world\WorldCreationOptions;
 use pocketmine\world\WorldManager;
 use Ramsey\Uuid\UuidInterface;
-use Webmozart\PathUtil\Path;
+use Symfony\Component\Filesystem\Path;
+use function array_fill;
 use function array_sum;
 use function base64_encode;
 use function cli_set_process_title;
@@ -123,7 +130,6 @@ use function count;
 use function date;
 use function fclose;
 use function file_exists;
-use function file_get_contents;
 use function file_put_contents;
 use function filemtime;
 use function fopen;
@@ -160,12 +166,9 @@ use function time;
 use function touch;
 use function trim;
 use function yaml_parse;
-use function zlib_decode;
-use function zlib_encode;
 use const DIRECTORY_SEPARATOR;
 use const PHP_EOL;
 use const PHP_INT_MAX;
-use const ZLIB_ENCODING_GZIP;
 
 /**
  * The class that manages everything
@@ -183,9 +186,32 @@ class Server{
 	public const DEFAULT_PORT_IPV6 = 19133;
 	public const DEFAULT_MAX_VIEW_DISTANCE = 16;
 
+	/**
+	 * Worlds, network, commands and most other things are polled this many times per second on average.
+	 * Between ticks, the server will sleep to ensure that the average tick rate is maintained.
+	 * It may wake up between ticks if a Snooze notification source is triggered (e.g. to process network packets).
+	 */
+	public const TARGET_TICKS_PER_SECOND = 20;
+	/**
+	 * The average time between ticks, in seconds.
+	 */
+	public const TARGET_SECONDS_PER_TICK = 1 / self::TARGET_TICKS_PER_SECOND;
+	public const TARGET_NANOSECONDS_PER_TICK = 1_000_000_000 / self::TARGET_TICKS_PER_SECOND;
+
+	/**
+	 * The TPS threshold below which the server will generate log warnings.
+	 */
+	private const TPS_OVERLOAD_WARNING_THRESHOLD = self::TARGET_TICKS_PER_SECOND * 0.6;
+
+	private const TICKS_PER_WORLD_CACHE_CLEAR = 5 * self::TARGET_TICKS_PER_SECOND;
+	private const TICKS_PER_TPS_OVERLOAD_WARNING = 5 * self::TARGET_TICKS_PER_SECOND;
+	private const TICKS_PER_STATS_REPORT = 300 * self::TARGET_TICKS_PER_SECOND;
+
+	private const DEFAULT_ASYNC_COMPRESSION_THRESHOLD = 10_000;
+
 	private static ?Server $instance = null;
 
-	private SleeperHandler $tickSleeper;
+	private TimeTrackingSleeperHandler $tickSleeper;
 
 	private BanList $banByName;
 
@@ -201,7 +227,7 @@ class Server{
 
 	private PluginManager $pluginManager;
 
-	private float $profilingTickRate = 20;
+	private float $profilingTickRate = self::TARGET_TICKS_PER_SECOND;
 
 	private UpdateChecker $updater;
 
@@ -211,10 +237,10 @@ class Server{
 	private int $tickCounter = 0;
 	private float $nextTick = 0;
 	/** @var float[] */
-	private array $tickAverage = [20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20, 20];
+	private array $tickAverage;
 	/** @var float[] */
-	private array $useAverage = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
-	private float $currentTPS = 20;
+	private array $useAverage;
+	private float $currentTPS = self::TARGET_TICKS_PER_SECOND;
 	private float $currentUse = 0;
 	private float $startTime;
 
@@ -241,6 +267,7 @@ class Server{
 
 	private Network $network;
 	private bool $networkCompressionAsync = true;
+	private int $networkCompressionAsyncThreshold = self::DEFAULT_ASYNC_COMPRESSION_THRESHOLD;
 
 	private Language $language;
 	private bool $forceLanguage = false;
@@ -250,6 +277,8 @@ class Server{
 	private string $dataPath;
 	private string $pluginPath;
 
+	private PlayerDataProvider $playerDataProvider;
+
 	/**
 	 * @var string[]
 	 * @phpstan-var array<string, string>
@@ -386,11 +415,11 @@ class Server{
 		return $this->configGroup->getConfigString("motd", self::DEFAULT_SERVER_NAME);
 	}
 
-	public function getLoader() : \DynamicClassLoader{
+	public function getLoader() : ThreadSafeClassLoader{
 		return $this->autoloader;
 	}
 
-	public function getLogger() : \AttachableThreadedLogger{
+	public function getLogger() : AttachableThreadSafeLogger{
 		return $this->logger;
 	}
 
@@ -469,10 +498,7 @@ class Server{
 		return $this->configGroup->getPropertyBool("player.save-player-data", true);
 	}
 
-	/**
-	 * @return OfflinePlayer|Player
-	 */
-	public function getOfflinePlayer(string $name){
+	public function getOfflinePlayer(string $name) : Player|OfflinePlayer|null{
 		$name = strtolower($name);
 		$result = $this->getPlayerExact($name);
 
@@ -483,49 +509,22 @@ class Server{
 		return $result;
 	}
 
-	private function getPlayerDataPath(string $username) : string{
-		return Path::join($this->getDataPath(), 'players', strtolower($username) . '.dat');
-	}
-
 	/**
 	 * Returns whether the server has stored any saved data for this player.
 	 */
 	public function hasOfflinePlayerData(string $name) : bool{
-		return file_exists($this->getPlayerDataPath($name));
-	}
-
-	private function handleCorruptedPlayerData(string $name) : void{
-		$path = $this->getPlayerDataPath($name);
-		rename($path, $path . '.bak');
-		$this->logger->error($this->getLanguage()->translate(KnownTranslationFactory::pocketmine_data_playerCorrupted($name)));
+		return $this->playerDataProvider->hasData($name);
 	}
 
 	public function getOfflinePlayerData(string $name) : ?CompoundTag{
 		return Timings::$syncPlayerDataLoad->time(function() use ($name) : ?CompoundTag{
-			$name = strtolower($name);
-			$path = $this->getPlayerDataPath($name);
-
-			if(file_exists($path)){
-				$contents = @file_get_contents($path);
-				if($contents === false){
-					throw new \RuntimeException("Failed to read player data file \"$path\" (permission denied?)");
-				}
-				$decompressed = @zlib_decode($contents);
-				if($decompressed === false){
-					$this->logger->debug("Failed to decompress raw player data for \"$name\"");
-					$this->handleCorruptedPlayerData($name);
-					return null;
-				}
-
-				try{
-					return (new BigEndianNbtSerializer())->read($decompressed)->mustGetCompoundTag();
-				}catch(NbtDataException $e){ //corrupt data
-					$this->logger->debug("Failed to decode NBT data for \"$name\": " . $e->getMessage());
-					$this->handleCorruptedPlayerData($name);
-					return null;
-				}
+			try{
+				return $this->playerDataProvider->loadData($name);
+			}catch(PlayerDataLoadException $e){
+				$this->logger->debug("Failed to load player data for $name: " . $e->getMessage());
+				$this->logger->error($this->getLanguage()->translate(KnownTranslationFactory::pocketmine_data_playerCorrupted($name)));
+				return null;
 			}
-			return null;
 		});
 	}
 
@@ -539,11 +538,9 @@ class Server{
 
 		if(!$ev->isCancelled()){
 			Timings::$syncPlayerDataSave->time(function() use ($name, $ev) : void{
-				$nbt = new BigEndianNbtSerializer();
-				$contents = Utils::assumeNotFalse(zlib_encode($nbt->write(new TreeRoot($ev->getSaveData())), ZLIB_ENCODING_GZIP), "zlib_encode() failed unexpectedly");
 				try{
-					Filesystem::safeFilePutContents($this->getPlayerDataPath($name), $contents);
-				}catch(\RuntimeException $e){
+					$this->playerDataProvider->saveData($name, $ev->getSaveData());
+				}catch(PlayerDataSaveException $e){
 					$this->logger->critical($this->getLanguage()->translate(KnownTranslationFactory::pocketmine_data_saveError($name, $e->getMessage())));
 					$this->logger->logException($e);
 				}
@@ -559,55 +556,54 @@ class Server{
 		$ev->call();
 		$class = $ev->getPlayerClass();
 
-		if($offlinePlayerData !== null && ($world = $this->worldManager->getWorldByName($offlinePlayerData->getString("Level", ""))) !== null){
+		if($offlinePlayerData !== null && ($world = $this->worldManager->getWorldByName($offlinePlayerData->getString(Player::TAG_LEVEL, ""))) !== null){
 			$playerPos = EntityDataHelper::parseLocation($offlinePlayerData, $world);
-			$spawn = $playerPos->asVector3();
 		}else{
 			$world = $this->worldManager->getDefaultWorld();
 			if($world === null){
 				throw new AssumptionFailedError("Default world should always be loaded");
 			}
 			$playerPos = null;
-			$spawn = $world->getSpawnLocation();
 		}
 		/** @phpstan-var PromiseResolver<Player> $playerPromiseResolver */
 		$playerPromiseResolver = new PromiseResolver();
-		$world->requestChunkPopulation($spawn->getFloorX() >> Chunk::COORD_BIT_SIZE, $spawn->getFloorZ() >> Chunk::COORD_BIT_SIZE, null)->onCompletion(
-			function() use ($playerPromiseResolver, $class, $session, $playerInfo, $authenticated, $world, $playerPos, $spawn, $offlinePlayerData) : void{
-				if(!$session->isConnected()){
-					$playerPromiseResolver->reject();
-					return;
-				}
 
-				/* Stick with the original spawn at the time of generation request, even if it changed since then.
-				 * This is because we know for sure that that chunk will be generated, but the one at the new location
-				 * might not be, and it would be much more complex to go back and redo the whole thing.
-				 *
-				 * TODO: this relies on the assumption that getSafeSpawn() will only alter the Y coordinate of the
-				 * provided position. If this assumption is broken, we'll start seeing crashes in here.
-				 */
-
-				/**
-				 * @see Player::__construct()
-				 * @var Player $player
-				 */
-				$player = new $class($this, $session, $playerInfo, $authenticated, $playerPos ?? Location::fromObject($world->getSafeSpawn($spawn), $world), $offlinePlayerData);
-				if(!$player->hasPlayedBefore()){
-					$player->onGround = true;  //TODO: this hack is needed for new players in-air ticks - they don't get detected as on-ground until they move
-				}
-				$playerPromiseResolver->resolve($player);
-			},
-			static function() use ($playerPromiseResolver, $session) : void{
-				if($session->isConnected()){
-					$session->disconnect("Spawn terrain generation failed");
-				}
-				$playerPromiseResolver->reject();
+		$createPlayer = function(Location $location) use ($playerPromiseResolver, $class, $session, $playerInfo, $authenticated, $offlinePlayerData) : void{
+			$player = new $class($this, $session, $playerInfo, $authenticated, $location, $offlinePlayerData);
+			if(!$player->hasPlayedBefore()){
+				$player->onGround = true; //TODO: this hack is needed for new players in-air ticks - they don't get detected as on-ground until they move
 			}
-		);
+			$playerPromiseResolver->resolve($player);
+		};
+
+		if($playerPos === null){ //new player or no valid position due to world not being loaded
+			$world->requestSafeSpawn()->onCompletion(
+				function(Position $spawn) use ($createPlayer, $playerPromiseResolver, $session, $world) : void{
+					if(!$session->isConnected()){
+						$playerPromiseResolver->reject();
+						return;
+					}
+					$createPlayer(Location::fromObject($spawn, $world));
+				},
+				function() use ($playerPromiseResolver, $session) : void{
+					if($session->isConnected()){
+						$session->disconnectWithError(KnownTranslationFactory::pocketmine_disconnect_error_respawn());
+					}
+					$playerPromiseResolver->reject();
+				}
+			);
+		}else{ //returning player with a valid position - safe spawn not required
+			$createPlayer($playerPos);
+		}
+
 		return $playerPromiseResolver->getPromise();
 	}
 
 	/**
+	 * @deprecated This method's results are unpredictable. The string "Steve" will return the player named "SteveJobs",
+	 * until another player named "SteveJ" joins the server, at which point it will return that player instead. Prefer
+	 * filtering the results of {@link Server::getOnlinePlayers()} yourself.
+	 *
 	 * Returns an online player whose name begins with or equals the given string (case insensitive).
 	 * The closest match will be returned, or null if there are no online matches.
 	 *
@@ -765,8 +761,8 @@ class Server{
 	}
 
 	public function __construct(
-		private \DynamicClassLoader $autoloader,
-		private \AttachableThreadedLogger $logger,
+		private ThreadSafeClassLoader $autoloader,
+		private AttachableThreadSafeLogger $logger,
 		string $dataPath,
 		string $pluginPath
 	){
@@ -775,8 +771,11 @@ class Server{
 		}
 		self::$instance = $this;
 		$this->startTime = microtime(true);
+		$this->tickAverage = array_fill(0, self::TARGET_TICKS_PER_SECOND, self::TARGET_TICKS_PER_SECOND);
+		$this->useAverage = array_fill(0, self::TARGET_TICKS_PER_SECOND, 0);
 
-		$this->tickSleeper = new SleeperHandler();
+		Timings::init();
+		$this->tickSleeper = new TimeTrackingSleeperHandler(Timings::$serverInterrupts);
 
 		$this->signalHandler = new SignalHandler(function() : void{
 			$this->logger->info("Received signal interrupt, stopping the server");
@@ -801,7 +800,7 @@ class Server{
 			$this->logger->info("Loading server configuration");
 			$pocketmineYmlPath = Path::join($this->dataPath, "pocketmine.yml");
 			if(!file_exists($pocketmineYmlPath)){
-				$content = Utils::assumeNotFalse(file_get_contents(Path::join(\pocketmine\RESOURCE_PATH, "pocketmine.yml")), "Missing required resource file");
+				$content = Filesystem::fileGetContents(Path::join(\pocketmine\RESOURCE_PATH, "pocketmine.yml"));
 				if(VersionInfo::IS_DEVELOPMENT_BUILD){
 					$content = str_replace("preferred-channel: stable", "preferred-channel: beta", $content);
 				}
@@ -895,6 +894,9 @@ class Server{
 			if($this->configGroup->getPropertyInt("network.batch-threshold", 256) >= 0){
 				$netCompressionThreshold = $this->configGroup->getPropertyInt("network.batch-threshold", 256);
 			}
+			if($netCompressionThreshold < 0){
+				$netCompressionThreshold = null;
+			}
 
 			$netCompressionLevel = $this->configGroup->getPropertyInt("network.compression-level", 6);
 			if($netCompressionLevel < 1 || $netCompressionLevel > 9){
@@ -904,6 +906,10 @@ class Server{
 			ZlibCompressor::setInstance(new ZlibCompressor($netCompressionLevel, $netCompressionThreshold, ZlibCompressor::DEFAULT_MAX_DECOMPRESSION_SIZE));
 
 			$this->networkCompressionAsync = $this->configGroup->getPropertyBool("network.async-compression", true);
+			$this->networkCompressionAsyncThreshold = max(
+				$this->configGroup->getPropertyInt("network.async-compression-threshold", self::DEFAULT_ASYNC_COMPRESSION_THRESHOLD),
+				$netCompressionThreshold ?? self::DEFAULT_ASYNC_COMPRESSION_THRESHOLD
+			);
 
 			EncryptionContext::$ENABLED = $this->configGroup->getPropertyBool("network.enable-encryption", true);
 
@@ -956,9 +962,8 @@ class Server{
 			)));
 			$this->logger->info($this->getLanguage()->translate(KnownTranslationFactory::pocketmine_server_license($this->getName())));
 
-			Timings::init();
 			TimingsHandler::setEnabled($this->configGroup->getPropertyBool("settings.enable-profiling", false));
-			$this->profilingTickRate = $this->configGroup->getPropertyInt("settings.profile-report-trigger", 20);
+			$this->profilingTickRate = $this->configGroup->getPropertyInt("settings.profile-report-trigger", self::TARGET_TICKS_PER_SECOND);
 
 			DefaultPermissions::registerCorePermissions();
 
@@ -974,7 +979,7 @@ class Server{
 				copy(Path::join(\pocketmine\RESOURCE_PATH, 'plugin_list.yml'), $graylistFile);
 			}
 			try{
-				$pluginGraylist = PluginGraylist::fromArray(yaml_parse(file_get_contents($graylistFile)));
+				$pluginGraylist = PluginGraylist::fromArray(yaml_parse(Filesystem::fileGetContents($graylistFile)));
 			}catch(\InvalidArgumentException $e){
 				$this->logger->emergency("Failed to load $graylistFile: " . $e->getMessage());
 				$this->forceShutdownExit();
@@ -996,12 +1001,14 @@ class Server{
 
 			$this->worldManager = new WorldManager($this, Path::join($this->dataPath, "worlds"), $providerManager);
 			$this->worldManager->setAutoSave($this->configGroup->getConfigBool("auto-save", $this->worldManager->getAutoSave()));
-			$this->worldManager->setAutoSaveInterval($this->configGroup->getPropertyInt("ticks-per.autosave", 6000));
+			$this->worldManager->setAutoSaveInterval($this->configGroup->getPropertyInt("ticks-per.autosave", $this->worldManager->getAutoSaveInterval()));
 
 			$this->updater = new UpdateChecker($this, $this->configGroup->getPropertyString("auto-updater.host", "update.pmmp.io"));
 
 			$this->queryInfo = new QueryInfo($this);
 
+			$this->playerDataProvider = new DatFilePlayerDataProvider(Path::join($this->dataPath, "players"));
+
 			register_shutdown_function([$this, "crashDump"]);
 
 			$loadErrorCount = 0;
@@ -1034,7 +1041,7 @@ class Server{
 			}
 
 			if($this->configGroup->getPropertyBool("anonymous-statistics.enabled", true)){
-				$this->sendUsageTicker = 6000;
+				$this->sendUsageTicker = self::TICKS_PER_STATS_REPORT;
 				$this->sendUsage(SendUsageTask::TYPE_OPEN);
 			}
 
@@ -1044,11 +1051,11 @@ class Server{
 			$this->logger->info($this->getLanguage()->translate(KnownTranslationFactory::pocketmine_server_donate(TextFormat::AQUA . "https://patreon.com/pocketminemp" . TextFormat::RESET)));
 			$this->logger->info($this->getLanguage()->translate(KnownTranslationFactory::pocketmine_server_startFinished(strval(round(microtime(true) - $this->startTime, 3)))));
 
-			//TODO: move console parts to a separate component
-			$consoleSender = new ConsoleCommandSender($this, $this->language);
-			$this->subscribeToBroadcastChannel(self::BROADCAST_CHANNEL_ADMINISTRATIVE, $consoleSender);
-			$this->subscribeToBroadcastChannel(self::BROADCAST_CHANNEL_USERS, $consoleSender);
+			$forwarder = new BroadcastLoggerForwarder($this, $this->logger, $this->language);
+			$this->subscribeToBroadcastChannel(self::BROADCAST_CHANNEL_ADMINISTRATIVE, $forwarder);
+			$this->subscribeToBroadcastChannel(self::BROADCAST_CHANNEL_USERS, $forwarder);
 
+			//TODO: move console parts to a separate component
 			if($this->configGroup->getPropertyBool("console.enable-input", true)){
 				$this->console = new ConsoleReaderChildProcessDaemon($this->logger);
 			}
@@ -1169,10 +1176,19 @@ class Server{
 		return !$anyWorldFailedToLoad;
 	}
 
-	private function startupPrepareConnectableNetworkInterfaces(string $ip, int $port, bool $ipV6, bool $useQuery) : bool{
+	private function startupPrepareConnectableNetworkInterfaces(
+		string $ip,
+		int $port,
+		bool $ipV6,
+		bool $useQuery,
+		PacketBroadcaster $packetBroadcaster,
+		EntityEventBroadcaster $entityEventBroadcaster,
+		PacketSerializerContext $packetSerializerContext,
+		TypeConverter $typeConverter
+	) : bool{
 		$prettyIp = $ipV6 ? "[$ip]" : $ip;
 		try{
-			$rakLibRegistered = $this->network->registerInterface(new RakLibInterface($this, $ip, $port, $ipV6));
+			$rakLibRegistered = $this->network->registerInterface(new RakLibInterface($this, $ip, $port, $ipV6, $packetBroadcaster, $entityEventBroadcaster, $packetSerializerContext, $typeConverter));
 		}catch(NetworkInterfaceStartException $e){
 			$this->logger->emergency($this->language->translate(KnownTranslationFactory::pocketmine_server_networkStartFailed(
 				$ip,
@@ -1198,11 +1214,16 @@ class Server{
 	private function startupPrepareNetworkInterfaces() : bool{
 		$useQuery = $this->configGroup->getConfigBool("enable-query", true);
 
+		$typeConverter = TypeConverter::getInstance();
+		$packetSerializerContext = new PacketSerializerContext($typeConverter->getItemTypeDictionary());
+		$packetBroadcaster = new StandardPacketBroadcaster($this, $packetSerializerContext);
+		$entityEventBroadcaster = new StandardEntityEventBroadcaster($packetBroadcaster, $typeConverter);
+
 		if(
-			!$this->startupPrepareConnectableNetworkInterfaces($this->getIp(), $this->getPort(), false, $useQuery) ||
+			!$this->startupPrepareConnectableNetworkInterfaces($this->getIp(), $this->getPort(), false, $useQuery, $packetBroadcaster, $entityEventBroadcaster, $packetSerializerContext, $typeConverter) ||
 			(
 				$this->configGroup->getConfigBool("enable-ipv6", true) &&
-				!$this->startupPrepareConnectableNetworkInterfaces($this->getIpV6(), $this->getPortV6(), true, $useQuery)
+				!$this->startupPrepareConnectableNetworkInterfaces($this->getIpV6(), $this->getPortV6(), true, $useQuery, $packetBroadcaster, $entityEventBroadcaster, $packetSerializerContext, $typeConverter)
 			)
 		){
 			return false;
@@ -1263,7 +1284,7 @@ class Server{
 	}
 
 	/**
-	 * @param CommandSender[]|null        $recipients
+	 * @param CommandSender[]|null $recipients
 	 */
 	public function broadcastMessage(Translatable|string $message, ?array $recipients = null) : int{
 		$recipients = $recipients ?? $this->getBroadcastChannelSubscribers(self::BROADCAST_CHANNEL_USERS);
@@ -1316,9 +1337,9 @@ class Server{
 	}
 
 	/**
-	 * @param int           $fadeIn Duration in ticks for fade-in. If -1 is given, client-sided defaults will be used.
-	 * @param int           $stay Duration in ticks to stay on screen for
-	 * @param int           $fadeOut Duration in ticks for fade-out.
+	 * @param int           $fadeIn     Duration in ticks for fade-in. If -1 is given, client-sided defaults will be used.
+	 * @param int           $stay       Duration in ticks to stay on screen for
+	 * @param int           $fadeOut    Duration in ticks for fade-out.
 	 * @param Player[]|null $recipients
 	 */
 	public function broadcastTitle(string $title, string $subtitle = "", int $fadeIn = -1, int $stay = -1, int $fadeOut = -1, ?array $recipients = null) : int{
@@ -1331,68 +1352,23 @@ class Server{
 		return count($recipients);
 	}
 
-	/**
-	 * @param Player[]            $players
-	 * @param ClientboundPacket[] $packets
-	 */
-	public function broadcastPackets(array $players, array $packets) : bool{
-		if(count($packets) === 0){
-			throw new \InvalidArgumentException("Cannot broadcast empty list of packets");
-		}
-
-		return Timings::$broadcastPackets->time(function() use ($players, $packets) : bool{
-			/** @var NetworkSession[] $recipients */
-			$recipients = [];
-			foreach($players as $player){
-				if($player->isConnected()){
-					$recipients[] = $player->getNetworkSession();
-				}
-			}
-			if(count($recipients) === 0){
-				return false;
-			}
-
-			$ev = new DataPacketSendEvent($recipients, $packets);
-			$ev->call();
-			if($ev->isCancelled()){
-				return false;
-			}
-			$recipients = $ev->getTargets();
-
-			/** @var PacketBroadcaster[] $broadcasters */
-			$broadcasters = [];
-			/** @var NetworkSession[][] $broadcasterTargets */
-			$broadcasterTargets = [];
-			foreach($recipients as $recipient){
-				$broadcaster = $recipient->getBroadcaster();
-				$broadcasters[spl_object_id($broadcaster)] = $broadcaster;
-				$broadcasterTargets[spl_object_id($broadcaster)][] = $recipient;
-			}
-			foreach($broadcasters as $broadcaster){
-				$broadcaster->broadcastPackets($broadcasterTargets[spl_object_id($broadcaster)], $packets);
-			}
-
-			return true;
-		});
-	}
-
 	/**
 	 * Broadcasts a list of packets in a batch to a list of players
 	 *
 	 * @param bool|null $sync Compression on the main thread (true) or workers (false). Default is automatic (null).
 	 */
-	public function prepareBatch(PacketBatch $stream, Compressor $compressor, ?bool $sync = null) : CompressBatchPromise{
+	public function prepareBatch(string $buffer, Compressor $compressor, ?bool $sync = null, ?TimingsHandler $timings = null) : CompressBatchPromise{
+		$timings ??= Timings::$playerNetworkSendCompress;
 		try{
-			Timings::$playerNetworkSendCompress->startTiming();
-
-			$buffer = $stream->getBuffer();
+			$timings->startTiming();
 
 			if($sync === null){
-				$sync = !($this->networkCompressionAsync && $compressor->willCompress($buffer));
+				$threshold = $compressor->getCompressionThreshold();
+				$sync = !$this->networkCompressionAsync || $threshold === null || strlen($buffer) < $threshold;
 			}
 
 			$promise = new CompressBatchPromise();
-			if(!$sync){
+			if(!$sync && strlen($buffer) >= $this->networkCompressionAsyncThreshold){
 				$task = new CompressBatchTask($buffer, $promise, $compressor);
 				$this->asyncPool->submitTask($task);
 			}else{
@@ -1401,7 +1377,7 @@ class Server{
 
 			return $promise;
 		}finally{
-			Timings::$playerNetworkSendCompress->stopTiming();
+			$timings->stopTiming();
 		}
 	}
 
@@ -1532,7 +1508,7 @@ class Server{
 	 * @param mixed[][]|null $trace
 	 * @phpstan-param list<array<string, mixed>>|null $trace
 	 */
-	public function exceptionHandler(\Throwable $e, $trace = null) : void{
+	public function exceptionHandler(\Throwable $e, ?array $trace = null) : void{
 		while(@ob_end_flush()){}
 		global $lastError;
 
@@ -1711,7 +1687,7 @@ class Server{
 		$session = $player->getNetworkSession();
 		$position = $player->getPosition();
 		$this->logger->info($this->language->translate(KnownTranslationFactory::pocketmine_player_logIn(
-			TextFormat::AQUA . $player->getName() . TextFormat::WHITE,
+			TextFormat::AQUA . $player->getName() . TextFormat::RESET,
 			$session->getIp(),
 			(string) $session->getPort(),
 			(string) $player->getId(),
@@ -1816,11 +1792,11 @@ class Server{
 		$this->network->tick();
 		Timings::$connection->stopTiming();
 
-		if(($this->tickCounter % 20) === 0){
+		if(($this->tickCounter % self::TARGET_TICKS_PER_SECOND) === 0){
 			if($this->doTitleTick){
 				$this->titleTick();
 			}
-			$this->currentTPS = 20;
+			$this->currentTPS = self::TARGET_TICKS_PER_SECOND;
 			$this->currentUse = 0;
 
 			$queryRegenerateEvent = new QueryRegenerateEvent(new QueryInfo($this));
@@ -1832,45 +1808,49 @@ class Server{
 		}
 
 		if($this->sendUsageTicker > 0 && --$this->sendUsageTicker === 0){
-			$this->sendUsageTicker = 6000;
+			$this->sendUsageTicker = self::TICKS_PER_STATS_REPORT;
 			$this->sendUsage(SendUsageTask::TYPE_STATUS);
 		}
 
-		if(($this->tickCounter % 100) === 0){
+		if(($this->tickCounter % self::TICKS_PER_WORLD_CACHE_CLEAR) === 0){
 			foreach($this->worldManager->getWorlds() as $world){
 				$world->clearCache();
 			}
+		}
 
-			if($this->getTicksPerSecondAverage() < 12){
-				$this->logger->warning($this->getLanguage()->translate(KnownTranslationFactory::pocketmine_server_tickOverload()));
-			}
+		if(($this->tickCounter % self::TICKS_PER_TPS_OVERLOAD_WARNING) === 0 && $this->getTicksPerSecondAverage() < self::TPS_OVERLOAD_WARNING_THRESHOLD){
+			$this->logger->warning($this->getLanguage()->translate(KnownTranslationFactory::pocketmine_server_tickOverload()));
 		}
 
 		$this->getMemoryManager()->check();
 
 		if($this->console !== null){
+			Timings::$serverCommand->startTiming();
 			while(($line = $this->console->readLine()) !== null){
 				$this->consoleSender ??= new ConsoleCommandSender($this, $this->language);
 				$this->dispatchCommand($this->consoleSender, $line);
 			}
+			Timings::$serverCommand->stopTiming();
 		}
 
 		Timings::$serverTick->stopTiming();
 
 		$now = microtime(true);
-		$this->currentTPS = min(20, 1 / max(0.001, $now - $tickTime));
-		$this->currentUse = min(1, ($now - $tickTime) / 0.05);
+		$totalTickTimeSeconds = $now - $tickTime + ($this->tickSleeper->getNotificationProcessingTime() / 1_000_000_000);
+		$this->currentTPS = min(self::TARGET_TICKS_PER_SECOND, 1 / max(0.001, $totalTickTimeSeconds));
+		$this->currentUse = min(1, $totalTickTimeSeconds / self::TARGET_SECONDS_PER_TICK);
 
 		TimingsHandler::tick($this->currentTPS <= $this->profilingTickRate);
 
-		$idx = $this->tickCounter % 20;
+		$idx = $this->tickCounter % self::TARGET_TICKS_PER_SECOND;
 		$this->tickAverage[$idx] = $this->currentTPS;
 		$this->useAverage[$idx] = $this->currentUse;
+		$this->tickSleeper->resetNotificationProcessingTime();
 
 		if(($this->nextTick - $tickTime) < -1){
 			$this->nextTick = $tickTime;
 		}else{
-			$this->nextTick += 0.05;
+			$this->nextTick += self::TARGET_SECONDS_PER_TICK;
 		}
 	}
 }

src/ServerConfigGroup.php

@@ -43,12 +43,7 @@ final class ServerConfigGroup{
 		private Config $serverProperties
 	){}
 
-	/**
-	 * @param mixed  $defaultValue
-	 *
-	 * @return mixed
-	 */
-	public function getProperty(string $variable, $defaultValue = null){
+	public function getProperty(string $variable, mixed $defaultValue = null) : mixed{
 		if(!array_key_exists($variable, $this->propertyCache)){
 			$v = getopt("", ["$variable::"]);
 			if(isset($v[$variable])){

src/TimeTrackingSleeperHandler.php

@@ -0,0 +1,64 @@
+<?php
+
+/*
+ *
+ *  ____            _        _   __  __ _                  __  __ ____
+ * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
+ * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
+ * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
+ * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * @author PocketMine Team
+ * @link http://www.pocketmine.net/
+ *
+ *
+ */
+
+declare(strict_types=1);
+
+namespace pocketmine;
+
+use pocketmine\snooze\SleeperHandler;
+use pocketmine\timings\TimingsHandler;
+use function hrtime;
+
+/**
+ * Custom Snooze sleeper handler which captures notification processing time.
+ * @internal
+ */
+final class TimeTrackingSleeperHandler extends SleeperHandler{
+
+	private int $notificationProcessingTimeNs = 0;
+
+	public function __construct(
+		private TimingsHandler $timings
+	){
+		parent::__construct();
+	}
+
+	/**
+	 * Returns the time in nanoseconds spent processing notifications since the last reset.
+	 */
+	public function getNotificationProcessingTime() : int{ return $this->notificationProcessingTimeNs; }
+
+	/**
+	 * Resets the notification processing time tracker to zero.
+	 */
+	public function resetNotificationProcessingTime() : void{ $this->notificationProcessingTimeNs = 0; }
+
+	public function processNotifications() : void{
+		$startTime = hrtime(true);
+		$this->timings->startTiming();
+		try{
+			parent::processNotifications();
+		}finally{
+			$this->notificationProcessingTimeNs += hrtime(true) - $startTime;
+			$this->timings->stopTiming();
+		}
+	}
+}

src/VersionInfo.php

@@ -31,9 +31,24 @@ use function str_repeat;
 
 final class VersionInfo{
 	public const NAME = "PocketMine-MP";
-	public const BASE_VERSION = "5.0.0-ALPHA4";
+	public const BASE_VERSION = "5.1.1";
 	public const IS_DEVELOPMENT_BUILD = false;
-	public const BUILD_CHANNEL = "alpha";
+	public const BUILD_CHANNEL = "stable";
+
+	/**
+	 * PocketMine-MP-specific version ID for world data. Used to determine what fixes need to be applied to old world
+	 * data (e.g. stuff saved wrongly by past versions).
+	 * This version supplements the Minecraft vanilla world version.
+	 *
+	 * This should be bumped if any **non-Mojang** BC-breaking change or bug fix is made to world save data of any kind
+	 * (entities, tiles, blocks, biomes etc.). For example, if PM accidentally saved a block with its facing value
+	 * swapped, we would bump this, but not if Mojang did the same change.
+	 */
+	public const WORLD_DATA_VERSION = 1;
+	/**
+	 * Name of the NBT tag used to store the world data version.
+	 */
+	public const TAG_WORLD_DATA_VERSION = "PMMPDataVersion"; //TAG_Long
 
 	private function __construct(){
 		//NOOP

src/block/Anvil.php

@@ -28,14 +28,18 @@ use pocketmine\block\utils\Fallable;
 use pocketmine\block\utils\FallableTrait;
 use pocketmine\block\utils\HorizontalFacingTrait;
 use pocketmine\block\utils\SupportType;
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
+use pocketmine\entity\object\FallingBlock;
 use pocketmine\item\Item;
 use pocketmine\math\AxisAlignedBB;
 use pocketmine\math\Facing;
 use pocketmine\math\Vector3;
 use pocketmine\player\Player;
 use pocketmine\world\BlockTransaction;
+use pocketmine\world\sound\AnvilFallSound;
+use pocketmine\world\sound\Sound;
+use function lcg_value;
+use function round;
 
 class Anvil extends Transparent implements Fallable{
 	use FallableTrait;
@@ -47,15 +51,11 @@ class Anvil extends Transparent implements Fallable{
 
 	private int $damage = self::UNDAMAGED;
 
-	public function getRequiredTypeDataBits() : int{ return 2; }
-
-	protected function describeType(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	public function describeBlockItemState(RuntimeDataDescriber $w) : void{
 		$w->boundedInt(2, self::UNDAMAGED, self::VERY_DAMAGED, $this->damage);
 	}
 
-	public function getRequiredStateDataBits() : int{ return 2; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->horizontalFacing($this->facing);
 	}
 
@@ -96,7 +96,26 @@ class Anvil extends Transparent implements Fallable{
 		return parent::place($tx, $item, $blockReplace, $blockClicked, $face, $clickVector, $player);
 	}
 
-	public function tickFalling() : ?Block{
-		return null;
+	public function onHitGround(FallingBlock $blockEntity) : bool{
+		if(lcg_value() < 0.05 + (round($blockEntity->getFallDistance()) - 1) * 0.05){
+			if($this->damage !== self::VERY_DAMAGED){
+				$this->damage = $this->damage + 1;
+			}else{
+				return false;
+			}
+		}
+		return true;
+	}
+
+	public function getFallDamagePerBlock() : float{
+		return 2.0;
+	}
+
+	public function getMaxFallDamage() : float{
+		return 40.0;
+	}
+
+	public function getLandSound() : ?Sound{
+		return new AnvilFallSound();
 	}
 }

src/block/Bamboo.php

@@ -24,8 +24,7 @@ declare(strict_types=1);
 namespace pocketmine\block;
 
 use pocketmine\block\utils\SupportType;
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\event\block\StructureGrowEvent;
 use pocketmine\item\Bamboo as ItemBamboo;
 use pocketmine\item\Fertilizer;
@@ -56,9 +55,7 @@ class Bamboo extends Transparent{
 	protected bool $ready = false;
 	protected int $leafSize = self::NO_LEAVES;
 
-	public function getRequiredStateDataBits() : int{ return 4; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->boundedInt(2, self::NO_LEAVES, self::LARGE_LEAVES, $this->leafSize);
 		$w->bool($this->thick);
 		$w->bool($this->ready);
@@ -134,7 +131,7 @@ class Bamboo extends Transparent{
 	private function seekToTop() : Bamboo{
 		$world = $this->position->getWorld();
 		$top = $this;
-		while(($next = $world->getBlock($top->position->up())) instanceof Bamboo && $next->isSameType($this)){
+		while(($next = $world->getBlock($top->position->up())) instanceof Bamboo && $next->hasSameTypeId($this)){
 			$top = $next;
 		}
 		return $top;
@@ -159,7 +156,7 @@ class Bamboo extends Transparent{
 	public function onNearbyBlockChange() : void{
 		$world = $this->position->getWorld();
 		$below = $world->getBlock($this->position->down());
-		if(!$this->canBeSupportedBy($below) && !$below->isSameType($this)){
+		if(!$this->canBeSupportedBy($below) && !$below->hasSameTypeId($this)){
 			$world->useBreakOn($this->position);
 		}
 	}
@@ -171,7 +168,7 @@ class Bamboo extends Transparent{
 		}
 
 		$height = 1;
-		while($world->getBlock($this->position->subtract(0, $height, 0))->isSameType($this)){
+		while($world->getBlock($this->position->subtract(0, $height, 0))->hasSameTypeId($this)){
 			if(++$height >= $maxHeight){
 				return false;
 			}

src/block/BambooSapling.php

@@ -23,8 +23,7 @@ declare(strict_types=1);
 
 namespace pocketmine\block;
 
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\event\block\StructureGrowEvent;
 use pocketmine\item\Bamboo as ItemBamboo;
 use pocketmine\item\Fertilizer;
@@ -37,9 +36,7 @@ use pocketmine\world\BlockTransaction;
 final class BambooSapling extends Flowable{
 	private bool $ready = false;
 
-	public function getRequiredStateDataBits() : int{ return 1; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->bool($this->ready);
 	}
 

src/block/Barrel.php

@@ -25,8 +25,7 @@ namespace pocketmine\block;
 
 use pocketmine\block\tile\Barrel as TileBarrel;
 use pocketmine\block\utils\AnyFacingTrait;
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\item\Item;
 use pocketmine\math\Facing;
 use pocketmine\math\Vector3;
@@ -39,9 +38,7 @@ class Barrel extends Opaque{
 
 	protected bool $open = false;
 
-	public function getRequiredStateDataBits() : int{ return 4; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->facing($this->facing);
 		$w->bool($this->open);
 	}

src/block/BaseBanner.php

@@ -89,7 +89,7 @@ abstract class BaseBanner extends Transparent{
 	}
 
 	/**
-	 * @param BannerPatternLayer[]             $patterns
+	 * @param BannerPatternLayer[] $patterns
 	 *
 	 * @phpstan-param list<BannerPatternLayer> $patterns
 	 * @return $this
@@ -114,7 +114,14 @@ abstract class BaseBanner extends Transparent{
 		return SupportType::NONE();
 	}
 
+	private function canBeSupportedBy(Block $block) : bool{
+		return $block->isSolid();
+	}
+
 	public function place(BlockTransaction $tx, Item $item, Block $blockReplace, Block $blockClicked, int $face, Vector3 $clickVector, ?Player $player = null) : bool{
+		if(!$this->canBeSupportedBy($blockReplace->getSide($this->getSupportingFace()))){
+			return false;
+		}
 		if($item instanceof ItemBanner){
 			$this->color = $item->getColor();
 			$this->setPatterns($item->getPatterns());
@@ -126,7 +133,7 @@ abstract class BaseBanner extends Transparent{
 	abstract protected function getSupportingFace() : int;
 
 	public function onNearbyBlockChange() : void{
-		if($this->getSide($this->getSupportingFace())->getTypeId() === BlockTypeIds::AIR){
+		if(!$this->canBeSupportedBy($this->getSide($this->getSupportingFace()))){
 			$this->position->getWorld()->useBreakOn($this->position);
 		}
 	}

src/block/BaseCoral.php

@@ -26,6 +26,7 @@ namespace pocketmine\block;
 use pocketmine\block\utils\CoralType;
 use pocketmine\block\utils\CoralTypeTrait;
 use pocketmine\block\utils\SupportType;
+use pocketmine\event\block\BlockDeathEvent;
 use pocketmine\item\Item;
 use function mt_rand;
 
@@ -33,8 +34,8 @@ abstract class BaseCoral extends Transparent{
 	use CoralTypeTrait;
 
 	public function __construct(BlockIdentifier $idInfo, string $name, BlockTypeInfo $typeInfo){
-		parent::__construct($idInfo, $name, $typeInfo);
 		$this->coralType = CoralType::TUBE();
+		parent::__construct($idInfo, $name, $typeInfo);
 	}
 
 	public function onNearbyBlockChange() : void{
@@ -45,7 +46,11 @@ abstract class BaseCoral extends Transparent{
 
 	public function onScheduledUpdate() : void{
 		if(!$this->dead && !$this->isCoveredWithWater()){
-			$this->position->getWorld()->setBlock($this->position, $this->setDead(true));
+			$ev = new BlockDeathEvent($this, $this->setDead(true));
+			$ev->call();
+			if(!$ev->isCancelled()){
+				$this->position->getWorld()->setBlock($this->position, $ev->getNewState());
+			}
 		}
 	}
 

src/block/BaseSign.php

@@ -117,6 +117,15 @@ abstract class BaseSign extends Transparent{
 		return parent::place($tx, $item, $blockReplace, $blockClicked, $face, $clickVector, $player);
 	}
 
+	public function onPostPlace() : void{
+		$player = $this->editorEntityRuntimeId !== null ?
+			$this->position->getWorld()->getEntity($this->editorEntityRuntimeId) :
+			null;
+		if($player instanceof Player){
+			$player->openSignEditor($this->position);
+		}
+	}
+
 	private function doSignChange(SignText $newText, Player $player, Item $item) : bool{
 		$ev = new SignChangeEvent($this, $player, $newText);
 		$ev->call();
@@ -179,6 +188,19 @@ abstract class BaseSign extends Transparent{
 		return $this;
 	}
 
+	/**
+	 * Sets the runtime entity ID of the player editing this sign. Only this player will be able to edit the sign.
+	 * This is used to prevent multiple players from editing the same sign at the same time, and to prevent players
+	 * from editing signs they didn't place.
+	 */
+	public function getEditorEntityRuntimeId() : ?int{ return $this->editorEntityRuntimeId; }
+
+	/** @return $this */
+	public function setEditorEntityRuntimeId(?int $editorEntityRuntimeId) : self{
+		$this->editorEntityRuntimeId = $editorEntityRuntimeId;
+		return $this;
+	}
+
 	/**
 	 * Called by the player controller (network session) to update the sign text, firing events as appropriate.
 	 *
@@ -202,6 +224,7 @@ abstract class BaseSign extends Transparent{
 		$ev->call();
 		if(!$ev->isCancelled()){
 			$this->setText($ev->getNewText());
+			$this->setEditorEntityRuntimeId(null);
 			$this->position->getWorld()->setBlock($this->position, $this);
 			return true;
 		}

src/block/Bed.php

@@ -28,8 +28,7 @@ use pocketmine\block\utils\ColoredTrait;
 use pocketmine\block\utils\DyeColor;
 use pocketmine\block\utils\HorizontalFacingTrait;
 use pocketmine\block\utils\SupportType;
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\entity\Entity;
 use pocketmine\entity\Living;
 use pocketmine\item\Item;
@@ -54,9 +53,7 @@ class Bed extends Transparent{
 		parent::__construct($idInfo, $name, $typeInfo);
 	}
 
-	public function getRequiredStateDataBits() : int{ return 4; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->horizontalFacing($this->facing);
 		$w->bool($this->occupied);
 		$w->bool($this->head);

src/block/Bedrock.php

@@ -23,15 +23,12 @@ declare(strict_types=1);
 
 namespace pocketmine\block;
 
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 
 class Bedrock extends Opaque{
 	private bool $burnsForever = false;
 
-	public function getRequiredStateDataBits() : int{ return 1; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->bool($this->burnsForever);
 	}
 

src/block/Bell.php

@@ -27,11 +27,12 @@ use pocketmine\block\tile\Bell as TileBell;
 use pocketmine\block\utils\BellAttachmentType;
 use pocketmine\block\utils\HorizontalFacingTrait;
 use pocketmine\block\utils\SupportType;
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
+use pocketmine\entity\projectile\Projectile;
 use pocketmine\item\Item;
 use pocketmine\math\AxisAlignedBB;
 use pocketmine\math\Facing;
+use pocketmine\math\RayTraceResult;
 use pocketmine\math\Vector3;
 use pocketmine\player\Player;
 use pocketmine\world\BlockTransaction;
@@ -47,9 +48,7 @@ final class Bell extends Transparent{
 		parent::__construct($idInfo, $name, $typeInfo);
 	}
 
-	public function getRequiredStateDataBits() : int{ return 4; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->bellAttachmentType($this->attachmentType);
 		$w->horizontalFacing($this->facing);
 	}
@@ -88,14 +87,13 @@ final class Bell extends Transparent{
 		return $this;
 	}
 
-	private function canBeSupportedBy(Block $block) : bool{
-		//TODO: this isn't the actual logic, but it's the closest approximation we can support for now
-		return $block->isSolid();
+	private function canBeSupportedBy(Block $block, int $face) : bool{
+		return !$block->getSupportType($face)->equals(SupportType::NONE());
 	}
 
 	public function place(BlockTransaction $tx, Item $item, Block $blockReplace, Block $blockClicked, int $face, Vector3 $clickVector, ?Player $player = null) : bool{
 		if($face === Facing::UP){
-			if(!$this->canBeSupportedBy($tx->fetchBlock($this->position->down()))){
+			if(!$this->canBeSupportedBy($tx->fetchBlock($this->position->down()), Facing::UP)){
 				return false;
 			}
 			if($player !== null){
@@ -103,18 +101,18 @@ final class Bell extends Transparent{
 			}
 			$this->setAttachmentType(BellAttachmentType::FLOOR());
 		}elseif($face === Facing::DOWN){
-			if(!$this->canBeSupportedBy($tx->fetchBlock($this->position->up()))){
+			if(!$this->canBeSupportedBy($tx->fetchBlock($this->position->up()), Facing::DOWN)){
 				return false;
 			}
 			$this->setAttachmentType(BellAttachmentType::CEILING());
 		}else{
 			$this->setFacing($face);
-			if($this->canBeSupportedBy($tx->fetchBlock($this->position->getSide(Facing::opposite($face))))){
+			if($this->canBeSupportedBy($tx->fetchBlock($this->position->getSide(Facing::opposite($face))), $face)){
 				$this->setAttachmentType(BellAttachmentType::ONE_WALL());
 			}else{
 				return false;
 			}
-			if($this->canBeSupportedBy($tx->fetchBlock($this->position->getSide($face)))){
+			if($this->canBeSupportedBy($tx->fetchBlock($this->position->getSide($face)), Facing::opposite($face))){
 				$this->setAttachmentType(BellAttachmentType::TWO_WALLS());
 			}
 		}
@@ -123,10 +121,10 @@ final class Bell extends Transparent{
 
 	public function onNearbyBlockChange() : void{
 		if(
-			($this->attachmentType->equals(BellAttachmentType::CEILING()) && !$this->canBeSupportedBy($this->getSide(Facing::UP))) ||
-			($this->attachmentType->equals(BellAttachmentType::FLOOR()) && !$this->canBeSupportedBy($this->getSide(Facing::DOWN))) ||
-			($this->attachmentType->equals(BellAttachmentType::ONE_WALL()) && !$this->canBeSupportedBy($this->getSide(Facing::opposite($this->facing)))) ||
-			($this->attachmentType->equals(BellAttachmentType::TWO_WALLS()) && (!$this->canBeSupportedBy($this->getSide($this->facing)) || !$this->canBeSupportedBy($this->getSide(Facing::opposite($this->facing)))))
+			($this->attachmentType->equals(BellAttachmentType::CEILING()) && !$this->canBeSupportedBy($this->getSide(Facing::UP), Facing::DOWN)) ||
+			($this->attachmentType->equals(BellAttachmentType::FLOOR()) && !$this->canBeSupportedBy($this->getSide(Facing::DOWN), Facing::UP)) ||
+			($this->attachmentType->equals(BellAttachmentType::ONE_WALL()) && !$this->canBeSupportedBy($this->getSide(Facing::opposite($this->facing)), $this->facing)) ||
+			($this->attachmentType->equals(BellAttachmentType::TWO_WALLS()) && (!$this->canBeSupportedBy($this->getSide($this->facing), Facing::opposite($this->facing)) || !$this->canBeSupportedBy($this->getSide(Facing::opposite($this->facing)), $this->facing)))
 		){
 			$this->position->getWorld()->useBreakOn($this->position);
 		}
@@ -135,21 +133,20 @@ final class Bell extends Transparent{
 	public function onInteract(Item $item, int $face, Vector3 $clickVector, ?Player $player = null, array &$returnedItems = []) : bool{
 		if($player !== null){
 			$faceHit = Facing::opposite($player->getHorizontalFacing());
-			if($this->attachmentType->equals(BellAttachmentType::CEILING())){
-				$this->ring($faceHit);
-			}
-			if($this->attachmentType->equals(BellAttachmentType::FLOOR()) && Facing::axis($faceHit) === Facing::axis($this->facing)){
-				$this->ring($faceHit);
-			}
-			if(
-				($this->attachmentType->equals(BellAttachmentType::ONE_WALL()) || $this->attachmentType->equals(BellAttachmentType::TWO_WALLS())) &&
-				($faceHit === Facing::rotateY($this->facing, false) || $faceHit === Facing::rotateY($this->facing, true))
-			){
+			if($this->isValidFaceToRing($faceHit)){
 				$this->ring($faceHit);
+				return true;
 			}
 		}
 
-		return true;
+		return false;
+	}
+
+	public function onProjectileHit(Projectile $projectile, RayTraceResult $hitResult) : void{
+		$faceHit = Facing::opposite($projectile->getHorizontalFacing());
+		if($this->isValidFaceToRing($faceHit)){
+			$this->ring($faceHit);
+		}
 	}
 
 	public function ring(int $faceHit) : void{
@@ -160,4 +157,15 @@ final class Bell extends Transparent{
 			$world->broadcastPacketToViewers($this->position, $tile->createFakeUpdatePacket($faceHit));
 		}
 	}
+
+	private function isValidFaceToRing(int $faceHit) : bool{
+		return (
+			$this->attachmentType->equals(BellAttachmentType::CEILING()) ||
+			($this->attachmentType->equals(BellAttachmentType::FLOOR()) && Facing::axis($faceHit) === Facing::axis($this->facing)) ||
+			(
+				($this->attachmentType->equals(BellAttachmentType::ONE_WALL()) || $this->attachmentType->equals(BellAttachmentType::TWO_WALLS())) &&
+				($faceHit === Facing::rotateY($this->facing, false) || $faceHit === Facing::rotateY($this->facing, true))
+			)
+		);
+	}
 }

src/block/Block.php

@@ -29,7 +29,10 @@ namespace pocketmine\block;
 use pocketmine\block\tile\Spawnable;
 use pocketmine\block\tile\Tile;
 use pocketmine\block\utils\SupportType;
+use pocketmine\data\runtime\InvalidSerializedRuntimeDataException;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\data\runtime\RuntimeDataReader;
+use pocketmine\data\runtime\RuntimeDataSizeCalculator;
 use pocketmine\data\runtime\RuntimeDataWriter;
 use pocketmine\entity\Entity;
 use pocketmine\entity\projectile\Projectile;
@@ -42,6 +45,7 @@ use pocketmine\math\RayTraceResult;
 use pocketmine\math\Vector3;
 use pocketmine\nbt\tag\CompoundTag;
 use pocketmine\player\Player;
+use pocketmine\utils\AssumptionFailedError;
 use pocketmine\world\BlockTransaction;
 use pocketmine\world\format\Chunk;
 use pocketmine\world\Position;
@@ -51,9 +55,14 @@ use function get_class;
 use const PHP_INT_MAX;
 
 class Block{
-	public const INTERNAL_STATE_DATA_BITS = 9;
+	public const INTERNAL_STATE_DATA_BITS = 8;
 	public const INTERNAL_STATE_DATA_MASK = ~(~0 << self::INTERNAL_STATE_DATA_BITS);
 
+	/**
+	 * @internal
+	 */
+	public const EMPTY_STATE_ID = (BlockTypeIds::AIR << self::INTERNAL_STATE_DATA_BITS) | (BlockTypeIds::AIR & self::INTERNAL_STATE_DATA_MASK);
+
 	protected BlockIdentifier $idInfo;
 	protected string $fallbackName;
 	protected BlockTypeInfo $typeInfo;
@@ -62,176 +71,103 @@ class Block{
 	/** @var AxisAlignedBB[]|null */
 	protected ?array $collisionBoxes = null;
 
+	private int $requiredBlockItemStateDataBits;
+	private int $requiredBlockOnlyStateDataBits;
+
+	private Block $defaultState;
+
 	/**
-	 * @param string          $name English name of the block type (TODO: implement translations)
+	 * @param string $name English name of the block type (TODO: implement translations)
 	 */
 	public function __construct(BlockIdentifier $idInfo, string $name, BlockTypeInfo $typeInfo){
 		$this->idInfo = $idInfo;
 		$this->fallbackName = $name;
 		$this->typeInfo = $typeInfo;
 		$this->position = new Position(0, 0, 0, null);
+
+		$calculator = new RuntimeDataSizeCalculator();
+		$this->describeBlockItemState($calculator);
+		$this->requiredBlockItemStateDataBits = $calculator->getBitsUsed();
+
+		$calculator = new RuntimeDataSizeCalculator();
+		$this->describeBlockOnlyState($calculator);
+		$this->requiredBlockOnlyStateDataBits = $calculator->getBitsUsed();
+
+		$defaultState = clone $this;
+		$this->defaultState = $defaultState;
+		$defaultState->defaultState = $defaultState;
 	}
 
 	public function __clone(){
 		$this->position = clone $this->position;
 	}
 
+	/**
+	 * Returns an object containing information about how to identify and store this block type, such as type ID and
+	 * tile type (if any).
+	 */
 	public function getIdInfo() : BlockIdentifier{
 		return $this->idInfo;
 	}
 
+	/**
+	 * Returns the printable English name of the block.
+	 */
 	public function getName() : string{
 		return $this->fallbackName;
 	}
 
 	/**
-	 * @internal
-	 */
-	public function getStateId() : int{
-		return ($this->getTypeId() << self::INTERNAL_STATE_DATA_BITS) | $this->computeStateData();
-	}
-
-	public function asItem() : Item{
-		return new ItemBlock($this);
-	}
-
-	public function getRequiredTypeDataBits() : int{ return 0; }
-
-	public function getRequiredStateDataBits() : int{ return 0; }
-
-	/**
-	 * @internal
-	 */
-	final public function decodeTypeData(int $data) : void{
-		$typeBits = $this->getRequiredTypeDataBits();
-		$givenBits = $typeBits;
-		$reader = new RuntimeDataReader($givenBits, $data);
-
-		$this->describeType($reader);
-		$readBits = $reader->getOffset();
-		if($typeBits !== $readBits){
-			throw new \LogicException(get_class($this) . ": Exactly $typeBits bits of type data were provided, but $readBits were read");
-		}
-	}
-
-	/**
-	 * @internal
-	 */
-	final public function decodeStateData(int $data) : void{
-		$typeBits = $this->getRequiredTypeDataBits();
-		$stateBits = $this->getRequiredStateDataBits();
-		$givenBits = $typeBits + $stateBits;
-		$reader = new RuntimeDataReader($givenBits, $data);
-		$this->decodeTypeData($reader->readInt($typeBits));
-
-		$this->describeState($reader);
-		$readBits = $reader->getOffset() - $typeBits;
-		if($stateBits !== $readBits){
-			throw new \LogicException(get_class($this) . ": Exactly $stateBits bits of state data were provided, but $readBits were read");
-		}
-	}
-
-	/**
-	 * @internal
-	 */
-	final public function computeTypeData() : int{
-		$typeBits = $this->getRequiredTypeDataBits();
-		$requiredBits = $typeBits;
-		$writer = new RuntimeDataWriter($requiredBits);
-
-		$this->describeType($writer);
-		$writtenBits = $writer->getOffset();
-		if($typeBits !== $writtenBits){
-			throw new \LogicException(get_class($this) . ": Exactly $typeBits bits of type data were expected, but $writtenBits were written");
-		}
-
-		return $writer->getValue();
-	}
-
-	/**
-	 * @internal
-	 */
-	final public function computeStateData() : int{
-		$typeBits = $this->getRequiredTypeDataBits();
-		$stateBits = $this->getRequiredStateDataBits();
-		$requiredBits = $typeBits + $stateBits;
-		$writer = new RuntimeDataWriter($requiredBits);
-		$writer->int($typeBits, $this->computeTypeData());
-
-		$this->describeState($writer);
-		$writtenBits = $writer->getOffset() - $typeBits;
-		if($stateBits !== $writtenBits){
-			throw new \LogicException(get_class($this) . ": Exactly $stateBits bits of state data were expected, but $writtenBits were written");
-		}
-
-		return $writer->getValue();
-	}
-
-	protected function describeType(RuntimeDataReader|RuntimeDataWriter $w) : void{
-		//NOOP
-	}
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
-		//NOOP
-	}
-
-	/**
-	 * Called when this block is created, set, or has a neighbouring block update, to re-detect dynamic properties which
-	 * are not saved on the world.
+	 * Returns a type ID that identifies this type of block. This allows comparing basic block types, e.g. wool, stone,
+	 * glass, etc. Type ID will not change for a given block type.
 	 *
-	 * Clears any cached precomputed objects, such as bounding boxes. Remove any outdated precomputed things such as
-	 * AABBs and force recalculation.
+	 * Information such as colour, powered, open/closed, etc. is **not** included in this ID.
+	 * If you want to get a state ID that includes this information, use {@link Block::getStateId()} instead.
 	 *
-	 * A replacement block may be returned. This is useful if the block type changed due to reading of world data (e.g.
-	 * data from a block entity).
-	 */
-	public function readStateFromWorld() : Block{
-		$this->collisionBoxes = null;
-
-		return $this;
-	}
-
-	public function writeStateToWorld() : void{
-		$world = $this->position->getWorld();
-		$world->getOrLoadChunkAtPosition($this->position)->setFullBlock($this->position->x & Chunk::COORD_MASK, $this->position->y, $this->position->z & Chunk::COORD_MASK, $this->getStateId());
-
-		$tileType = $this->idInfo->getTileClass();
-		$oldTile = $world->getTile($this->position);
-		if($oldTile !== null){
-			if($tileType === null || !($oldTile instanceof $tileType)){
-				$oldTile->close();
-				$oldTile = null;
-			}elseif($oldTile instanceof Spawnable){
-				$oldTile->clearSpawnCompoundCache(); //destroy old network cache
-			}
-		}
-		if($oldTile === null && $tileType !== null){
-			/**
-			 * @var Tile $tile
-			 * @see Tile::__construct()
-			 */
-			$tile = new $tileType($world, $this->position->asVector3());
-			$world->addTile($tile);
-		}
-	}
-
-	/**
-	 * Returns a type ID that identifies this type of block. This does not include information like facing, colour,
-	 * powered/unpowered, etc.
+	 * @see BlockTypeIds
 	 */
 	public function getTypeId() : int{
 		return $this->idInfo->getBlockTypeId();
 	}
 
 	/**
-	 * Returns whether the given block has an equivalent type to this one. This compares the type IDs.
+	 * @internal
+	 *
+	 * Returns the full blockstate ID of this block. This is a compact way of representing a blockstate used to store
+	 * blocks in chunks at runtime.
+	 *
+	 * This usually encodes all properties of the block, such as facing, open/closed, powered/unpowered, colour, etc.
+	 * State ID may change depending on the properties of the block (e.g. a torch facing east will have a different
+	 * state ID to one facing west).
+	 *
+	 * Some blocks (such as signs and chests) may store additional properties in an associated "tile" if they
+	 * have too many possible values to be encoded into the state ID. These extra properties are **NOT** included in
+	 * this function's result.
+	 *
+	 * This ID can be used to later obtain a copy of the block with the same state properties by using
+	 * {@link RuntimeBlockStateRegistry::fromStateId()}.
 	 */
-	public function isSameType(Block $other) : bool{
+	public function getStateId() : int{
+		$typeId = $this->getTypeId();
+		//TODO: this XOR mask improves hashtable distribution, but it's only effective if the number of unique block
+		//type IDs is larger than the number of available state data bits. We should probably hash (e.g. using xxhash)
+		//the type ID to create a better mask.
+		//Alternatively, we could hash the whole state ID, but this is currently problematic, since we currently need
+		//to be able to recover the state data from the state ID because of UnknownBlock.
+		return ($typeId << self::INTERNAL_STATE_DATA_BITS) | ($this->encodeFullState() ^ ($typeId & self::INTERNAL_STATE_DATA_MASK));
+	}
+
+	/**
+	 * Returns whether the given block has the same type ID as this one.
+	 */
+	public function hasSameTypeId(Block $other) : bool{
 		return $this->getTypeId() === $other->getTypeId();
 	}
 
 	/**
 	 * Returns whether the given block has the same type and properties as this block.
+	 *
+	 * Note: Tile data (e.g. sign text, chest contents) are not compared here.
 	 */
 	public function isSameState(Block $other) : bool{
 		return $this->getStateId() === $other->getStateId();
@@ -256,6 +192,179 @@ class Block{
 		return $this->typeInfo->hasTypeTag($tag);
 	}
 
+	/**
+	 * Returns the block as an item.
+	 * Block-only state such as facing, powered/unpowered, open/closed, etc., is discarded.
+	 * Block-item state such as colour, wood type, etc. is preserved.
+	 * Complex state properties stored in the tile data (e.g. inventory) are discarded.
+	 */
+	public function asItem() : Item{
+		$normalized = clone $this->defaultState;
+		$normalized->decodeBlockItemState($this->encodeBlockItemState());
+		return new ItemBlock($normalized);
+	}
+
+	private function decodeBlockItemState(int $data) : void{
+		$reader = new RuntimeDataReader($this->requiredBlockItemStateDataBits, $data);
+
+		$this->describeBlockItemState($reader);
+		$readBits = $reader->getOffset();
+		if($this->requiredBlockItemStateDataBits !== $readBits){
+			throw new \LogicException(get_class($this) . ": Exactly $this->requiredBlockItemStateDataBits bits of block-item state data were provided, but $readBits were read");
+		}
+	}
+
+	private function decodeBlockOnlyState(int $data) : void{
+		$reader = new RuntimeDataReader($this->requiredBlockOnlyStateDataBits, $data);
+
+		$this->describeBlockOnlyState($reader);
+		$readBits = $reader->getOffset();
+		if($this->requiredBlockOnlyStateDataBits !== $readBits){
+			throw new \LogicException(get_class($this) . ": Exactly $this->requiredBlockOnlyStateDataBits bits of block-only state data were provided, but $readBits were read");
+		}
+	}
+
+	private function decodeFullState(int $data) : void{
+		$reader = new RuntimeDataReader($this->requiredBlockItemStateDataBits + $this->requiredBlockOnlyStateDataBits, $data);
+		$this->decodeBlockItemState($reader->readInt($this->requiredBlockItemStateDataBits));
+		$this->decodeBlockOnlyState($reader->readInt($this->requiredBlockOnlyStateDataBits));
+	}
+
+	private function encodeBlockItemState() : int{
+		$writer = new RuntimeDataWriter($this->requiredBlockItemStateDataBits);
+
+		$this->describeBlockItemState($writer);
+		$writtenBits = $writer->getOffset();
+		if($this->requiredBlockItemStateDataBits !== $writtenBits){
+			throw new \LogicException(get_class($this) . ": Exactly $this->requiredBlockItemStateDataBits bits of block-item state data were expected, but $writtenBits were written");
+		}
+
+		return $writer->getValue();
+	}
+
+	private function encodeBlockOnlyState() : int{
+		$writer = new RuntimeDataWriter($this->requiredBlockOnlyStateDataBits);
+
+		$this->describeBlockOnlyState($writer);
+		$writtenBits = $writer->getOffset();
+		if($this->requiredBlockOnlyStateDataBits !== $writtenBits){
+			throw new \LogicException(get_class($this) . ": Exactly $this->requiredBlockOnlyStateDataBits bits of block-only state data were expected, but $writtenBits were written");
+		}
+
+		return $writer->getValue();
+	}
+
+	private function encodeFullState() : int{
+		$writer = new RuntimeDataWriter($this->requiredBlockItemStateDataBits + $this->requiredBlockOnlyStateDataBits);
+		$writer->writeInt($this->requiredBlockItemStateDataBits, $this->encodeBlockItemState());
+		$writer->writeInt($this->requiredBlockOnlyStateDataBits, $this->encodeBlockOnlyState());
+
+		return $writer->getValue();
+	}
+
+	/**
+	 * Describes properties of this block which apply to both the block and item form of the block.
+	 * Examples of suitable properties include colour, skull type, and any other information which **IS** kept when the
+	 * block is mined or block-picked.
+	 *
+	 * The method implementation must NOT use conditional logic to determine which properties are written. It must
+	 * always write the same properties in the same order, regardless of the current state of the block.
+	 */
+	public function describeBlockItemState(RuntimeDataDescriber $w) : void{
+		//NOOP
+	}
+
+	/**
+	 * Describes properties of this block which apply only to the block form of the block.
+	 * Examples of suitable properties include facing, open/closed, powered/unpowered, on/off, and any other information
+	 * which **IS NOT** kept when the block is mined or block-picked.
+	 *
+	 * The method implementation must NOT use conditional logic to determine which properties are written. It must
+	 * always write the same properties in the same order, regardless of the current state of the block.
+	 */
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
+		//NOOP
+	}
+
+	/**
+	 * Generates copies of this Block in all possible state permutations.
+	 * Every possible combination of known properties (e.g. facing, open/closed, powered/unpowered, on/off) will be
+	 * generated.
+	 *
+	 * @phpstan-return \Generator<int, Block, void, void>
+	 */
+	public function generateStatePermutations() : \Generator{
+		//TODO: this bruteforce approach to discovering all valid states is very inefficient for larger state data sizes
+		//at some point we'll need to find a better way to do this
+		$bits = $this->requiredBlockItemStateDataBits + $this->requiredBlockOnlyStateDataBits;
+		if($bits > Block::INTERNAL_STATE_DATA_BITS){
+			throw new \LogicException("Block state data cannot use more than " . Block::INTERNAL_STATE_DATA_BITS . " bits");
+		}
+		for($stateData = 0; $stateData < (1 << $bits); ++$stateData){
+			$v = clone $this;
+			try{
+				$v->decodeFullState($stateData);
+				if($v->encodeFullState() !== $stateData){
+					throw new \LogicException(static::class . "::decodeStateData() accepts invalid state data (returned " . $v->encodeFullState() . " for input $stateData)");
+				}
+			}catch(InvalidSerializedRuntimeDataException){ //invalid property combination, leave it
+				continue;
+			}
+
+			yield $v;
+		}
+	}
+
+	/**
+	 * Called when this block is created, set, or has a neighbouring block update, to re-detect dynamic properties which
+	 * are not saved on the world.
+	 *
+	 * Clears any cached precomputed objects, such as bounding boxes. Remove any outdated precomputed things such as
+	 * AABBs and force recalculation.
+	 *
+	 * A replacement block may be returned. This is useful if the block type changed due to reading of world data (e.g.
+	 * data from a block entity).
+	 */
+	public function readStateFromWorld() : Block{
+		$this->collisionBoxes = null;
+
+		return $this;
+	}
+
+	/**
+	 * Writes information about the block into the world. This writes the blockstate ID into the chunk, and creates
+	 * and/or removes tiles as necessary.
+	 *
+	 * Note: Do not call this directly. Pass the block to {@link World::setBlock()} instead.
+	 */
+	public function writeStateToWorld() : void{
+		$world = $this->position->getWorld();
+		$chunk = $world->getOrLoadChunkAtPosition($this->position);
+		if($chunk === null){
+			throw new AssumptionFailedError("World::setBlock() should have loaded the chunk before calling this method");
+		}
+		$chunk->setBlockStateId($this->position->x & Chunk::COORD_MASK, $this->position->y, $this->position->z & Chunk::COORD_MASK, $this->getStateId());
+
+		$tileType = $this->idInfo->getTileClass();
+		$oldTile = $world->getTile($this->position);
+		if($oldTile !== null){
+			if($tileType === null || !($oldTile instanceof $tileType)){
+				$oldTile->close();
+				$oldTile = null;
+			}elseif($oldTile instanceof Spawnable){
+				$oldTile->clearSpawnCompoundCache(); //destroy old network cache
+			}
+		}
+		if($oldTile === null && $tileType !== null){
+			/**
+			 * @var Tile $tile
+			 * @see Tile::__construct()
+			 */
+			$tile = new $tileType($world, $this->position->asVector3());
+			$world->addTile($tile);
+		}
+	}
+
 	/**
 	 * AKA: Block->isPlaceable
 	 */
@@ -263,22 +372,44 @@ class Block{
 		return true;
 	}
 
+	/**
+	 * Returns whether this block can be replaced by another block placed in the same position.
+	 */
 	public function canBeReplaced() : bool{
 		return false;
 	}
 
+	/**
+	 * Returns whether this block can replace the given block in the given placement conditions.
+	 * This is used to allow slabs of the same type to combine into double slabs.
+	 */
 	public function canBePlacedAt(Block $blockReplace, Vector3 $clickVector, int $face, bool $isClickedBlock) : bool{
 		return $blockReplace->canBeReplaced();
 	}
 
 	/**
-	 * Places the Block, using block space and block target, and side. Returns if the block has been placed.
+	 * Generates a block transaction to set all blocks affected by placing this block. Usually this is just the block
+	 * itself, but may be multiple blocks in some cases (such as doors).
+	 *
+	 * @param BlockTransaction $tx           Blocks to be set should be added to this transaction (do not modify thr world directly)
+	 * @param Item             $item         Item used to place the block
+	 * @param Block            $blockReplace Block expected to be replaced
+	 * @param Block            $blockClicked Block that was clicked using the item
+	 * @param int              $face         Face of the clicked block which was clicked
+	 * @param Vector3          $clickVector  Exact position inside the clicked block where the click occurred, relative to the block's position
+	 * @param Player|null      $player       Player who placed the block, or null if it was not a player
+	 *
+	 * @return bool whether the placement should go ahead
 	 */
 	public function place(BlockTransaction $tx, Item $item, Block $blockReplace, Block $blockClicked, int $face, Vector3 $clickVector, ?Player $player = null) : bool{
 		$tx->addBlock($blockReplace->position, $this);
 		return true;
 	}
 
+	/**
+	 * Called immediately after the block has been placed in the world. Since placement uses a block transaction, some
+	 * things may not be possible until after the transaction has been executed.
+	 */
 	public function onPostPlace() : void{
 
 	}
@@ -320,7 +451,7 @@ class Block{
 
 	/**
 	 * Called when this block is randomly updated due to chunk ticking.
-	 * WARNING: This will not be called if ticksRandomly() does not return true!
+	 * WARNING: This will not be called if {@link Block::ticksRandomly()} does not return true!
 	 */
 	public function onRandomTick() : void{
 
@@ -343,8 +474,7 @@ class Block{
 	}
 
 	/**
-	 * Called when this block is attacked (left-clicked). This is called when a player left-clicks the block to try and
-	 * start to break it in survival mode.
+	 * Called when this block is attacked (left-clicked) by a player attempting to start breaking it in survival.
 	 *
 	 * @return bool if an action took place, prevents starting to break the block if true.
 	 */
@@ -352,11 +482,19 @@ class Block{
 		return false;
 	}
 
+	/**
+	 * Returns a multiplier applied to the velocity of entities moving on top of this block. A higher value will make
+	 * the block more slippery (like ice).
+	 *
+	 * @return float 0.0-1.0
+	 */
 	public function getFrictionFactor() : float{
 		return 0.6;
 	}
 
 	/**
+	 * Returns the amount of light emitted by this block.
+	 *
 	 * @return int 0-15
 	 */
 	public function getLightLevel() : int{
@@ -399,10 +537,6 @@ class Block{
 		return false;
 	}
 
-	public function hasEntityCollision() : bool{
-		return false;
-	}
-
 	/**
 	 * Returns whether entities can climb up this block.
 	 */
@@ -410,10 +544,6 @@ class Block{
 		return false;
 	}
 
-	public function addVelocityToEntity(Entity $entity) : ?Vector3{
-		return null;
-	}
-
 	final public function getPosition() : Position{
 		return $this->position;
 	}
@@ -496,6 +626,7 @@ class Block{
 
 	/**
 	 * Returns the item that players will equip when middle-clicking on this block.
+	 * If addUserData is true, additional data may be added, such as banner patterns, chest contents, etc.
 	 */
 	public function getPickedItem(bool $addUserData = false) : Item{
 		$item = $this->asItem();
@@ -619,11 +750,11 @@ class Block{
 	 * @return string
 	 */
 	public function __toString(){
-		return "Block[" . $this->getName() . "] (" . $this->getTypeId() . ":" . $this->computeStateData() . ")";
+		return "Block[" . $this->getName() . "] (" . $this->getTypeId() . ":" . $this->encodeFullState() . ")";
 	}
 
 	/**
-	 * Checks for collision against an AxisAlignedBB
+	 * Returns whether any of the block's collision boxes intersect with the given AxisAlignedBB.
 	 */
 	public function collidesWithBB(AxisAlignedBB $bb) : bool{
 		foreach($this->getCollisionBoxes() as $bb2){
@@ -635,10 +766,21 @@ class Block{
 		return false;
 	}
 
+	/**
+	 * Returns whether the block has actions to be executed when an entity enters its cell (full cube space).
+	 *
+	 * @see Block::onEntityInside()
+	 */
+	public function hasEntityCollision() : bool{
+		return false;
+	}
+
 	/**
 	 * Called when an entity's bounding box clips inside this block's cell. Note that the entity may not be intersecting
 	 * with the collision box or bounding box.
 	 *
+	 * WARNING: This will not be called if {@link Block::hasEntityCollision()} returns false.
+	 *
 	 * @return bool Whether the block is still the same after the intersection. If it changed (e.g. due to an explosive
 	 * being ignited), this should return false.
 	 */
@@ -646,6 +788,19 @@ class Block{
 		return true;
 	}
 
+	/**
+	 * Returns a direction vector describing which way an entity intersecting this block should be pushed.
+	 * This is used by liquids to push entities in liquid currents.
+	 *
+	 * The returned vector is summed with vectors from every other block the entity is intersecting, and normalized to
+	 * produce a final direction vector.
+	 *
+	 * WARNING: This will not be called if {@link Block::hasEntityCollision()} does not return true!
+	 */
+	public function addVelocityToEntity(Entity $entity) : ?Vector3{
+		return null;
+	}
+
 	/**
 	 * Called when an entity lands on this block (usually due to falling).
 	 * @return float|null The new vertical velocity of the entity, or null if unchanged.
@@ -662,6 +817,13 @@ class Block{
 	}
 
 	/**
+	 * Returns an array of collision bounding boxes for this block.
+	 * These are used for:
+	 * - entity movement collision checks (to ensure entities can't clip through blocks)
+	 * - projectile flight paths
+	 * - block placement (to ensure the player can't place blocks inside itself or another entity)
+	 * - anti-cheat checks in plugins
+	 *
 	 * @return AxisAlignedBB[]
 	 */
 	final public function getCollisionBoxes() : array{
@@ -692,6 +854,10 @@ class Block{
 		return [AxisAlignedBB::one()];
 	}
 
+	/**
+	 * Returns the type of support that the block can provide on the given face. This is used to determine whether
+	 * blocks placed on the given face can be supported by this block.
+	 */
 	public function getSupportType(int $facing) : SupportType{
 		return SupportType::FULL();
 	}
@@ -702,6 +868,10 @@ class Block{
 		return count($bb) === 1 && $bb[0]->getAverageEdgeLength() >= 1 && $bb[0]->isCube();
 	}
 
+	/**
+	 * Performs a ray trace along the line between the two positions using the block's collision boxes.
+	 * Returns the intersection point closest to pos1, or null if no intersection occurred.
+	 */
 	public function calculateIntercept(Vector3 $pos1, Vector3 $pos2) : ?RayTraceResult{
 		$bbs = $this->getCollisionBoxes();
 		if(count($bbs) === 0){

src/block/BlockTypeIds.php

@@ -24,11 +24,14 @@ declare(strict_types=1);
 namespace pocketmine\block;
 
 /**
- * Enum of all the block runtime IDs used by PocketMine-MP. These IDs are specific to PocketMine-MP and have no
- * relevance to any Minecraft vanilla things.
+ * Every block in {@link VanillaBlocks} has a corresponding constant in this class. These constants can be used to
+ * identify and compare block types efficiently using {@link Block::getTypeId()}.
  *
- * WARNING: DO NOT STORE THESE IDS. They can and will change without warning.
- * They should ONLY be used to IDENTIFY blocks at runtime.
+ * Type ID is also used internally as part of block state ID, which is used to store blocks and their simple properties
+ * in a memory-efficient way in chunks at runtime.
+ *
+ * WARNING: These are NOT a replacement for Minecraft legacy IDs. Do **NOT** hardcode their values, or store them in
+ * configs or databases. They will change without warning.
  */
 final class BlockTypeIds{
 
@@ -704,8 +707,18 @@ final class BlockTypeIds{
 	public const MANGROVE_ROOTS = 10677;
 	public const MUDDY_MANGROVE_ROOTS = 10678;
 	public const FROGLIGHT = 10679;
+	public const TWISTING_VINES = 10680;
+	public const WEEPING_VINES = 10681;
+	public const CHAIN = 10682;
+	public const SCULK = 10683;
+	public const GLOWING_ITEM_FRAME = 10684;
+	public const MANGROVE_LEAVES = 10685;
+	public const AZALEA_LEAVES = 10686;
+	public const FLOWERING_AZALEA_LEAVES = 10687;
+	public const REINFORCED_DEEPSLATE = 10688;
+	public const CAVE_VINES = 10689;
 
-	public const FIRST_UNUSED_BLOCK_ID = 10680;
+	public const FIRST_UNUSED_BLOCK_ID = 10690;
 
 	private static int $nextDynamicId = self::FIRST_UNUSED_BLOCK_ID;
 

src/block/BlockTypeTags.php

@@ -24,9 +24,11 @@ declare(strict_types=1);
 namespace pocketmine\block;
 
 final class BlockTypeTags{
+	private const PREFIX = "pocketmine:";
 
-	public const DIRT = "dirt";
-	public const MUD = "mud";
-	public const SAND = "sand";
-	public const POTTABLE_PLANTS = "pottable";
+	public const DIRT = self::PREFIX . "dirt";
+	public const MUD = self::PREFIX . "mud";
+	public const SAND = self::PREFIX . "sand";
+	public const POTTABLE_PLANTS = self::PREFIX . "pottable";
+	public const FIRE = self::PREFIX . "fire";
 }

src/block/BrewingStand.php

@@ -26,8 +26,7 @@ namespace pocketmine\block;
 use pocketmine\block\tile\BrewingStand as TileBrewingStand;
 use pocketmine\block\utils\BrewingStandSlot;
 use pocketmine\block\utils\SupportType;
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\item\Item;
 use pocketmine\math\Axis;
 use pocketmine\math\AxisAlignedBB;
@@ -44,9 +43,7 @@ class BrewingStand extends Transparent{
 	 */
 	protected array $slots = [];
 
-	public function getRequiredStateDataBits() : int{ return 3; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->brewingStandSlots($this->slots);
 	}
 

src/block/Button.php

@@ -24,8 +24,7 @@ declare(strict_types=1);
 namespace pocketmine\block;
 
 use pocketmine\block\utils\AnyFacingTrait;
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\item\Item;
 use pocketmine\math\Facing;
 use pocketmine\math\Vector3;
@@ -39,9 +38,7 @@ abstract class Button extends Flowable{
 
 	protected bool $pressed = false;
 
-	public function getRequiredStateDataBits() : int{ return 4; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->facing($this->facing);
 		$w->bool($this->pressed);
 	}
@@ -55,7 +52,7 @@ abstract class Button extends Flowable{
 	}
 
 	public function place(BlockTransaction $tx, Item $item, Block $blockReplace, Block $blockClicked, int $face, Vector3 $clickVector, ?Player $player = null) : bool{
-		if($this->canBeSupportedBy($blockClicked, $face)){
+		if($this->canBeSupportedBy($blockReplace->getSide(Facing::opposite($face)), $face)){
 			$this->facing = $face;
 			return parent::place($tx, $item, $blockReplace, $blockClicked, $face, $clickVector, $player);
 		}

src/block/Cactus.php

@@ -24,8 +24,7 @@ declare(strict_types=1);
 namespace pocketmine\block;
 
 use pocketmine\block\utils\SupportType;
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\entity\Entity;
 use pocketmine\event\block\BlockGrowEvent;
 use pocketmine\event\entity\EntityDamageByBlockEvent;
@@ -42,9 +41,7 @@ class Cactus extends Transparent{
 
 	protected int $age = 0;
 
-	public function getRequiredStateDataBits() : int{ return 4; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->boundedInt(4, 0, self::MAX_AGE, $this->age);
 	}
 
@@ -82,7 +79,7 @@ class Cactus extends Transparent{
 	}
 
 	private function canBeSupportedBy(Block $block) : bool{
-		return $block->isSameType($this) || $block->hasTypeTag(BlockTypeTags::SAND);
+		return $block->hasSameTypeId($this) || $block->hasTypeTag(BlockTypeTags::SAND);
 	}
 
 	public function onNearbyBlockChange() : void{
@@ -105,7 +102,7 @@ class Cactus extends Transparent{
 	}
 
 	public function onRandomTick() : void{
-		if(!$this->getSide(Facing::DOWN)->isSameType($this)){
+		if(!$this->getSide(Facing::DOWN)->hasSameTypeId($this)){
 			$world = $this->position->getWorld();
 			if($this->age === self::MAX_AGE){
 				for($y = 1; $y < 3; ++$y){

src/block/Cake.php

@@ -23,8 +23,7 @@ declare(strict_types=1);
 
 namespace pocketmine\block;
 
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\item\Item;
 use pocketmine\item\ItemBlock;
 use pocketmine\math\AxisAlignedBB;
@@ -37,9 +36,7 @@ class Cake extends BaseCake{
 
 	protected int $bites = 0;
 
-	public function getRequiredStateDataBits() : int{ return 3; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->boundedInt(3, 0, self::MAX_BITES, $this->bites);
 	}
 

src/block/Candle.php

@@ -24,8 +24,8 @@ declare(strict_types=1);
 namespace pocketmine\block;
 
 use pocketmine\block\utils\CandleTrait;
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\block\utils\SupportType;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\item\Item;
 use pocketmine\math\Axis;
 use pocketmine\math\AxisAlignedBB;
@@ -37,7 +37,7 @@ use pocketmine\world\BlockTransaction;
 
 class Candle extends Transparent{
 	use CandleTrait {
-		describeState as encodeLitState;
+		describeBlockOnlyState as encodeLitState;
 		getLightLevel as getBaseLightLevel;
 	}
 
@@ -46,11 +46,7 @@ class Candle extends Transparent{
 
 	private int $count = self::MIN_COUNT;
 
-	public function getRequiredStateDataBits() : int{
-		return 3;
-	}
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$this->encodeLitState($w);
 		$w->boundedInt(2, self::MIN_COUNT, self::MAX_COUNT, $this->count);
 	}
@@ -94,8 +90,12 @@ class Candle extends Transparent{
 		];
 	}
 
+	public function getSupportType(int $facing) : SupportType{
+		return SupportType::NONE();
+	}
+
 	protected function getCandleIfCompatibleType(Block $block) : ?Candle{
-		return $block instanceof Candle && $block->isSameType($this) ? $block : null;
+		return $block instanceof Candle && $block->hasSameTypeId($this) ? $block : null;
 	}
 
 	public function canBePlacedAt(Block $blockReplace, Vector3 $clickVector, int $face, bool $isClickedBlock) : bool{

src/block/CaveVines.php

@@ -0,0 +1,191 @@
+<?php
+
+/*
+ *
+ *  ____            _        _   __  __ _                  __  __ ____
+ * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
+ * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
+ * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
+ * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * @author PocketMine Team
+ * @link http://www.pocketmine.net/
+ *
+ *
+ */
+
+declare(strict_types=1);
+
+namespace pocketmine\block;
+
+use pocketmine\block\utils\SupportType;
+use pocketmine\data\runtime\RuntimeDataDescriber;
+use pocketmine\entity\Entity;
+use pocketmine\event\block\BlockGrowEvent;
+use pocketmine\item\Fertilizer;
+use pocketmine\item\Item;
+use pocketmine\item\VanillaItems;
+use pocketmine\math\Facing;
+use pocketmine\math\Vector3;
+use pocketmine\player\Player;
+use pocketmine\world\BlockTransaction;
+use pocketmine\world\sound\GlowBerriesPickSound;
+use function mt_rand;
+
+class CaveVines extends Flowable{
+	public const MAX_AGE = 25;
+
+	protected int $age = 0;
+	protected bool $berries = false;
+	protected bool $head = false;
+
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
+		$w->boundedInt(5, 0, self::MAX_AGE, $this->age);
+		$w->bool($this->berries);
+		$w->bool($this->head);
+	}
+
+	public function hasBerries() : bool{ return $this->berries; }
+
+	/** @return $this */
+	public function setBerries(bool $berries) : self{
+		$this->berries = $berries;
+		return $this;
+	}
+
+	public function isHead() : bool{ return $this->head; }
+
+	/** @return $this */
+	public function setHead(bool $head) : self{
+		$this->head = $head;
+		return $this;
+	}
+
+	public function getAge() : int{
+		return $this->age;
+	}
+
+	/** @return $this */
+	public function setAge(int $age) : self{
+		if($age < 0 || $age > self::MAX_AGE){
+			throw new \InvalidArgumentException("Age must be in range 0-" . self::MAX_AGE);
+		}
+		$this->age = $age;
+		return $this;
+	}
+
+	public function canClimb() : bool{
+		return true;
+	}
+
+	public function getLightLevel() : int{
+		return $this->berries ? 14 : 0;
+	}
+
+	private function canBeSupportedBy(Block $block) : bool{
+		return $block->getSupportType(Facing::DOWN)->equals(SupportType::FULL()) || $block->hasSameTypeId($this);
+	}
+
+	public function onNearbyBlockChange() : void{
+		if(!$this->canBeSupportedBy($this->getSide(Facing::UP))){
+			$this->position->getWorld()->useBreakOn($this->position);
+		}
+	}
+
+	public function place(BlockTransaction $tx, Item $item, Block $blockReplace, Block $blockClicked, int $face, Vector3 $clickVector, ?Player $player = null) : bool{
+		if(!$this->canBeSupportedBy($blockReplace->getSide(Facing::UP))){
+			return false;
+		}
+		$this->age = mt_rand(0, self::MAX_AGE);
+		return parent::place($tx, $item, $blockReplace, $blockClicked, $face, $clickVector, $player);
+	}
+
+	public function onInteract(Item $item, int $face, Vector3 $clickVector, ?Player $player = null, array &$returnedItems = []) : bool{
+		if($this->berries){
+			$this->position->getWorld()->dropItem($this->position, $this->asItem());
+			$this->position->getWorld()->addSound($this->position, new GlowBerriesPickSound());
+
+			$this->position->getWorld()->setBlock($this->position, $this->setBerries(false));
+			return true;
+		}
+		if($item instanceof Fertilizer){
+			$ev = new BlockGrowEvent($this, (clone $this)
+				->setBerries(true)
+				->setHead(!$this->getSide(Facing::DOWN)->hasSameTypeId($this))
+			);
+			$ev->call();
+			if($ev->isCancelled()){
+				return false;
+			}
+			$item->pop();
+			$this->position->getWorld()->setBlock($this->position, $ev->getNewState());
+			return true;
+		}
+		return false;
+	}
+
+	public function onRandomTick() : void{
+		$head = !$this->getSide(Facing::DOWN)->hasSameTypeId($this);
+		if($head !== $this->head){
+			$this->position->getWorld()->setBlock($this->position, $this->setHead($head));
+		}
+
+		if($this->age < self::MAX_AGE && mt_rand(1, 10) === 1){
+			$growthPos = $this->position->getSide(Facing::DOWN);
+			$world = $growthPos->getWorld();
+			if($world->isInWorld($growthPos->getFloorX(), $growthPos->getFloorY(), $growthPos->getFloorZ())){
+				$block = $world->getBlock($growthPos);
+				if($block->getTypeId() === BlockTypeIds::AIR){
+					$ev = new BlockGrowEvent($block, VanillaBlocks::CAVE_VINES()
+						->setAge($this->age + 1)
+						->setBerries(mt_rand(1, 9) === 1)
+					);
+
+					$ev->call();
+
+					if(!$ev->isCancelled()){
+						$world->setBlock($growthPos, $ev->getNewState());
+					}
+				}
+			}
+		}
+	}
+
+	public function ticksRandomly() : bool{
+		return true;
+	}
+
+	protected function recalculateCollisionBoxes() : array{
+		return [];
+	}
+
+	public function hasEntityCollision() : bool{
+		return true;
+	}
+
+	public function onEntityInside(Entity $entity) : bool{
+		$entity->resetFallDistance();
+		return false;
+	}
+
+	public function getDropsForCompatibleTool(Item $item) : array{
+		return $this->berries ? [$this->asItem()] : [];
+	}
+
+	public function isAffectedBySilkTouch() : bool{
+		return true;
+	}
+
+	public function asItem() : Item{
+		return VanillaItems::GLOW_BERRIES();
+	}
+
+	public function getSupportType(int $facing) : SupportType{
+		return SupportType::NONE();
+	}
+}

src/block/Chain.php

@@ -0,0 +1,48 @@
+<?php
+
+/*
+ *
+ *  ____            _        _   __  __ _                  __  __ ____
+ * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
+ * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
+ * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
+ * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * @author PocketMine Team
+ * @link http://www.pocketmine.net/
+ *
+ *
+ */
+
+declare(strict_types=1);
+
+namespace pocketmine\block;
+
+use pocketmine\block\utils\PillarRotationTrait;
+use pocketmine\block\utils\SupportType;
+use pocketmine\math\Axis;
+use pocketmine\math\AxisAlignedBB;
+use pocketmine\math\Facing;
+
+final class Chain extends Transparent{
+	use PillarRotationTrait;
+
+	public function getSupportType(int $facing) : SupportType{
+		return $this->axis === Axis::Y && Facing::axis($facing) === Axis::Y ? SupportType::CENTER() : SupportType::NONE();
+	}
+
+	protected function recalculateCollisionBoxes() : array{
+		$bb = AxisAlignedBB::one();
+		foreach([Axis::Y, Axis::Z, Axis::X] as $axis){
+			if($axis !== $this->axis){
+				$bb->squash($axis, 13 / 32);
+			}
+		}
+		return [$bb];
+	}
+}

src/block/Chest.php

@@ -57,13 +57,13 @@ class Chest extends Transparent{
 			foreach([false, true] as $clockwise){
 				$side = Facing::rotateY($this->facing, $clockwise);
 				$c = $this->getSide($side);
-				if($c instanceof Chest && $c->isSameType($this) && $c->facing === $this->facing){
+				if($c instanceof Chest && $c->hasSameTypeId($this) && $c->facing === $this->facing){
 					$pair = $world->getTile($c->position);
 					if($pair instanceof TileChest && !$pair->isPaired()){
 						[$left, $right] = $clockwise ? [$c, $this] : [$this, $c];
 						$ev = new ChestPairEvent($left, $right);
 						$ev->call();
-						if(!$ev->isCancelled() && $world->getBlock($this->position)->isSameType($this) && $world->getBlock($c->position)->isSameType($c)){
+						if(!$ev->isCancelled() && $world->getBlock($this->position)->hasSameTypeId($this) && $world->getBlock($c->position)->hasSameTypeId($c)){
 							$pair->pairWith($tile);
 							$tile->pairWith($pair);
 							break;

src/block/ChorusFlower.php

@@ -23,8 +23,7 @@ declare(strict_types=1);
 
 namespace pocketmine\block;
 
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\entity\projectile\Projectile;
 use pocketmine\event\block\StructureGrowEvent;
 use pocketmine\item\Item;
@@ -50,9 +49,7 @@ final class ChorusFlower extends Flowable{
 
 	private int $age = self::MIN_AGE;
 
-	public function getRequiredStateDataBits() : int{ return 3; }
-
-	protected function describeState(RuntimeDataWriter|RuntimeDataReader $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->boundedInt(3, self::MIN_AGE, self::MAX_AGE, $this->age);
 	}
 

src/block/ChorusPlant.php

@@ -40,7 +40,7 @@ final class ChorusPlant extends Flowable{
 		$bb = AxisAlignedBB::one();
 		foreach($this->getAllSides() as $facing => $block){
 			$id = $block->getTypeId();
-			if($id !== BlockTypeIds::END_STONE && $id !== BlockTypeIds::CHORUS_FLOWER && !$block->isSameType($this)){
+			if($id !== BlockTypeIds::END_STONE && $id !== BlockTypeIds::CHORUS_FLOWER && !$block->hasSameTypeId($this)){
 				$bb->trim($facing, 2 / 16);
 			}
 		}
@@ -49,7 +49,7 @@ final class ChorusPlant extends Flowable{
 	}
 
 	private function canBeSupportedBy(Block $block) : bool{
-		return $block->isSameType($this) || $block->getTypeId() === BlockTypeIds::END_STONE;
+		return $block->hasSameTypeId($this) || $block->getTypeId() === BlockTypeIds::END_STONE;
 	}
 
 	private function canStay(Position $position) : bool{

src/block/CocoaBlock.php

@@ -26,8 +26,7 @@ namespace pocketmine\block;
 use pocketmine\block\utils\HorizontalFacingTrait;
 use pocketmine\block\utils\SupportType;
 use pocketmine\block\utils\WoodType;
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\event\block\BlockGrowEvent;
 use pocketmine\item\Fertilizer;
 use pocketmine\item\Item;
@@ -47,9 +46,7 @@ class CocoaBlock extends Transparent{
 
 	protected int $age = 0;
 
-	public function getRequiredStateDataBits() : int{ return 4; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->horizontalFacing($this->facing);
 		$w->boundedInt(2, 0, self::MAX_AGE, $this->age);
 	}
@@ -97,7 +94,7 @@ class CocoaBlock extends Transparent{
 	}
 
 	public function onInteract(Item $item, int $face, Vector3 $clickVector, ?Player $player = null, array &$returnedItems = []) : bool{
-		if($item instanceof Fertilizer && $this->grow()){
+		if($item instanceof Fertilizer && $this->grow($player)){
 			$item->pop();
 
 			return true;
@@ -122,11 +119,11 @@ class CocoaBlock extends Transparent{
 		}
 	}
 
-	private function grow() : bool{
+	private function grow(?Player $player = null) : bool{
 		if($this->age < self::MAX_AGE){
 			$block = clone $this;
 			$block->age++;
-			$ev = new BlockGrowEvent($this, $block);
+			$ev = new BlockGrowEvent($this, $block, $player);
 			$ev->call();
 			if(!$ev->isCancelled()){
 				$this->position->getWorld()->setBlock($this->position, $ev->getNewState());

src/block/ConcretePowder.php

@@ -54,7 +54,7 @@ class ConcretePowder extends Opaque implements Fallable{
 	}
 
 	public function tickFalling() : ?Block{
-		if ($this->getAdjacentWater() === null) {
+		if($this->getAdjacentWater() === null){
 			return null;
 		}
 		return VanillaBlocks::CONCRETE()->setColor($this->color);

src/block/CoralBlock.php

@@ -25,6 +25,7 @@ namespace pocketmine\block;
 
 use pocketmine\block\utils\CoralType;
 use pocketmine\block\utils\CoralTypeTrait;
+use pocketmine\event\block\BlockDeathEvent;
 use pocketmine\item\Item;
 use function mt_rand;
 
@@ -54,7 +55,11 @@ final class CoralBlock extends Opaque{
 				}
 			}
 			if(!$hasWater){
-				$world->setBlock($this->position, $this->setDead(true));
+				$ev = new BlockDeathEvent($this, $this->setDead(true));
+				$ev->call();
+				if(!$ev->isCancelled()){
+					$world->setBlock($this->position, $ev->getNewState());
+				}
 			}
 		}
 	}

src/block/Crops.php

@@ -23,8 +23,7 @@ declare(strict_types=1);
 
 namespace pocketmine\block;
 
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\event\block\BlockGrowEvent;
 use pocketmine\item\Fertilizer;
 use pocketmine\item\Item;
@@ -39,9 +38,7 @@ abstract class Crops extends Flowable{
 
 	protected int $age = 0;
 
-	public function getRequiredStateDataBits() : int{ return 3; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->boundedInt(3, 0, self::MAX_AGE, $this->age);
 	}
 
@@ -72,7 +69,7 @@ abstract class Crops extends Flowable{
 				$block->age = self::MAX_AGE;
 			}
 
-			$ev = new BlockGrowEvent($this, $block);
+			$ev = new BlockGrowEvent($this, $block, $player);
 			$ev->call();
 			if(!$ev->isCancelled()){
 				$this->position->getWorld()->setBlock($this->position, $ev->getNewState());

src/block/DaylightSensor.php

@@ -25,8 +25,7 @@ namespace pocketmine\block;
 
 use pocketmine\block\utils\AnalogRedstoneSignalEmitterTrait;
 use pocketmine\block\utils\SupportType;
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\item\Item;
 use pocketmine\math\AxisAlignedBB;
 use pocketmine\math\Facing;
@@ -42,9 +41,7 @@ class DaylightSensor extends Transparent{
 
 	protected bool $inverted = false;
 
-	public function getRequiredStateDataBits() : int{ return 5; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->boundedInt(4, 0, 15, $this->signalStrength);
 		$w->bool($this->inverted);
 	}

src/block/DetectorRail.php

@@ -23,16 +23,13 @@ declare(strict_types=1);
 
 namespace pocketmine\block;
 
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 
 class DetectorRail extends StraightOnlyRail{
 	protected bool $activated = false;
 
-	public function getRequiredStateDataBits() : int{ return 4; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
-		parent::describeState($w);
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
+		parent::describeBlockOnlyState($w);
 		$w->bool($this->activated);
 	}
 

src/block/Dirt.php

@@ -24,8 +24,7 @@ declare(strict_types=1);
 namespace pocketmine\block;
 
 use pocketmine\block\utils\DirtType;
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\item\Fertilizer;
 use pocketmine\item\Hoe;
 use pocketmine\item\Item;
@@ -46,9 +45,7 @@ class Dirt extends Opaque{
 		parent::__construct($idInfo, $name, $typeInfo);
 	}
 
-	public function getRequiredTypeDataBits() : int{ return 2; }
-
-	protected function describeType(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	public function describeBlockItemState(RuntimeDataDescriber $w) : void{
 		$w->dirtType($this->dirtType);
 	}
 

src/block/Door.php

@@ -25,8 +25,7 @@ namespace pocketmine\block;
 
 use pocketmine\block\utils\HorizontalFacingTrait;
 use pocketmine\block\utils\SupportType;
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\item\Item;
 use pocketmine\math\AxisAlignedBB;
 use pocketmine\math\Facing;
@@ -42,9 +41,7 @@ class Door extends Transparent{
 	protected bool $hingeRight = false;
 	protected bool $open = false;
 
-	public function getRequiredStateDataBits() : int{ return 5; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->horizontalFacing($this->facing);
 		$w->bool($this->top);
 		$w->bool($this->hingeRight);
@@ -56,7 +53,7 @@ class Door extends Transparent{
 
 		//copy door properties from other half
 		$other = $this->getSide($this->top ? Facing::DOWN : Facing::UP);
-		if($other instanceof Door && $other->isSameType($this)){
+		if($other instanceof Door && $other->hasSameTypeId($this)){
 			if($this->top){
 				$this->facing = $other->facing;
 				$this->open = $other->open;
@@ -129,7 +126,7 @@ class Door extends Transparent{
 			$next = $this->getSide(Facing::rotateY($this->facing, false));
 			$next2 = $this->getSide(Facing::rotateY($this->facing, true));
 
-			if($next->isSameType($this) || (!$next2->isTransparent() && $next->isTransparent())){ //Door hinge
+			if($next->hasSameTypeId($this) || (!$next2->isTransparent() && $next->isTransparent())){ //Door hinge
 				$this->hingeRight = true;
 			}
 
@@ -148,7 +145,7 @@ class Door extends Transparent{
 
 		$other = $this->getSide($this->top ? Facing::DOWN : Facing::UP);
 		$world = $this->position->getWorld();
-		if($other instanceof Door && $other->isSameType($this)){
+		if($other instanceof Door && $other->hasSameTypeId($this)){
 			$other->open = $this->open;
 			$world->setBlock($other->position, $other);
 		}
@@ -169,7 +166,7 @@ class Door extends Transparent{
 
 	public function getAffectedBlocks() : array{
 		$other = $this->getSide($this->top ? Facing::DOWN : Facing::UP);
-		if($other->isSameType($this)){
+		if($other->hasSameTypeId($this)){
 			return [$this, $other];
 		}
 		return parent::getAffectedBlocks();

src/block/DoublePlant.php

@@ -23,8 +23,7 @@ declare(strict_types=1);
 
 namespace pocketmine\block;
 
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\item\Item;
 use pocketmine\math\Facing;
 use pocketmine\math\Vector3;
@@ -34,9 +33,7 @@ use pocketmine\world\BlockTransaction;
 class DoublePlant extends Flowable{
 	protected bool $top = false;
 
-	public function getRequiredStateDataBits() : int{ return 1; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->bool($this->top);
 	}
 
@@ -68,7 +65,7 @@ class DoublePlant extends Flowable{
 
 		return (
 			$other instanceof DoublePlant &&
-			$other->isSameType($this) &&
+			$other->hasSameTypeId($this) &&
 			$other->top !== $this->top
 		);
 	}

src/block/DragonEgg.php

@@ -44,10 +44,6 @@ class DragonEgg extends Transparent implements Fallable{
 		return 1;
 	}
 
-	public function tickFalling() : ?Block{
-		return null;
-	}
-
 	public function onInteract(Item $item, int $face, Vector3 $clickVector, ?Player $player = null, array &$returnedItems = []) : bool{
 		$this->teleport();
 		return true;

src/block/EndPortalFrame.php

@@ -25,8 +25,7 @@ namespace pocketmine\block;
 
 use pocketmine\block\utils\FacesOppositePlacingPlayerTrait;
 use pocketmine\block\utils\HorizontalFacingTrait;
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\math\AxisAlignedBB;
 use pocketmine\math\Facing;
 
@@ -36,9 +35,7 @@ class EndPortalFrame extends Opaque{
 
 	protected bool $eye = false;
 
-	public function getRequiredStateDataBits() : int{ return 3; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->horizontalFacing($this->facing);
 		$w->bool($this->eye);
 	}

src/block/Farmland.php

@@ -23,8 +23,7 @@ declare(strict_types=1);
 
 namespace pocketmine\block;
 
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\entity\Entity;
 use pocketmine\entity\Living;
 use pocketmine\event\entity\EntityTrampleFarmlandEvent;
@@ -38,9 +37,7 @@ class Farmland extends Transparent{
 
 	protected int $wetness = 0; //"moisture" blockstate property in PC
 
-	public function getRequiredStateDataBits() : int{ return 3; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->boundedInt(3, 0, self::MAX_WETNESS, $this->wetness);
 	}
 
@@ -59,7 +56,7 @@ class Farmland extends Transparent{
 	 * @return AxisAlignedBB[]
 	 */
 	protected function recalculateCollisionBoxes() : array{
-		return [AxisAlignedBB::one()]; //TODO: this should be trimmed at the top by 1/16, but MCPE currently treats them as a full block (https://bugs.mojang.com/browse/MCPE-12109)
+		return [AxisAlignedBB::one()->trim(Facing::UP, 1 / 16)];
 	}
 
 	public function onNearbyBlockChange() : void{

src/block/FenceGate.php

@@ -26,8 +26,7 @@ namespace pocketmine\block;
 use pocketmine\block\utils\HorizontalFacingTrait;
 use pocketmine\block\utils\SupportType;
 use pocketmine\block\utils\WoodTypeTrait;
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\item\Item;
 use pocketmine\math\AxisAlignedBB;
 use pocketmine\math\Facing;
@@ -43,9 +42,7 @@ class FenceGate extends Transparent{
 	protected bool $open = false;
 	protected bool $inWall = false;
 
-	public function getRequiredStateDataBits() : int{ return 4; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->horizontalFacing($this->facing);
 		$w->bool($this->open);
 		$w->bool($this->inWall);

src/block/FillableCauldron.php

@@ -24,8 +24,7 @@ declare(strict_types=1);
 namespace pocketmine\block;
 
 use pocketmine\block\utils\SupportType;
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\item\Item;
 use pocketmine\math\AxisAlignedBB;
 use pocketmine\math\Facing;
@@ -38,11 +37,7 @@ abstract class FillableCauldron extends Transparent{
 
 	private int $fillLevel = self::MIN_FILL_LEVEL;
 
-	public function getRequiredStateDataBits() : int{
-		return 3;
-	}
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->boundedInt(3, self::MIN_FILL_LEVEL, self::MAX_FILL_LEVEL, $this->fillLevel);
 	}
 

src/block/Fire.php

@@ -23,8 +23,7 @@ declare(strict_types=1);
 
 namespace pocketmine\block;
 
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\event\block\BlockBurnEvent;
 use pocketmine\event\block\BlockSpreadEvent;
 use pocketmine\math\Facing;
@@ -40,9 +39,7 @@ class Fire extends BaseFire{
 
 	protected int $age = 0;
 
-	public function getRequiredStateDataBits() : int{ return 4; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->boundedInt(4, 0, self::MAX_AGE, $this->age);
 	}
 

src/block/FloorCoralFan.php

@@ -23,8 +23,7 @@ declare(strict_types=1);
 
 namespace pocketmine\block;
 
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\item\Item;
 use pocketmine\item\VanillaItems;
 use pocketmine\math\Axis;
@@ -38,9 +37,7 @@ use function rad2deg;
 final class FloorCoralFan extends BaseCoral{
 	private int $axis = Axis::X;
 
-	public function getRequiredStateDataBits() : int{ return parent::getRequiredStateDataBits() + 1; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->horizontalAxis($this->axis);
 	}
 

src/block/Flowable.php

@@ -26,6 +26,10 @@ namespace pocketmine\block;
 use pocketmine\block\utils\SupportType;
 use pocketmine\math\AxisAlignedBB;
 
+/**
+ * "Flowable" blocks are destroyed if water flows into the same space as the block. These blocks usually don't have any
+ * collision boxes, and can't provide support for other blocks.
+ */
 abstract class Flowable extends Transparent{
 
 	public function canBeFlowedInto() : bool{

src/block/Froglight.php

@@ -24,8 +24,7 @@ declare(strict_types=1);
 namespace pocketmine\block;
 
 use pocketmine\block\utils\FroglightType;
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 
 final class Froglight extends SimplePillar{
 
@@ -36,9 +35,7 @@ final class Froglight extends SimplePillar{
 		parent::__construct($idInfo, $name, $typeInfo);
 	}
 
-	public function getRequiredTypeDataBits() : int{ return 2; }
-
-	protected function describeType(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	public function describeBlockItemState(RuntimeDataDescriber $w) : void{
 		$w->froglightType($this->froglightType);
 	}
 

src/block/FrostedIce.php

@@ -23,8 +23,7 @@ declare(strict_types=1);
 
 namespace pocketmine\block;
 
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\event\block\BlockMeltEvent;
 use function mt_rand;
 
@@ -33,9 +32,7 @@ class FrostedIce extends Ice{
 
 	protected int $age = 0;
 
-	public function getRequiredStateDataBits() : int{ return 2; }
-
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->boundedInt(2, 0, self::MAX_AGE, $this->age);
 	}
 

src/block/Furnace.php

@@ -26,8 +26,8 @@ namespace pocketmine\block;
 use pocketmine\block\tile\Furnace as TileFurnace;
 use pocketmine\block\utils\FacesOppositePlacingPlayerTrait;
 use pocketmine\block\utils\HorizontalFacingTrait;
-use pocketmine\data\runtime\RuntimeDataReader;
-use pocketmine\data\runtime\RuntimeDataWriter;
+use pocketmine\crafting\FurnaceType;
+use pocketmine\data\runtime\RuntimeDataDescriber;
 use pocketmine\item\Item;
 use pocketmine\math\Vector3;
 use pocketmine\player\Player;
@@ -37,15 +37,24 @@ class Furnace extends Opaque{
 	use FacesOppositePlacingPlayerTrait;
 	use HorizontalFacingTrait;
 
+	protected FurnaceType $furnaceType;
+
 	protected bool $lit = false;
 
-	public function getRequiredStateDataBits() : int{ return 3; }
+	public function __construct(BlockIdentifier $idInfo, string $name, BlockTypeInfo $typeInfo, FurnaceType $furnaceType){
+		$this->furnaceType = $furnaceType;
+		parent::__construct($idInfo, $name, $typeInfo);
+	}
 
-	protected function describeState(RuntimeDataReader|RuntimeDataWriter $w) : void{
+	protected function describeBlockOnlyState(RuntimeDataDescriber $w) : void{
 		$w->horizontalFacing($this->facing);
 		$w->bool($this->lit);
 	}
 
+	public function getFurnaceType() : FurnaceType{
+		return $this->furnaceType;
+	}
+
 	public function getLightLevel() : int{
 		return $this->lit ? 13 : 0;
 	}

src/block/GrassPath.php

@@ -33,7 +33,7 @@ class GrassPath extends Transparent{
 	 * @return AxisAlignedBB[]
 	 */
 	protected function recalculateCollisionBoxes() : array{
-		return [AxisAlignedBB::one()]; //TODO: this should be trimmed at the top by 1/16, but MCPE currently treats them as a full block (https://bugs.mojang.com/browse/MCPE-12109)
+		return [AxisAlignedBB::one()->trim(Facing::UP, 1 / 16)];
 	}
 
 	public function onNearbyBlockChange() : void{