From f349ce75e4ff0632fee57fad0a9b976b5feed26c Mon Sep 17 00:00:00 2001
From: Sergi del Olmo <Sergittos@users.noreply.github.com>
Date: Thu, 9 Jan 2025 21:13:46 +0100
Subject: [PATCH] Player: add ability to get & set flight speed multiplier
 (#6076)

Since this doesn't directly correspond to flight speed (it's multiplied by different values depending on whether sprinting or not, and possibly other states), "multiplier" was preferred instead of directly calling it flight speed.

Default value is 0.05.
---
 src/network/mcpe/NetworkSession.php |  3 +--
 src/player/Player.php               | 39 +++++++++++++++++++++++++++++
 2 files changed, 40 insertions(+), 2 deletions(-)

diff --git a/src/network/mcpe/NetworkSession.php b/src/network/mcpe/NetworkSession.php
index 511d0dece..fdb63c467 100644
--- a/src/network/mcpe/NetworkSession.php
+++ b/src/network/mcpe/NetworkSession.php
@@ -1058,8 +1058,7 @@ class NetworkSession{
 		];
 
 		$layers = [
-			//TODO: dynamic flying speed! FINALLY!!!!!!!!!!!!!!!!!
-			new AbilitiesLayer(AbilitiesLayer::LAYER_BASE, $boolAbilities, 0.05, 0.1),
+			new AbilitiesLayer(AbilitiesLayer::LAYER_BASE, $boolAbilities, $for->getFlightSpeedMultiplier(), 0.1),
 		];
 		if(!$for->hasBlockCollision()){
 			//TODO: HACK! In 1.19.80, the client starts falling in our faux spectator mode when it clips into a
diff --git a/src/player/Player.php b/src/player/Player.php
index 66ba6f376..1c67b7182 100644
--- a/src/player/Player.php
+++ b/src/player/Player.php
@@ -184,6 +184,8 @@ class Player extends Human implements CommandSender, ChunkListener, IPlayer{
 	private const MAX_REACH_DISTANCE_SURVIVAL = 7;
 	private const MAX_REACH_DISTANCE_ENTITY_INTERACTION = 8;
 
+	public const DEFAULT_FLIGHT_SPEED_MULTIPLIER = 0.05;
+
 	public const TAG_FIRST_PLAYED = "firstPlayed"; //TAG_Long
 	public const TAG_LAST_PLAYED = "lastPlayed"; //TAG_Long
 	private const TAG_GAME_MODE = "playerGameType"; //TAG_Int
@@ -285,6 +287,8 @@ class Player extends Human implements CommandSender, ChunkListener, IPlayer{
 	protected bool $blockCollision = true;
 	protected bool $flying = false;
 
+	protected float $flightSpeedMultiplier = self::DEFAULT_FLIGHT_SPEED_MULTIPLIER;
+
 	/** @phpstan-var positive-int|null  */
 	protected ?int $lineHeight = null;
 	protected string $locale = "en_US";
@@ -518,6 +522,41 @@ class Player extends Human implements CommandSender, ChunkListener, IPlayer{
 		return $this->flying;
 	}
 
+	/**
+	 * Sets the player's flight speed multiplier.
+	 *
+	 * Normal flying speed in blocks-per-tick is (multiplier * 10) blocks per tick.
+	 * When sprint-flying, this is doubled to 20.
+	 *
+	 * If set to zero, the player will not be able to move in the xz plane when flying.
+	 * Negative values will invert the controls.
+	 *
+	 * Note: Movement speed attribute does not influence flight speed.
+	 *
+	 * @see Player::DEFAULT_FLIGHT_SPEED_MULTIPLIER
+	 */
+	public function setFlightSpeedMultiplier(float $flightSpeedMultiplier) : void{
+		if($this->flightSpeedMultiplier !== $flightSpeedMultiplier){
+			$this->flightSpeedMultiplier = $flightSpeedMultiplier;
+			$this->getNetworkSession()->syncAbilities($this);
+		}
+	}
+
+	/**
+	 * Returns the player's flight speed multiplier.
+	 *
+	 * Normal flying speed in blocks-per-tick is (multiplier * 10) blocks per tick.
+	 * When sprint-flying, this is doubled to 20.
+	 *
+	 * If set to zero, the player will not be able to move in the xz plane when flying.
+	 * Negative values will invert the controls.
+	 *
+	 * @see Player::DEFAULT_FLIGHT_SPEED_MULTIPLIER
+	 */
+	public function getFlightSpeedMultiplier() : float{
+		return $this->flightSpeedMultiplier;
+	}
+
 	public function setAutoJump(bool $value) : void{
 		if($this->autoJump !== $value){
 			$this->autoJump = $value;