feat: added claim modes in chunk claiming screen

freehand (default)/rectangle/circle

Author: desht

common/src/main/java/dev/ftb/mods/ftbchunks/client/gui/map/ChunkScreen.java

@@ -1,9 +1,11 @@
 package dev.ftb.mods.ftbchunks.client.gui.map;
 
 import dev.ftb.mods.ftbchunks.FTBChunks;
+import dev.ftb.mods.ftbchunks.api.FTBChunksAPI;
 import dev.ftb.mods.ftbchunks.client.FTBChunksClient;
 import dev.ftb.mods.ftbchunks.client.map.MapDimension;
 import dev.ftb.mods.ftbchunks.net.SendGeneralDataPacket;
+import dev.ftb.mods.ftblibrary.client.gui.input.MouseButton;
 import dev.ftb.mods.ftblibrary.client.gui.screens.AbstractThreePanelScreen;
 import dev.ftb.mods.ftblibrary.client.gui.screens.KeyReferenceScreen;
 import dev.ftb.mods.ftblibrary.client.gui.theme.Theme;
@@ -14,6 +16,7 @@
 import dev.ftb.mods.ftblibrary.client.icon.IconHelper;
 import dev.ftb.mods.ftblibrary.client.util.ClientUtils;
 import dev.ftb.mods.ftblibrary.icon.Color4I;
+import dev.ftb.mods.ftblibrary.icon.Icon;
 import dev.ftb.mods.ftblibrary.icon.Icons;
 import dev.ftb.mods.ftblibrary.util.TooltipList;
 import dev.ftb.mods.ftbteams.api.Team;
@@ -31,6 +34,8 @@ public class ChunkScreen extends AbstractThreePanelScreen<ChunkScreenPanel> {
     private final Team openedAs;
     private final SimpleButton largeMapButton;
 
+    static ClaimMode claimMode = ClaimMode.FREEHAND; // persist across invocations
+
     private ChunkScreen(MapDimension dimension, @Nullable Team openedAs) {
         this.dimension = dimension;
         this.openedAs = openedAs;
@@ -134,6 +139,7 @@ protected class CustomTopPanel extends Panel {
         private final Button removeAllClaims;
         private final Button adminButton;
         private final Button mouseReferenceButton;
+        private final Button claimModeButton;
 
         public CustomTopPanel() {
             super(ChunkScreen.this);
@@ -157,6 +163,8 @@ public CustomTopPanel() {
                     .setForceButtonSize(false);
 
             adminButton = new AdminButton().setForceButtonSize(false);
+
+            claimModeButton = new ClaimModeButton();
         }
 
         @Override
@@ -167,6 +175,7 @@ public void addWidgets() {
                 add(adminButton);
             }
             add(mouseReferenceButton);
+            add(claimModeButton);
         }
 
         @Override
@@ -176,7 +185,7 @@ public void alignWidgets() {
 
             closeButton.setPosAndSize(width - 16, 2, 12, 12);
             mouseReferenceButton.setPosAndSize(width - 32, 2, 12, 12);
-
+            claimModeButton.setPosAndSize(width - 48, 2, 12, 12);
         }
 
         @Override
@@ -203,6 +212,16 @@ public void addMouseOverText(TooltipList list) {
                 list.add(MORE_INFO);
             }
         }
+
+        private class ClaimModeButton extends SimpleButton {
+            public ClaimModeButton() {
+                super(CustomTopPanel.this, claimMode.description(), claimMode.icon(), (widget, button) -> {
+                    claimMode = claimMode.next();
+                    widget.setIcon(claimMode.icon());
+                    widget.setTitle(claimMode.description());
+                });
+            }
+        }
     }
 
     private static class ChunkMouseReferenceScreen extends KeyReferenceScreen {
@@ -217,7 +236,6 @@ public Component getTitle() {
     }
 
     private class CustomBottomPanel extends Panel {
-
         public CustomBottomPanel() {
             super(ChunkScreen.this);
         }
@@ -263,4 +281,30 @@ public void drawBackground(GuiGraphics graphics, Theme theme, int x, int y, int
             }
         }
     }
+
+    enum ClaimMode {
+        FREEHAND("freehand", Icon.getIcon(FTBChunksAPI.id("textures/freehand.png"))),
+        RECTANGLE("rectangle", Icon.getIcon(FTBChunksAPI.id("textures/rectangle.png"))),
+        CIRCLE("circle", Icon.getIcon(FTBChunksAPI.id("textures/circle.png")));
+
+        private final String key;
+        private final Icon<?> icon;
+
+        ClaimMode(String key, Icon<?> icon) {
+            this.key = key;
+            this.icon = icon;
+        }
+
+        Component description() {
+            return Component.translatable("ftbchunks.claim_mode." + key);
+        }
+
+        public Icon<?> icon() {
+            return icon;
+        }
+
+        public ClaimMode next() {
+            return ClaimMode.values()[(ordinal() + 1) % ClaimMode.values().length];
+        }
+    }
 }

common/src/main/java/dev/ftb/mods/ftbchunks/client/gui/map/ChunkScreenPanel.java

@@ -39,6 +39,7 @@
 import net.minecraft.network.chat.Component;
 import net.minecraft.network.chat.MutableComponent;
 import net.minecraft.server.permissions.Permissions;
+import net.minecraft.util.Mth;
 import net.minecraft.world.entity.player.Player;
 import net.minecraft.world.level.ChunkPos;
 import org.lwjgl.glfw.GLFW;
@@ -54,6 +55,7 @@ public class ChunkScreenPanel extends Panel {
 	private static final ImageIcon CHECKERED_ICON = new ImageIcon(FTBChunksAPI.id("textures/checkered.png"));
 
 	private final List<ChunkButton> chunkButtons = new ArrayList<>();
+	private XZ firstSelectedChunk = null;
 	private final Set<XZ> selectedChunks = new HashSet<>();
 	private final List<ChunkButtonPos> chunkedPosList = new ArrayList<>();
 	public boolean isAdminEnabled;
@@ -124,11 +126,11 @@ public void alignWidgets() {
 
 		this.tileSizeX = maxWidth / FTBChunks.TILES;
 		this.tileSizeY = maxHeight / FTBChunks.TILES;
-        for (ChunkButtonPos chunkedPos : chunkedPosList) {
-            chunkedPos.button.setPos(xPos + tileSizeX * chunkedPos.x, yPos + tileSizeY * chunkedPos.y);
-            chunkedPos.button.setSize(tileSizeX, tileSizeY);
-        }
-    }
+		for (ChunkButtonPos chunkedPos : chunkedPosList) {
+			chunkedPos.button.setPos(xPos + tileSizeX * chunkedPos.x, yPos + tileSizeY * chunkedPos.y);
+			chunkedPos.button.setSize(tileSizeX, tileSizeY);
+		}
+	}
 
 	@Override
 	public void mouseReleased(MouseButton button) {
@@ -138,16 +140,17 @@ public void mouseReleased(MouseButton button) {
 			Optional<UUID> teamId = Optional.ofNullable(chunkScreen.getOpenedAs()).map(Team::getTeamId);
 			NetworkManager.sendToServer(new RequestChunkChangePacket(ChunkChangeOp.create(button.isLeft(), isShiftKeyDown()), selectedChunks, canChangeAsAdmin(), teamId));
 			selectedChunks.clear();
+			firstSelectedChunk = null;
 			playClickSound();
 		}
 	}
 
 	public void removeAllClaims() {
 		Optional<UUID> teamId = Optional.ofNullable(chunkScreen.getOpenedAs()).map(Team::getTeamId);
 		Set<XZ> allChunks = chunkedPosList.stream()
-						.map(ChunkButtonPos::button)
-						.map(ChunkButton::getChunkPos)
-						.collect(Collectors.toSet());
+				.map(ChunkButtonPos::button)
+				.map(ChunkButton::getChunkPos)
+				.collect(Collectors.toSet());
 		NetworkManager.sendToServer(new RequestChunkChangePacket(ChunkChangeOp.UNCLAIM, allChunks, canChangeAsAdmin(), teamId));
 	}
 
@@ -223,6 +226,10 @@ public ChunkButton(Panel panel, XZ xz) {
 
 		@Override
 		public void onClicked(MouseButton mouseButton) {
+			if (selectedChunks.isEmpty()) {
+				firstSelectedChunk = chunkPos;
+			}
+
 			selectedChunks.add(chunkPos);
 		}
 
@@ -244,12 +251,39 @@ public void drawBackground(GuiGraphics graphics, Theme theme, int x, int y, int
 
 		@Override
 		public boolean mouseDragged(int button, double dragX, double dragY) {
-            if (isMouseOver() && (isMouseButtonDown(MouseButton.LEFT) || isMouseButtonDown(MouseButton.RIGHT))) {
-                selectedChunks.add(chunkPos);
-            }
+			if (isMouseOver() && (isMouseButtonDown(MouseButton.LEFT) || isMouseButtonDown(MouseButton.RIGHT))) {
+				if (ChunkScreen.claimMode != ChunkScreen.ClaimMode.FREEHAND && firstSelectedChunk != null) {
+					addChunksToSelection();
+				} else {
+					selectedChunks.add(chunkPos);
+				}
+			}
 			return super.mouseDragged(button, dragX, dragY);
 		}
 
+		private void addChunksToSelection() {
+			int x1 = Math.min(firstSelectedChunk.x(), chunkPos.x());
+			int x2 = Math.max(firstSelectedChunk.x(), chunkPos.x());
+			int z1 = Math.min(firstSelectedChunk.z(), chunkPos.z());
+			int z2 = Math.max(firstSelectedChunk.z(), chunkPos.z());
+			XZ centre = new XZ((x1 + x2) / 2, (z1 + z2) / 2);
+			selectedChunks.clear();
+			for (int x = x1; x <= x2; x++) {
+				for (int z = z1; z <= z2; z++) {
+					XZ xz = new XZ(x, z);
+					if (ChunkScreen.claimMode == ChunkScreen.ClaimMode.RECTANGLE
+							|| distance(xz, centre) - 0.5f <= Math.min(centre.x() - x1, centre.z() - z1))
+					{
+						selectedChunks.add(xz);
+					}
+				}
+			}
+		}
+
+		private float distance(XZ xz1, XZ xz2) {
+			return Mth.sqrt((xz2.x() - xz1.x()) * (xz2.x() - xz1.x()) + (xz2.z() - xz1.z()) * (xz2.z() - xz1.z()));
+		}
+
 		@Override
 		public void addMouseOverText(TooltipList list) {
 			chunk.getTeam().ifPresent(team -> {
@@ -287,9 +321,9 @@ public void addMouseOverText(TooltipList list) {
 					}
 				});
 
-                if (!altPressed && (chunk.getClaimedDate().isPresent() || chunk.getForceLoadedDate().isPresent())) {
-                    list.add(Component.translatable("ftbchunks.gui.hold_alt_for_dates").withStyle(ChatFormatting.DARK_GRAY));
-                }
+				if (!altPressed && (chunk.getClaimedDate().isPresent() || chunk.getForceLoadedDate().isPresent())) {
+					list.add(Component.translatable("ftbchunks.gui.hold_alt_for_dates").withStyle(ChatFormatting.DARK_GRAY));
+				}
 			});
 		}
 

common/src/main/resources/assets/ftbchunks/lang/en_us.json

@@ -335,5 +335,8 @@
   "ftbchunks.command.bypass_protection_enabled": "Bypass Protection: Enabled",
   "ftbchunks.command.bypass_protection_disabled": "Bypass Protection: Disabled",
   "ftbchunks.command.view_loaded": "Chunks Loaded: %d. Check the map to see loaded chunks",
-  "ftbchunks.command.waypoint_added": "Added waypoint '%s'"
+  "ftbchunks.command.waypoint_added": "Added waypoint '%s'",
+  "ftbchunks.claim_mode.freehand": "Freehand Claiming",
+  "ftbchunks.claim_mode.rectangle": "Rectangular Claiming",
+  "ftbchunks.claim_mode.circle": "Circular Claiming"
 }