Merge pull request #2603 from BentoBoxWorld/blueprint_no_water_option

Add option to ignore water when saving blueprint
BentoBoxWorld · Jan 24, 2025 · 7d7d3d1 · 7d7d3d1
2 parents caf32da + 3d13c98
commit 7d7d3d1
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 15 deletions.
diff --git a/...java/world/bentobox/bentobox/api/commands/admin/blueprints/AdminBlueprintCopyCommand.java b/...java/world/bentobox/bentobox/api/commands/admin/blueprints/AdminBlueprintCopyCommand.java
@@ -41,14 +41,15 @@ public boolean execute(User user, String label, List<String> args)
 
         boolean copyAir = args.stream().anyMatch(key -> key.equalsIgnoreCase("air"));
         boolean copyBiome = args.stream().anyMatch(key -> key.equalsIgnoreCase("biome"));
+        boolean noWater = args.stream().anyMatch(key -> key.equalsIgnoreCase("nowater"));
 
-        return clipboard.copy(user, copyAir, copyBiome);
+        return clipboard.copy(user, copyAir, copyBiome, noWater);
     }
 
 
     @Override
     public Optional<List<String>> tabComplete(User user, String alias, List<String> args)
     {
-        return Optional.of(List.of("air", "biome"));
+        return Optional.of(List.of("air", "biome", "nowater"));
     }
 }
diff --git a/src/main/java/world/bentobox/bentobox/blueprints/BlueprintClipboard.java b/src/main/java/world/bentobox/bentobox/blueprints/BlueprintClipboard.java
@@ -102,7 +102,7 @@ public BlueprintClipboard() {
      * @param user - user
      * @return true if successful, false if pos1 or pos2 are undefined.
      */
-    public boolean copy(User user, boolean copyAir, boolean copyBiome) {
+    public boolean copy(User user, boolean copyAir, boolean copyBiome, boolean noWater) {
         if (copying) {
             user.sendMessage("commands.admin.blueprint.mid-copy");
             return false;
@@ -137,11 +137,13 @@ public boolean copy(User user, boolean copyAir, boolean copyBiome) {
 
         int speed = plugin.getSettings().getPasteSpeed();
         List<Vector> vectorsToCopy = getVectors(toCopy);
-        Bukkit.getScheduler().runTaskAsynchronously(plugin, () -> copyAsync(world, user, vectorsToCopy, speed, copyAir, copyBiome));
+        Bukkit.getScheduler().runTaskAsynchronously(plugin,
+                () -> copyAsync(world, user, vectorsToCopy, speed, copyAir, copyBiome, noWater));
         return true;
     }
 
-    private void copyAsync(World world, User user, List<Vector> vectorsToCopy, int speed, boolean copyAir, boolean copyBiome) {
+    private void copyAsync(World world, User user, List<Vector> vectorsToCopy, int speed, boolean copyAir,
+            boolean copyBiome, boolean noWater) {
         copying = false;
         // FancyNpcs
         if (npc.isPresent()) {
@@ -167,7 +169,7 @@ private void copyAsync(World world, User user, List<Vector> vectorsToCopy, int s
                         .filter(e -> new Vector(e.getLocation().getBlockX(), e.getLocation().getBlockY(),
                                 e.getLocation().getBlockZ()).equals(v))
                         .toList();
-                if (copyBlock(v.toLocation(world), copyAir, copyBiome, ents)) {
+                if (copyBlock(v.toLocation(world), copyAir, copyBiome, ents, noWater)) {
                     count++;
                 }
             });
@@ -208,11 +210,14 @@ protected List<Vector> getVectors(BoundingBox b) {
         return r;
     }
 
-    private boolean copyBlock(Location l, boolean copyAir, boolean copyBiome, List<Entity> ents) {
+    private boolean copyBlock(Location l, boolean copyAir, boolean copyBiome, List<Entity> ents, boolean noWater) {
         Block block = l.getBlock();
         if (!copyAir && block.getType().equals(Material.AIR) && ents.isEmpty()) {
             return false;
         }
+        if (noWater && block.getType() == Material.WATER && ents.isEmpty()) {
+            return false;
+        }
         // Create position
         Vector origin2 = origin == null ? new Vector(0,0,0) : origin;
         int x = l.getBlockX() - origin2.getBlockX();
@@ -231,6 +236,9 @@ private boolean copyBlock(Location l, boolean copyAir, boolean copyBiome, List<E
         if (!copyAir && block.getType().equals(Material.AIR) && !ents.isEmpty()) {
             return true;
         }
+        if (noWater && block.getType().equals(Material.WATER) && !ents.isEmpty()) {
+            return true;
+        }
         BlueprintBlock b = bluePrintBlock(pos, block, copyBiome);
         if (b != null) {
             this.bpBlocks.put(pos, b);

diff --git a/src/main/resources/locales/en-US.yml b/src/main/resources/locales/en-US.yml
@@ -352,8 +352,8 @@ commands:
       mid-copy: '&c You are mid-copy. Wait until the copy is done.'
       copied-percent: '&6 Copied [number]%'
       copy:
-        parameters: '[air]'
-        description: copy the clipboard set by pos1 and pos2 and optionally the air
+        parameters: '[air] [biome] [nowater]'
+        description: copy the clipboard set by pos1 and pos2 and optionally the air, biome, and water
           blocks
       delete:
         parameters: <name>

diff --git a/.../world/bentobox/bentobox/api/commands/admin/blueprints/AdminBlueprintCopyCommandTest.java b/.../world/bentobox/bentobox/api/commands/admin/blueprints/AdminBlueprintCopyCommandTest.java
@@ -101,7 +101,7 @@ public void setUp() throws Exception {
         when(ac.getClipboards()).thenReturn(map);
 
         // Clipboard
-        when(clip.copy(any(), anyBoolean(), anyBoolean())).thenReturn(true);
+        when(clip.copy(any(), anyBoolean(), anyBoolean(), anyBoolean())).thenReturn(true);
 
         // Locales
         LocalesManager lm = mock(LocalesManager.class);
@@ -156,7 +156,7 @@ public void testExecuteUserStringListOfStringHelp() {
     @Test
     public void testExecuteUserStringListOfStringSuccess() {
         assertTrue(abcc.execute(user, "", List.of("air", "biome")));
-        verify(clip).copy(user, true, true);
+        verify(clip).copy(user, true, true, false);
     }
 
     /**
@@ -165,7 +165,7 @@ public void testExecuteUserStringListOfStringSuccess() {
     @Test
     public void testExecuteUserStringListOfStringSuccessCaps() {
         assertTrue(abcc.execute(user, "", List.of("AIR", "BIOME")));
-        verify(clip).copy(user, true, true);
+        verify(clip).copy(user, true, true, false);
     }
 
     /**
@@ -174,7 +174,7 @@ public void testExecuteUserStringListOfStringSuccessCaps() {
     @Test
     public void testExecuteUserStringListOfStringJunk() {
         assertTrue(abcc.execute(user, "", List.of("junk", "junk")));
-        verify(clip).copy(user, false, false);
+        verify(clip).copy(user, false, false, false);
     }
 
     /**
@@ -183,7 +183,7 @@ public void testExecuteUserStringListOfStringJunk() {
     @Test
     public void testExecuteUserStringListOfStringNothing() {
         assertTrue(abcc.execute(user, "", Collections.emptyList()));
-        verify(clip).copy(user, false, false);
+        verify(clip).copy(user, false, false, false);
     }
 
     /**

diff --git a/src/test/java/world/bentobox/bentobox/blueprints/BlueprintClipboardTest.java b/src/test/java/world/bentobox/bentobox/blueprints/BlueprintClipboardTest.java
@@ -107,7 +107,7 @@ public void testBlueprintClipboard() {
      */
     @Test
     public void testCopy() {
-        assertFalse(bc.copy(user, false, false));
+        assertFalse(bc.copy(user, false, false, false));
         verify(user, never()).sendMessage("commands.admin.blueprint.mid-copy");
         verify(user).sendMessage("commands.admin.blueprint.need-pos1-pos2");
     }