Add clicked position to PlayerUseUnknownEntityEvent (#9604)

patches/api/Add-PlayerUseUnknownEntityEvent.patch

@@ -3,6 +3,10 @@ From: Jedediah Smith <jedediah@silencegreys.com>
 Date: Sat, 2 Apr 2016 05:08:36 -0400
 Subject: [PATCH] Add PlayerUseUnknownEntityEvent
 
+Adds the PlayerUseUnknownEntityEvent to be used by plugins dealing with
+virtual entities/entities that are not actually known to the server.
+
+Co-authored-by: Nassim Jahnke <nassim@njahnke.dev>
 
 diff --git a/src/main/java/com/destroystokyo/paper/event/player/PlayerUseUnknownEntityEvent.java b/src/main/java/com/destroystokyo/paper/event/player/PlayerUseUnknownEntityEvent.java
 new file mode 100644
@@ -16,43 +20,79 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
 +import org.bukkit.event.HandlerList;
 +import org.bukkit.event.player.PlayerEvent;
 +import org.bukkit.inventory.EquipmentSlot;
++import org.bukkit.util.Vector;
 +import org.jetbrains.annotations.NotNull;
++import org.jetbrains.annotations.Nullable;
 +
++/**
++ * Represents an event that is called when a player right-clicks an unknown entity.
++ * Useful for plugins dealing with virtual entities (entities that don't actually spawned on the server).
++ * <br>
++ * This event may be called multiple times per interaction with different interaction hands
++ * and with or without the clicked position.
++ */
 +public class PlayerUseUnknownEntityEvent extends PlayerEvent {
 +
-+    private static final HandlerList handlers = new HandlerList();
++    private static final HandlerList HANDLERS = new HandlerList();
 +    private final int entityId;
 +    private final boolean attack;
-+    @NotNull private final EquipmentSlot hand;
++    private final @NotNull EquipmentSlot hand;
++    private final @Nullable Vector clickedPosition;
 +
-+    public PlayerUseUnknownEntityEvent(@NotNull Player who, int entityId, boolean attack, @NotNull EquipmentSlot hand) {
++    public PlayerUseUnknownEntityEvent(@NotNull Player who, int entityId, boolean attack, @NotNull EquipmentSlot hand, @Nullable Vector clickedPosition) {
 +        super(who);
 +        this.entityId = entityId;
 +        this.attack = attack;
 +        this.hand = hand;
++        this.clickedPosition = clickedPosition;
 +    }
 +
++    /**
++     * Returns the entity id of the unknown entity that was interacted with.
++     *
++     * @return the entity id of the entity that was interacted with
++     */
 +    public int getEntityId() {
 +        return this.entityId;
 +    }
 +
++    /**
++     * Returns whether the interaction was an attack.
++     *
++     * @return true if the player is attacking the entity, false if the player is interacting with the entity
++     */
 +    public boolean isAttack() {
 +        return this.attack;
 +    }
 +
-+    @NotNull
-+    public EquipmentSlot getHand() {
++    /**
++     * Returns the hand used to perform this interaction.
++     *
++     * @return the hand used to interact
++     */
++    public @NotNull EquipmentSlot getHand() {
 +        return this.hand;
 +    }
 +
++    /**
++     * Returns the position relative to the entity that was clicked, or null if not available.
++     * See {@link org.bukkit.event.player.PlayerInteractAtEntityEvent} for more details.
++     *
++     * @return the position relative to the entity that was clicked, or null if not available
++     * @see org.bukkit.event.player.PlayerInteractAtEntityEvent
++     */
++    public @Nullable Vector getClickedRelativePosition() {
++        return clickedPosition.clone();
++    }
++
 +    @NotNull
 +    @Override
 +    public HandlerList getHandlers() {
-+        return handlers;
++        return HANDLERS;
 +    }
 +
 +    @NotNull
 +    public static HandlerList getHandlerList() {
-+        return handlers;
++        return HANDLERS;
 +    }
 +}

patches/server/Add-PlayerUseUnknownEntityEvent.patch

@@ -3,24 +3,30 @@ From: Jedediah Smith <jedediah@silencegreys.com>
 Date: Sat, 2 Apr 2016 05:09:16 -0400
 Subject: [PATCH] Add PlayerUseUnknownEntityEvent
 
-== AT ==
-public net.minecraft.network.protocol.game.ServerboundInteractPacket$ActionType
+Adds the PlayerUseUnknownEntityEvent to be used by plugins dealing with
+virtual entities/entities that are not actually known to the server.
+
+Co-authored-by: Nassim Jahnke <nassim@njahnke.dev>
 
 diff --git a/src/main/java/net/minecraft/network/protocol/game/ServerboundInteractPacket.java b/src/main/java/net/minecraft/network/protocol/game/ServerboundInteractPacket.java
 index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644
 --- a/src/main/java/net/minecraft/network/protocol/game/ServerboundInteractPacket.java
 +++ b/src/main/java/net/minecraft/network/protocol/game/ServerboundInteractPacket.java
-@@ -0,0 +0,0 @@ import net.minecraft.world.entity.Entity;
- import net.minecraft.world.phys.Vec3;
- 
- public class ServerboundInteractPacket implements Packet<ServerGamePacketListener> {
--    private final int entityId;
--    private final ServerboundInteractPacket.Action action;
-+    private final int entityId; public final int getEntityId() { return this.entityId; } // Paper - add accessor
-+    private final ServerboundInteractPacket.Action action; public final ServerboundInteractPacket.ActionType getActionType() { return this.action.getType(); } // Paper - add accessor
-     private final boolean usingSecondaryAction;
-     static final ServerboundInteractPacket.Action ATTACK_ACTION = new ServerboundInteractPacket.Action() {
-         @Override
+@@ -0,0 +0,0 @@ public class ServerboundInteractPacket implements Packet<ServerGamePacketListene
+             buf.writeEnum(this.hand);
+         }
+     }
++
++    // Paper start - PlayerUseUnknownEntityEvent
++    public int getEntityId() {
++        return this.entityId;
++    }
++
++    public boolean isAttack() {
++        return this.action.getType() == ActionType.ATTACK;
++    }
++    // Paper end - PlayerUseUnknownEntityEvent
+ }
 diff --git a/src/main/java/net/minecraft/server/network/ServerGamePacketListenerImpl.java b/src/main/java/net/minecraft/server/network/ServerGamePacketListenerImpl.java
 index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644
 --- a/src/main/java/net/minecraft/server/network/ServerGamePacketListenerImpl.java
@@ -29,37 +35,38 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
                  });
              }
          }
-+        // Paper start - fire event
++        // Paper start - PlayerUseUnknownEntityEvent
 +        else {
 +            packet.dispatch(new net.minecraft.network.protocol.game.ServerboundInteractPacket.Handler() {
 +                @Override
 +                public void onInteraction(net.minecraft.world.InteractionHand hand) {
-+                    ServerGamePacketListenerImpl.this.callPlayerUseUnknownEntityEvent(packet, hand);
++                    ServerGamePacketListenerImpl.this.callPlayerUseUnknownEntityEvent(packet, hand, null);
 +                }
 +
 +                @Override
 +                public void onInteraction(net.minecraft.world.InteractionHand hand, net.minecraft.world.phys.Vec3 pos) {
-+                    ServerGamePacketListenerImpl.this.callPlayerUseUnknownEntityEvent(packet, hand);
++                    ServerGamePacketListenerImpl.this.callPlayerUseUnknownEntityEvent(packet, hand, pos);
 +                }
 +
 +                @Override
 +                public void onAttack() {
-+                    ServerGamePacketListenerImpl.this.callPlayerUseUnknownEntityEvent(packet, net.minecraft.world.InteractionHand.MAIN_HAND);
++                    ServerGamePacketListenerImpl.this.callPlayerUseUnknownEntityEvent(packet, net.minecraft.world.InteractionHand.MAIN_HAND, null);
 +                }
 +            });
 +        }
 +
 +    }
  
-+    private void callPlayerUseUnknownEntityEvent(ServerboundInteractPacket packet, InteractionHand hand) {
++    private void callPlayerUseUnknownEntityEvent(ServerboundInteractPacket packet, InteractionHand hand, @Nullable net.minecraft.world.phys.Vec3 vector) {
 +        this.cserver.getPluginManager().callEvent(new com.destroystokyo.paper.event.player.PlayerUseUnknownEntityEvent(
 +            this.getCraftPlayer(),
 +            packet.getEntityId(),
-+            packet.getActionType() == ServerboundInteractPacket.ActionType.ATTACK,
-+            hand == InteractionHand.MAIN_HAND ? EquipmentSlot.HAND : EquipmentSlot.OFF_HAND
-+        ));
++            packet.isAttack(),
++            hand == InteractionHand.MAIN_HAND ? EquipmentSlot.HAND : EquipmentSlot.OFF_HAND,
++            vector != null ? new org.bukkit.util.Vector(vector.x, vector.y, vector.z) : null)
++        );
      }
-+    // Paper end
++    // Paper end - PlayerUseUnknownEntityEvent
  
      @Override
      public void handleClientCommand(ServerboundClientCommandPacket packet) {

patches/server/Basic-PlayerProfile-API.patch

@@ -574,11 +574,11 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
 +import com.destroystokyo.paper.profile.CraftPlayerProfile;
 +import com.destroystokyo.paper.profile.PlayerProfile;
  import com.google.common.util.concurrent.ThreadFactoryBuilder;
- import io.papermc.paper.math.Position;
- import com.google.gson.JsonArray;
-@@ -0,0 +0,0 @@ import net.minecraft.world.level.Level;
- import net.minecraft.world.level.chunk.ChunkAccess;
+ import io.papermc.paper.math.BlockPosition;
+ import io.papermc.paper.math.FinePosition;
+@@ -0,0 +0,0 @@ import net.minecraft.world.level.chunk.ChunkAccess;
  import net.minecraft.world.level.chunk.ChunkStatus;
+ import net.minecraft.world.phys.Vec3;
  import org.apache.commons.lang.exception.ExceptionUtils;
 +import com.mojang.authlib.GameProfile;
  import org.bukkit.Location;

patches/server/Catch-JsonParseException-in-Entity-and-TE-names.patch

@@ -16,9 +16,9 @@ diff --git a/src/main/java/io/papermc/paper/util/MCUtil.java b/src/main/java/io/
 index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644
 --- a/src/main/java/io/papermc/paper/util/MCUtil.java
 +++ b/src/main/java/io/papermc/paper/util/MCUtil.java
-@@ -0,0 +0,0 @@ import it.unimi.dsi.fastutil.objects.ReferenceArrayList;
- import net.minecraft.core.BlockPos;
+@@ -0,0 +0,0 @@ import net.minecraft.core.BlockPos;
  import net.minecraft.core.Direction;
+ import net.minecraft.core.Vec3i;
  import net.minecraft.server.MinecraftServer;
 +import net.minecraft.nbt.CompoundTag;
 +import net.minecraft.network.chat.Component;

patches/server/MC-Utils.patch

@@ -3487,17 +3487,21 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
 +package io.papermc.paper.util;
 +
 +import com.google.common.util.concurrent.ThreadFactoryBuilder;
++import io.papermc.paper.math.BlockPosition;
++import io.papermc.paper.math.FinePosition;
 +import io.papermc.paper.math.Position;
 +import it.unimi.dsi.fastutil.objects.ObjectRBTreeSet;
 +import java.lang.ref.Cleaner;
 +import net.minecraft.core.BlockPos;
 +import net.minecraft.core.Direction;
++import net.minecraft.core.Vec3i;
 +import net.minecraft.server.MinecraftServer;
 +import net.minecraft.server.level.ServerLevel;
 +import net.minecraft.world.entity.Entity;
 +import net.minecraft.world.level.ChunkPos;
 +import net.minecraft.world.level.ClipContext;
 +import net.minecraft.world.level.Level;
++import net.minecraft.world.phys.Vec3;
 +import org.apache.commons.lang.exception.ExceptionUtils;
 +import org.bukkit.Location;
 +import org.bukkit.block.BlockFace;
@@ -3960,6 +3964,14 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
 +        return new BlockPos(vec.getBlockX(), vec.getBlockY(), vec.getBlockZ());
 +    }
 +
++    public static FinePosition toPosition(Vec3 vector) {
++        return Position.fine(vector.x, vector.y, vector.z);
++    }
++
++    public static BlockPosition toPosition(Vec3i vector) {
++        return Position.block(vector.getX(), vector.getY(), vector.getZ());
++    }
++
 +    public static boolean isEdgeOfChunk(BlockPos pos) {
 +        final int modX = pos.getX() & 15;
 +        final int modZ = pos.getZ() & 15;

patches/server/Rewrite-chunk-system.patch

@@ -15850,9 +15850,9 @@ diff --git a/src/main/java/io/papermc/paper/util/MCUtil.java b/src/main/java/io/
 index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644
 --- a/src/main/java/io/papermc/paper/util/MCUtil.java
 +++ b/src/main/java/io/papermc/paper/util/MCUtil.java
-@@ -0,0 +0,0 @@ package io.papermc.paper.util;
- 
- import com.google.common.util.concurrent.ThreadFactoryBuilder;
+@@ -0,0 +0,0 @@ import com.google.common.util.concurrent.ThreadFactoryBuilder;
+ import io.papermc.paper.math.BlockPosition;
+ import io.papermc.paper.math.FinePosition;
  import io.papermc.paper.math.Position;
 +import com.google.gson.JsonArray;
 +import com.google.gson.JsonObject;
@@ -15864,6 +15864,7 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
 +import it.unimi.dsi.fastutil.objects.ReferenceArrayList;
  import net.minecraft.core.BlockPos;
  import net.minecraft.core.Direction;
+ import net.minecraft.core.Vec3i;
  import net.minecraft.server.MinecraftServer;
 +import net.minecraft.server.level.ChunkHolder;
 +import net.minecraft.server.level.ChunkMap;
@@ -15877,9 +15878,9 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
  import net.minecraft.world.level.Level;
 +import net.minecraft.world.level.chunk.ChunkAccess;
 +import net.minecraft.world.level.chunk.ChunkStatus;
+ import net.minecraft.world.phys.Vec3;
  import org.apache.commons.lang.exception.ExceptionUtils;
  import org.bukkit.Location;
- import org.bukkit.block.BlockFace;
 @@ -0,0 +0,0 @@ import org.spigotmc.AsyncCatcher;
  
  import javax.annotation.Nonnull;