Improve firework boosting (#5658)

* Better fireworks boosting parity.

* Requested changes.

core/src/main/java/org/geysermc/geyser/entity/type/FireworkEntity.java

@@ -26,7 +26,9 @@
 package org.geysermc.geyser.entity.type;
 
 import org.cloudburstmc.math.vector.Vector3f;
+import org.cloudburstmc.protocol.bedrock.data.MovementEffectType;
 import org.cloudburstmc.protocol.bedrock.data.entity.EntityDataTypes;
+import org.cloudburstmc.protocol.bedrock.packet.MovementEffectPacket;
 import org.geysermc.geyser.entity.EntityDefinition;
 import org.geysermc.geyser.item.Items;
 import org.geysermc.geyser.item.TooltipOptions;
@@ -41,6 +43,8 @@ import java.util.UUID;
 
 public class FireworkEntity extends Entity {
 
+    private boolean attachedToSession;
+
     public FireworkEntity(GeyserSession session, int entityId, long geyserId, UUID uuid, EntityDefinition<?> definition, Vector3f position, Vector3f motion, float yaw, float pitch, float headYaw) {
         super(session, entityId, geyserId, uuid, definition, position, motion, yaw, pitch, headYaw);
     }
@@ -65,27 +69,49 @@ public class FireworkEntity extends Entity {
     }
 
     public void setPlayerGliding(EntityMetadata<OptionalInt, ?> entityMetadata) {
+        session.getAttachedFireworkRockets().remove(this.geyserId);
+
         OptionalInt optional = entityMetadata.getValue();
-        // Checks if the firework has an entity ID (used when a player is gliding)
-        // and checks to make sure the player that is gliding is the one getting sent the packet
-        // or else every player near the gliding player will boost too.
         if (optional.isPresent() && optional.getAsInt() == session.getPlayerEntity().getEntityId()) {
-            // TODO Firework rocket boosting is client side. Sending this boost is no longer needed
+            // If we don't send this, the bedrock client will always stop boosting after 20 ticks
-            // Good luck to whoever is going to try implementing cancelling firework rocket boosting :)
+            // However this is not the case for Java as the player will stop boosting after entity despawn.
-//            PlayerEntity entity = session.getPlayerEntity();
+            // So we let player boost "infinitely" and then only stop them when the entity despawn.
-//            float yaw = entity.getYaw();
+            // Also doing this allow player to boost simply by having a fireworks rocket attached to them
-//            float pitch = entity.getPitch();
+            // and not necessary have to use a rocket (as some plugin do this to boost player)
-//            // Uses math from NukkitX
+            sendElytraBoost(Integer.MAX_VALUE);
-//            entity.setMotion(Vector3f.from(
+            this.attachedToSession = true;
-//                    -Math.sin(Math.toRadians(yaw)) * Math.cos(Math.toRadians(pitch)) * 2,
+
-//                    -Math.sin(Math.toRadians(pitch)) * 2,
+            // We need to keep track of the fireworks rockets.
-//                    Math.cos(Math.toRadians(yaw)) * Math.cos(Math.toRadians(pitch)) * 2));
+            session.getAttachedFireworkRockets().add(this.getGeyserId());
-//            // Need to update the EntityMotionPacket or else the player won't boost
+        } else {
-//            SetEntityMotionPacket entityMotionPacket = new SetEntityMotionPacket();
+            // Also ensure player stop boosting in cases like metadata changes.
-//            entityMotionPacket.setRuntimeEntityId(entity.getGeyserId());
+            if (this.attachedToSession && session.getAttachedFireworkRockets().isEmpty()) {
-//            entityMotionPacket.setMotion(entity.getMotion());
+                sendElytraBoost(0);
-//
+                this.attachedToSession = false;
-//            session.sendUpstreamPacket(entityMotionPacket);
             }
         }
+    }
+
+    @Override
+    public void despawnEntity() {
+        session.getAttachedFireworkRockets().remove(this.geyserId);
+        // We have to ensure that these fireworks is attached to entity and this is the only one that is attached to the player.
+        // Else player will stop boosting even if the fireworks is not attached to them or there is a fireworks that is boosting them
+        // and not just this one.
+        if (this.attachedToSession && session.getAttachedFireworkRockets().isEmpty()) {
+            // Since we send an effect packet for player to boost "infinitely", we have to stop them when the entity despawn.
+            sendElytraBoost(0);
+            this.attachedToSession = false;
+        }
+
+        super.despawnEntity();
+    }
+
+    private void sendElytraBoost(int duration) {
+        MovementEffectPacket movementEffect = new MovementEffectPacket();
+        movementEffect.setDuration(duration);
+        movementEffect.setEffectType(MovementEffectType.GLIDE_BOOST);
+        movementEffect.setEntityRuntimeId(session.getPlayerEntity().getGeyserId());
+        session.sendUpstreamPacket(movementEffect);
+    }
 }

core/src/main/java/org/geysermc/geyser/session/GeyserSession.java

@@ -235,6 +235,7 @@ import java.util.Map;
 import java.util.Queue;
 import java.util.Set;
 import java.util.UUID;
+import java.util.concurrent.CopyOnWriteArrayList;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.CompletionException;
 import java.util.concurrent.ConcurrentLinkedQueue;
@@ -594,6 +595,12 @@ public class GeyserSession implements GeyserConnection, GeyserCommandSource {
     @Setter
     private int lastAirHitTick;
 
+    /**
+     * Keep track of fireworks rockets that are attached to the player.
+     * Used to keep track of attached fireworks rocket and improve fireworks rocket boosting parity.
+     */
+    private final List<Long> attachedFireworkRockets = new CopyOnWriteArrayList<>();
+
     /**
      * Controls whether the daylight cycle gamerule has been sent to the client, so the sun/moon remain motionless.
      */