Implement build height limits into more events (#3691)

* Implement build height limits into more events

* Implement util method to check if y is within world build limits

* Extract duplicate player-build-height-checking to plot area
 - Extract to core module to allow any possible future platforms to access the method, as they will always duplicate

* Add code tag to javadoc

Co-authored-by: Alexander Brandes <mc.cache@web.de>

Co-authored-by: Alexander Brandes <mc.cache@web.de>

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

@@ -265,15 +265,9 @@ public class BlockEventListener implements Listener {
         BukkitPlayer pp = BukkitUtil.adapt(player);
         Plot plot = area.getPlot(location);
         if (plot != null) {
-            if ((location.getY() >= area.getMaxBuildHeight() || location.getY() < area
+            if (area.notifyIfOutsideBuildArea(pp, location.getY())) {
-                    .getMinBuildHeight()) && !Permissions
-                    .hasPermission(pp, Permission.PERMISSION_ADMIN_BUILD_HEIGHT_LIMIT)) {
                 event.setCancelled(true);
-                pp.sendMessage(
+                return;
-                        TranslatableCaption.of("height.height_limit"),
-                        Template.of("minHeight", String.valueOf(area.getMinBuildHeight())),
-                        Template.of("maxHeight", String.valueOf(area.getMaxBuildHeight()))
-                );
             }
             if (!plot.hasOwner()) {
                 if (!Permissions.hasPermission(pp, Permission.PERMISSION_ADMIN_BUILD_UNOWNED)) {
@@ -351,15 +345,9 @@ public class BlockEventListener implements Listener {
                     event.setCancelled(true);
                     return;
                 }
-            } else if ((location.getY() >= area.getMaxBuildHeight() || location.getY() < area
+            } else if (area.notifyIfOutsideBuildArea(plotPlayer, location.getY())) {
-                    .getMinBuildHeight()) && !Permissions
-                    .hasPermission(plotPlayer, Permission.PERMISSION_ADMIN_BUILD_HEIGHT_LIMIT)) {
                 event.setCancelled(true);
-                plotPlayer.sendMessage(
+                return;
-                        TranslatableCaption.of("height.height_limit"),
-                        Template.of("minHeight", String.valueOf(area.getMinBuildHeight())),
-                        Template.of("maxHeight", String.valueOf(area.getMaxBuildHeight()))
-                );
             }
             if (!plot.hasOwner()) {
                 if (!Permissions
@@ -537,7 +525,7 @@ public class BlockEventListener implements Listener {
         if (plot == null) {
             return;
         }
-        if (location.getY() >= area.getMaxBuildHeight() || location.getY() < area.getMinBuildHeight()) {
+        if (!area.buildRangeContainsY(location.getY())) {
             event.setCancelled(true);
             return;
         }
@@ -739,7 +727,7 @@ public class BlockEventListener implements Listener {
             }
             return;
         }
-        if (toLocation.getY() >= toArea.getMaxBuildHeight() || toLocation.getY() < toArea.getMinBuildHeight()) {
+        if (!toArea.buildRangeContainsY(toLocation.getY())) {
             event.setCancelled(true);
             return;
         }
@@ -813,6 +801,11 @@ public class BlockEventListener implements Listener {
             return;
         }
 
+        if (!area.buildRangeContainsY(location.getY())) {
+            event.setCancelled(true);
+            return;
+        }
+
         Plot plot = location.getOwnedPlot();
         if (plot == null || !plot.getFlag(CropGrowFlag.class)) {
             if (plot != null) {
@@ -856,15 +849,16 @@ public class BlockEventListener implements Listener {
         }
         for (Block block1 : event.getBlocks()) {
             Location bloc = BukkitUtil.adapt(block1.getLocation());
-            if (!area.contains(bloc.getX(), bloc.getZ()) || !area.contains(
+            Location newLoc = bloc.add(relative.getBlockX(), relative.getBlockY(), relative.getBlockZ());
-                    bloc.getX() + relative.getBlockX(),
+            if (!area.contains(bloc.getX(), bloc.getZ()) || !area.contains(newLoc)) {
-                    bloc.getZ() + relative.getBlockZ()
-            )) {
                 event.setCancelled(true);
                 return;
             }
-            if (!plot.equals(area.getOwnedPlot(bloc)) || !plot
+            if (!plot.equals(area.getOwnedPlot(bloc)) || !plot.equals(area.getOwnedPlot(newLoc))) {
-                    .equals(area.getOwnedPlot(bloc.add(relative.getBlockX(), relative.getBlockY(), relative.getBlockZ())))) {
+                event.setCancelled(true);
+                return;
+            }
+            if (!area.buildRangeContainsY(bloc.getY()) || !area.buildRangeContainsY(newLoc.getY())) {
                 event.setCancelled(true);
                 return;
             }
@@ -890,9 +884,8 @@ public class BlockEventListener implements Listener {
             }
             for (Block block1 : event.getBlocks()) {
                 Location bloc = BukkitUtil.adapt(block1.getLocation());
-                if (bloc.isPlotArea() || bloc
+                Location newLoc = bloc.add(relative.getBlockX(), relative.getBlockY(), relative.getBlockZ());
-                        .add(relative.getBlockX(), relative.getBlockY(), relative.getBlockZ())
+                if (bloc.isPlotArea() || newLoc.isPlotArea()) {
-                        .isPlotArea()) {
                     event.setCancelled(true);
                     return;
                 }
@@ -906,15 +899,16 @@ public class BlockEventListener implements Listener {
         }
         for (Block block1 : event.getBlocks()) {
             Location bloc = BukkitUtil.adapt(block1.getLocation());
-            if (!area.contains(bloc.getX(), bloc.getZ()) || !area.contains(
+            Location newLoc = bloc.add(relative.getBlockX(), relative.getBlockY(), relative.getBlockZ());
-                    bloc.getX() + relative.getBlockX(),
+            if (!area.contains(bloc.getX(), bloc.getZ()) || !area.contains(newLoc)) {
-                    bloc.getZ() + relative.getBlockZ()
-            )) {
                 event.setCancelled(true);
                 return;
             }
-            if (!plot.equals(area.getOwnedPlot(bloc)) || !plot
+            if (!plot.equals(area.getOwnedPlot(bloc)) || !plot.equals(area.getOwnedPlot(newLoc))) {
-                    .equals(area.getOwnedPlot(bloc.add(relative.getBlockX(), relative.getBlockY(), relative.getBlockZ())))) {
+                event.setCancelled(true);
+                return;
+            }
+            if (!area.buildRangeContainsY(bloc.getY()) || !area.buildRangeContainsY(newLoc.getY())) {
                 event.setCancelled(true);
                 return;
             }
@@ -938,6 +932,11 @@ public class BlockEventListener implements Listener {
                 Location location = BukkitUtil.adapt(event.getBlock().getRelative(targetFace).getLocation());
                 if (location.isPlotRoad()) {
                     event.setCancelled(true);
+                    return;
+                }
+                PlotArea area = location.getPlotArea();
+                if (area != null && !area.buildRangeContainsY(location.getY())) {
+                    event.setCancelled(true);
                 }
             }
         }
@@ -977,6 +976,10 @@ public class BlockEventListener implements Listener {
                 Plot plot = area.getOwnedPlot(location);
                 if (!Objects.equals(plot, origin)) {
                     event.getBlocks().remove(i);
+                    continue;
+                }
+                if (!area.buildRangeContainsY(location.getY())) {
+                    event.getBlocks().remove(i);
                 }
             }
         }
@@ -1068,6 +1071,10 @@ public class BlockEventListener implements Listener {
         Plot plot = area.getOwnedPlot(location1);
         if (player != null) {
             BukkitPlayer pp = BukkitUtil.adapt(player);
+            if (area.notifyIfOutsideBuildArea(pp, location1.getY())) {
+                event.setCancelled(true);
+                return;
+            }
             if (plot == null) {
                 if (!Permissions.hasPermission(pp, Permission.PERMISSION_ADMIN_BUILD_ROAD)) {
                     pp.sendMessage(
@@ -1175,7 +1182,10 @@ public class BlockEventListener implements Listener {
                     return true;
                 }
                 Plot plot = area.getOwnedPlot(blockLocation);
-                return !Objects.equals(plot, origin);
+                if (!Objects.equals(plot, origin)) {
+                    return true;
+                }
+                return !area.buildRangeContainsY(location.getY());
             });
         }
         if (blocks.isEmpty()) {
@@ -1217,15 +1227,7 @@ public class BlockEventListener implements Listener {
                 event.setCancelled(true);
                 break;
             }
-            if (Permissions.hasPermission(pp, Permission.PERMISSION_ADMIN_BUILD_HEIGHT_LIMIT)) {
+            if (area.notifyIfOutsideBuildArea(pp, currentLocation.getY())) {
-                continue;
-            }
-            if (currentLocation.getY() >= area.getMaxBuildHeight() || currentLocation.getY() < area.getMinBuildHeight()) {
-                pp.sendMessage(
-                        TranslatableCaption.of("height.height_limit"),
-                        Template.of("minHeight", String.valueOf(area.getMinBuildHeight())),
-                        Template.of("maxHeight", String.valueOf(area.getMaxBuildHeight()))
-                );
                 event.setCancelled(true);
                 break;
             }

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

@@ -80,10 +80,19 @@ public class BlockEventListener117 implements Listener {
             return;
         }
 
+        BukkitPlayer plotPlayer = null;
+
+        if (entity instanceof Player player) {
+            plotPlayer = BukkitUtil.adapt(player);
+            if (area.notifyIfOutsideBuildArea(plotPlayer, location.getY())) {
+                event.setCancelled(true);
+                return;
+            }
+        }
+
         Plot plot = location.getOwnedPlot();
         if (plot == null || !plot.getFlag(MiscInteractFlag.class)) {
-            if (entity instanceof Player player) {
+            if (plotPlayer != null) {
-                BukkitPlayer plotPlayer = BukkitUtil.adapt(player);
                 if (plot != null) {
                     if (!plot.isAdded(plotPlayer.getUUID())) {
                         plot.debug(plotPlayer.getName() + " couldn't trigger sculk sensors because misc-interact = false");
@@ -115,12 +124,12 @@ public class BlockEventListener117 implements Listener {
         PlotArea area = location.getPlotArea();
         if (area == null) {
             for (int i = blocks.size() - 1; i >= 0; i--) {
-                location = BukkitUtil.adapt(blocks.get(i).getLocation());
+                Location blockLocation = BukkitUtil.adapt(blocks.get(i).getLocation());
-                if (location.isPlotArea()) {
+                blockLocation = BukkitUtil.adapt(blocks.get(i).getLocation());
+                if (blockLocation.isPlotArea()) {
                     blocks.remove(i);
                 }
             }
-            return;
         } else {
             Plot origin = area.getOwnedPlot(location);
             if (origin == null) {
@@ -128,30 +137,22 @@ public class BlockEventListener117 implements Listener {
                 return;
             }
             for (int i = blocks.size() - 1; i >= 0; i--) {
-                location = BukkitUtil.adapt(blocks.get(i).getLocation());
+                Location blockLocation = BukkitUtil.adapt(blocks.get(i).getLocation());
-                if (!area.contains(location.getX(), location.getZ())) {
+                if (!area.contains(blockLocation.getX(), blockLocation.getZ())) {
                     blocks.remove(i);
                     continue;
                 }
-                Plot plot = area.getOwnedPlot(location);
+                Plot plot = area.getOwnedPlot(blockLocation);
                 if (!Objects.equals(plot, origin)) {
                     event.getBlocks().remove(i);
+                    continue;
                 }
-            }
+                if (!area.buildRangeContainsY(location.getY())) {
-        }
-        Plot origin = area.getPlot(location);
-        if (origin == null) {
-            event.setCancelled(true);
-            return;
-        }
-        for (int i = blocks.size() - 1; i >= 0; i--) {
-            location = BukkitUtil.adapt(blocks.get(i).getLocation());
-            Plot plot = area.getOwnedPlot(location);
-            if (!Objects.equals(plot, origin) && (!plot.isMerged() && !origin.isMerged())) {
                     event.getBlocks().remove(i);
                 }
             }
         }
+    }
 
     @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)
     public void onBlockForm(BlockFormEvent event) {

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

@@ -146,13 +146,11 @@ import org.bukkit.util.Vector;
 import org.checkerframework.checker.nullness.qual.NonNull;
 
 import java.lang.reflect.Field;
-import java.util.ArrayList;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Locale;
 import java.util.Set;
 import java.util.UUID;
-import java.util.regex.Pattern;
 
 /**
  * Player Events involving plots.
@@ -1719,6 +1717,7 @@ public class PlayerEventListener extends PlotListener implements Listener {
         if (PlotSquared.get().getPlotAreaManager().getPlotAreasSet(world).size() == 0) {
             return;
         }
+        BukkitPlayer pp = (event.getEntity() instanceof Player player) ? BukkitUtil.adapt(player) : null;
         int minX = Integer.MAX_VALUE;
         int maxX = Integer.MIN_VALUE;
         int minZ = Integer.MAX_VALUE;
@@ -1740,6 +1739,10 @@ public class PlayerEventListener extends PlotListener implements Listener {
             if (area == null) {
                 continue;
             }
+            if (area.notifyIfOutsideBuildArea(pp, location.getY())) {
+                event.setCancelled(true);
+                return;
+            }
             Plot plot = location.getOwnedPlot();
             if (plot == null) {
                 if (area.isRoadFlags() && area.getRoadFlag(DenyPortalsFlag.class)) {

Core/src/main/java/com/plotsquared/core/plot/PlotArea.java

@@ -36,6 +36,7 @@ import com.plotsquared.core.location.BlockLoc;
 import com.plotsquared.core.location.Direction;
 import com.plotsquared.core.location.Location;
 import com.plotsquared.core.location.PlotLoc;
+import com.plotsquared.core.permissions.Permission;
 import com.plotsquared.core.player.ConsolePlayer;
 import com.plotsquared.core.player.MetaDataAccess;
 import com.plotsquared.core.player.PlayerMetaDataKeys;
@@ -48,6 +49,7 @@ import com.plotsquared.core.plot.flag.implementations.DoneFlag;
 import com.plotsquared.core.queue.GlobalBlockQueue;
 import com.plotsquared.core.queue.QueueCoordinator;
 import com.plotsquared.core.util.MathMan;
+import com.plotsquared.core.util.Permissions;
 import com.plotsquared.core.util.PlotExpression;
 import com.plotsquared.core.util.RegionUtil;
 import com.plotsquared.core.util.StringMan;
@@ -624,6 +626,38 @@ public abstract class PlotArea {
                 getRegionAbs() == null || this.region.contains(location.getBlockVector3()));
     }
 
+    /**
+     * Get if the {@code PlotArea}'s build range (min build height -> max build height) contains the given y value
+     *
+     * @param y y height
+     * @return if build height contains y
+     */
+    public boolean buildRangeContainsY(int y) {
+        return y >= minBuildHeight && y < maxBuildHeight;
+    }
+
+    /**
+     * Utility method to check if the player is attempting to place blocks outside the build area, and notify of this if the
+     * player does not have permissions.
+     *
+     * @param player Player to check
+     * @param y      y height to check
+     * @return true if outside build area with no permissions
+     * @since TODO
+     */
+    public boolean notifyIfOutsideBuildArea(PlotPlayer<?> player, int y) {
+        if (!buildRangeContainsY(y) && !Permissions.hasPermission(player, Permission.PERMISSION_ADMIN_BUILD_HEIGHT_LIMIT)) {
+            player.sendMessage(
+                    TranslatableCaption.of("height.height_limit"),
+                    Template.of("minHeight", String.valueOf(minBuildHeight)),
+                    Template.of("maxHeight", String.valueOf(maxBuildHeight))
+            );
+            // Return true if "failed" as the method will always be inverted otherwise
+            return true;
+        }
+        return false;
+    }
+
     public @NonNull Set<Plot> getPlotsAbs(final UUID uuid) {
         if (uuid == null) {
             return Collections.emptySet();

Core/src/main/java/com/plotsquared/core/util/EventDispatcher.java

@@ -332,6 +332,15 @@ public class EventDispatcher {
     ) {
         PlotArea area = location.getPlotArea();
         assert area != null;
+        if (!area.buildRangeContainsY(location.getY()) && !Permissions
+                .hasPermission(player, Permission.PERMISSION_ADMIN_BUILD_HEIGHT_LIMIT)) {
+            player.sendMessage(
+                    TranslatableCaption.of("height.height_limit"),
+                    Template.of("minHeight", String.valueOf(area.getMinBuildHeight())),
+                    Template.of("maxHeight", String.valueOf(area.getMaxBuildHeight()))
+            );
+            return false;
+        }
         Plot plot = area.getPlot(location);
         if (plot != null) {
             if (plot.isAdded(player.getUUID())) {