feat: add a placeholder to provide the absolute plot's x/y

Cancelling the ProjectileHitEvent will not cover for thrown eggs spawning chickens due to how Bukkit has these events structured. The provided patch calls the same code used for normal projectiles in the specialized egg event to prevent unwanted chickens from spawning on other plots.

Signed-off-by: FlorianMichael <florian.michael07@gmail.com>

Bukkit/src/main/java/com/plotsquared/bukkit/listener/ProjectileEventListener.java

@@ -47,6 +47,7 @@ import org.bukkit.event.entity.LingeringPotionSplashEvent;
 import org.bukkit.event.entity.PotionSplashEvent;
 import org.bukkit.event.entity.ProjectileHitEvent;
 import org.bukkit.event.entity.ProjectileLaunchEvent;
+import org.bukkit.event.player.PlayerEggThrowEvent;
 import org.bukkit.projectiles.BlockProjectileSource;
 import org.bukkit.projectiles.ProjectileSource;
 import org.checkerframework.checker.nullness.qual.NonNull;
@@ -157,14 +158,26 @@ public class ProjectileEventListener implements Listener {
 
     @EventHandler
     public void onProjectileHit(ProjectileHitEvent event) {
-        Projectile entity = event.getEntity();
+        if (cancelProjectileHit(event.getEntity())) {
+            event.setCancelled(true);
+        }
+    }
+
+    @EventHandler
+    public void onPlayerEggThrow(PlayerEggThrowEvent event) {
+        if (cancelProjectileHit(event.getEgg())) {
+            event.setHatching(false);
+        }
+    }
+
+    private boolean cancelProjectileHit(Projectile entity) {
         Location location = BukkitUtil.adapt(entity.getLocation());
         if (!this.plotAreaManager.hasPlotArea(location.getWorldName())) {
-            return;
+            return false;
         }
         PlotArea area = location.getPlotArea();
         if (area == null) {
-            return;
+            return false;
         }
         Plot plot = area.getPlot(location);
         ProjectileSource shooter = entity.getShooter();
@@ -172,15 +185,14 @@ public class ProjectileEventListener implements Listener {
             if (!((Player) shooter).isOnline()) {
                 if (plot != null) {
                     if (plot.isAdded(((Player) shooter).getUniqueId()) || plot.getFlag(ProjectilesFlag.class)) {
-                        return;
+                        return false;
                     }
                 } else if (PlotFlagUtil.isAreaRoadFlagsAndFlagEquals(area, ProjectilesFlag.class, true)) {
-                    return;
+                    return false;
                 }
 
                 entity.remove();
-                event.setCancelled(true);
-                return;
+                return true;
             }
 
             PlotPlayer<?> pp = BukkitUtil.adapt((Player) shooter);
@@ -189,38 +201,36 @@ public class ProjectileEventListener implements Listener {
                         Permission.PERMISSION_ADMIN_PROJECTILE_UNOWNED
                 )) {
                     entity.remove();
-                    event.setCancelled(true);
+                    return true;
                 }
-                return;
+                return false;
             }
             if (plot.isAdded(pp.getUUID()) || pp.hasPermission(Permission.PERMISSION_ADMIN_PROJECTILE_OTHER) || plot.getFlag(
                     ProjectilesFlag.class) || (entity instanceof FishHook && plot.getFlag(
                     FishingFlag.class))) {
-                return;
+                return false;
             }
             entity.remove();
-            event.setCancelled(true);
-            return;
+            return true;
         }
         if (!(shooter instanceof Entity) && shooter != null) {
             if (plot == null) {
                 entity.remove();
-                event.setCancelled(true);
-                return;
+                return true;
             }
             Location sLoc =
                     BukkitUtil.adapt(((BlockProjectileSource) shooter).getBlock().getLocation());
             if (!area.contains(sLoc.getX(), sLoc.getZ())) {
                 entity.remove();
-                event.setCancelled(true);
-                return;
+                return true;
             }
             Plot sPlot = area.getOwnedPlotAbs(sLoc);
             if (sPlot == null || !PlotHandler.sameOwners(plot, sPlot)) {
                 entity.remove();
-                event.setCancelled(true);
+                return true;
             }
         }
+        return false;
     }
 
 }

Core/src/main/java/com/plotsquared/core/util/placeholders/PlaceholderRegistry.java

@@ -204,6 +204,9 @@ public final class PlaceholderRegistry {
         this.createPlaceholder("currentplot_x", (player, plot) -> Integer.toString(plot.getId().getX()));
         this.createPlaceholder("currentplot_y", (player, plot) -> Integer.toString(plot.getId().getY()));
         this.createPlaceholder("currentplot_xy", (player, plot) -> plot.getId().toString());
+        this.createPlaceholder("currentplot_abs_x", (player, plot) -> Integer.toString(plot.getId().getX()), true);
+        this.createPlaceholder("currentplot_abs_y", (player, plot) -> Integer.toString(plot.getId().getY()), true);
+        this.createPlaceholder("currentplot_abs_xy", (player, plot) -> plot.getId().toString(), true);
         this.createPlaceholder("currentplot_rating", (player, plot) -> {
             if (Double.isNaN(plot.getAverageRating())) {
                 return legacyComponent(TranslatableCaption.of("placeholder.nan"), player);
@@ -253,7 +256,23 @@ public final class PlaceholderRegistry {
             final @NonNull String key,
             final @NonNull BiFunction<PlotPlayer<?>, Plot, String> placeholderFunction
     ) {
-        this.registerPlaceholder(new PlotSpecificPlaceholder(key) {
+        this.createPlaceholder(key, placeholderFunction, false);
+    }
+
+    /**
+     * Create a functional placeholder
+     *
+     * @param key                 Placeholder key
+     * @param placeholderFunction Placeholder generator. Cannot return null
+     * @param requireAbsolute     If the plot given to the placeholder should be the absolute (not base) plot
+     * @since TODO
+     */
+    public void createPlaceholder(
+            final @NonNull String key,
+            final @NonNull BiFunction<PlotPlayer<?>, Plot, String> placeholderFunction,
+            final boolean requireAbsolute
+    ) {
+        this.registerPlaceholder(new PlotSpecificPlaceholder(key, requireAbsolute) {
             @Override
             public @NonNull String getValue(final @NonNull PlotPlayer<?> player, final @NonNull Plot plot) {
                 return placeholderFunction.apply(player, plot);

Core/src/main/java/com/plotsquared/core/util/placeholders/PlotSpecificPlaceholder.java

@@ -27,14 +27,28 @@ import org.checkerframework.checker.nullness.qual.NonNull;
  */
 public abstract class PlotSpecificPlaceholder extends Placeholder {
 
+    private final boolean requireAbsolute;
+
     public PlotSpecificPlaceholder(final @NonNull String key) {
+        this(key, false);
+    }
+
+    /**
+     * Create a functional placeholder
+     *
+     * @param key             Placeholder key
+     * @param requireAbsolute If the plot given to the placeholder should be the absolute (not base) plot
+     * @since TODO
+     */
+    public PlotSpecificPlaceholder(final @NonNull String key, final boolean requireAbsolute) {
         super(key);
+        this.requireAbsolute = requireAbsolute;
     }
 
     @Override
     public @NonNull
     final String getValue(final @NonNull PlotPlayer<?> player) {
-        final Plot plot = player.getCurrentPlot();
+        final Plot plot = requireAbsolute ? player.getLocation().getPlotAbs() : player.getCurrentPlot();
         if (plot == null) {
             return "";
         }