Merge pull request #2 from BentoBoxWorld/code_clean_up

tastybento · web-flow · commit dbdbab56a8a5 · 2025-11-08T16:01:25.000-08:00
Code clean up
diff --git a/README.md b/README.md
@@ -41,12 +41,12 @@ Encourage players to join and grow your server with the Dynamic World Border opt
 
 The main player command is `/strange` or `/st` and the admin command is `/stranger`
 
-| Command | Description |
-| :--- | :--- |
-| `/st claim` | Creates a claim at your current location (if you have room). |
-| `/st info` | Shows information about the claim you are currently standing in. |
-| `/st settings` | Opens the GUI to manage claim permissions (e.g., visitor block break, chest access). |
-| `/st team` | Goes the Team GUI where you can invites players to become a member of your claim, which also increases the claim size. |
+| Command        | Description                                                                                                            |
+|:---------------|:-----------------------------------------------------------------------------------------------------------------------|
+| `/st claim`    | Creates a claim at your current location (if you have room).                                                           |
+| `/st info`     | Shows information about the claim you are currently standing in.                                                       |
+| `/st settings` | Opens the GUI to manage claim permissions (e.g., visitor block break, chest access).                                   |
+| `/st team`     | Goes the Team GUI where you can invites players to become a member of your claim, which also increases the claim size. |
 
 ## Use with Other Addons
 
diff --git a/StrangerRealms.iml b/StrangerRealms.iml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module version="4">
+  <component name="FacetManager">
+    <facet type="minecraft" name="Minecraft">
+      <configuration>
+        <autoDetectTypes>
+          <platformType>PAPER</platformType>
+        </autoDetectTypes>
+        <projectReimportVersion>1</projectReimportVersion>
+      </configuration>
+    </facet>
+  </component>
+</module>
diff --git a/pom.xml b/pom.xml
@@ -174,11 +174,11 @@
     </dependencies>
 
     <build>
-        <!-- By default ${revision} is ${build.version}-SNAPSHOT -->
+        <!-- By default, ${revision} is ${build.version}-SNAPSHOT -->
         <!-- If GIT_BRANCH variable is set to origin/master, then it will 
             be only ${build.version}. -->
 
-        <!-- By default ${build.number} is -LOCAL. -->
+        <!-- By default, ${build.number} is -LOCAL. -->
         <!-- If the BUILD_NUMBER variable is set, then it will be -b[number]. -->
         <!-- If GIT_BRANCH variable is set to origin/master, then it will 
             be the empty string. -->
diff --git a/src/main/java/world/bentobox/stranger/Settings.java b/src/main/java/world/bentobox/stranger/Settings.java
@@ -12,6 +12,7 @@
 import org.bukkit.GameMode;
 import org.bukkit.entity.EntityType;
 
+import org.jetbrains.annotations.NotNull;
 import world.bentobox.bentobox.BentoBox;
 import world.bentobox.bentobox.api.configuration.ConfigComment;
 import world.bentobox.bentobox.api.configuration.ConfigEntry;
@@ -771,18 +772,6 @@ public void setIslandProtectionRange(int islandProtectionRange) {
         this.islandDistance = islandProtectionRange;
     }
 
-    /**
-     * @param islandStartX the islandStartX to set
-     */
-    public void setIslandStartX(int islandStartX) {
-    }
-
-    /**
-     * @param islandStartZ the islandStartZ to set
-     */
-    public void setIslandStartZ(int islandStartZ) {
-    }
-
     /**
      * @param maxIslands the maxIslands to set
      */
@@ -970,7 +959,7 @@ public boolean isDeathsResetOnNewIsland() {
      * @return the onJoinCommands
      */
     @Override
-    public List<String> getOnJoinCommands() {
+    public @NotNull List<String> getOnJoinCommands() {
         return onJoinCommands;
     }
 
@@ -985,7 +974,7 @@ public void setOnJoinCommands(List<String> onJoinCommands) {
      * @return the onLeaveCommands
      */
     @Override
-    public List<String> getOnLeaveCommands() {
+    public @NotNull List<String> getOnLeaveCommands() {
         return onLeaveCommands;
     }
 
@@ -1000,7 +989,7 @@ public void setOnLeaveCommands(List<String> onLeaveCommands) {
      * @return the onRespawnCommands
      */
     @Override
-    public List<String> getOnRespawnCommands() {
+    public @NotNull List<String> getOnRespawnCommands() {
         return onRespawnCommands;
     }
 
diff --git a/src/main/java/world/bentobox/stranger/ShowBarrier.java b/src/main/java/world/bentobox/stranger/ShowBarrier.java
@@ -52,7 +52,6 @@ public ShowBarrier(StrangerRealms addon) {
     /**
      * Show the barrier to the player on an island
      * @param player - player to show
-     * @param island - island
      */
     @Override
     public void showBorder(Player player) {
@@ -118,10 +117,10 @@ private void showWalls(Player player, Location loc, int xMin, int xMax, int zMin
 
     /**
      * @param player player
-     * @param i 
-     * @param j
-     * @param k
-     * @param max
+     * @param i x coord
+     * @param j y coord
+     * @param k z coord
+     * @param max whether the max border should be shown or not
      */
     private void showPlayer(Player player, int i, int j, int k, boolean max) {
         // Get if on or in border
@@ -192,7 +191,7 @@ public void refreshView(User user) {
         this.showBorder(user.getPlayer());
     }
 
-    private class BarrierBlock {
+    private static class BarrierBlock {
         Location l;
         BlockData oldBlockData;
         public BarrierBlock(Location l, BlockData oldBlockData) {
diff --git a/src/main/java/world/bentobox/stranger/ShowWorldBorder.java b/src/main/java/world/bentobox/stranger/ShowWorldBorder.java
@@ -43,12 +43,6 @@ public void showBorder(Player player) {
             double dist = addon.getBorderSize() / 2D;
            BoundingBox worldBB = BoundingBox.of(center.toVector(), dist, dist, dist);
            if (worldBB.contains(island.getBoundingBox())) {
-               /*
-               BentoBox.getInstance().logDebug("Claim is within the world barrier");
-               BentoBox.getInstance().logDebug("world barrier bb = " + worldBB);
-               BentoBox.getInstance().logDebug("Player location = " + player.getLocation());
-               BentoBox.getInstance().logDebug("Player in world border? " + worldBB.contains(player.getLocation().toVector()));
-               */
                showWorldBarrier(player);
                return;
            }
diff --git a/src/main/java/world/bentobox/stranger/StrangerRealms.java b/src/main/java/world/bentobox/stranger/StrangerRealms.java
@@ -62,7 +62,7 @@ public class StrangerRealms extends GameModeAddon {
     private BorderShower borderShower;
     private final Set<BorderType> availableBorderTypes = EnumSet.of(BorderType.VANILLA, BorderType.BARRIER);
     private int borderSize;
-    private @NotNull BukkitTask task;
+    private BukkitTask task;
     private PlayerListener playerListener;
     private NetherChunkMaker netherChunkMaker;
 
@@ -291,11 +291,9 @@ public double getBorderSize() {
         int newBorderSize = getSettings().isManualBorderSize() ? borderSize :
                 Math.max(getSettings().getBarrierIncreaseBlocks(), (this.getSettings().getBarrierIncreaseBlocks() * Bukkit.getServer().getOnlinePlayers().size()));
          if (newBorderSize < borderSize) {
-            if (task != null) {
-                // End any current task to replace it
-                task.cancel();
-            }
-            // Trigger gradual reduction of border
+             // End any current task to replace it
+             task.cancel();
+             // Trigger gradual reduction of border
            task =  Bukkit.getScheduler().runTaskTimer(getPlugin(), () -> {
                //BentoBox.getInstance().logDebug("Get border size = " + newBorderSize + " old = " + borderSize);
                 if (borderSize > newBorderSize) {
@@ -325,9 +323,7 @@ public void setBorderSize(int borderSize) {
      * Cancels any active border reduction task
      */
     public void cancelBorderTask() {
-        if (this.task != null) {
-            this.task.cancel();
-        }
+        this.task.cancel();
     }
     
     /**
diff --git a/src/main/java/world/bentobox/stranger/commands/admin/WorldBorderCommand.java b/src/main/java/world/bentobox/stranger/commands/admin/WorldBorderCommand.java
@@ -16,7 +16,7 @@
  */
 public class WorldBorderCommand extends CompositeCommand {
 
-    private StrangerRealms addon;
+    private final StrangerRealms addon;
     /**
      * Command to create a claim
      * 
@@ -71,7 +71,7 @@ public boolean execute(User user, String label, List<String> args) {
     private boolean turnOn(User user) {
         addon.getSettings().setDisableWorldBorder(false);
         addon.saveWorldSettings();
-        Bukkit.getServer().getOnlinePlayers().stream().forEach(addon.getBorderShower()::showBorder);
+        Bukkit.getServer().getOnlinePlayers().forEach(addon.getBorderShower()::showBorder);
         user.sendMessage("general.success");
         return true;
     }
@@ -89,7 +89,7 @@ private boolean setAuto(User user) {
         // Turn on auto
         addon.getSettings().setManualBorderSize(false);
         addon.saveWorldSettings();
-        Bukkit.getServer().getOnlinePlayers().stream().forEach(addon.getBorderShower()::showBorder);
+        Bukkit.getServer().getOnlinePlayers().forEach(addon.getBorderShower()::showBorder);
         user.sendMessage("general.success");
         return true;
     }
@@ -117,7 +117,7 @@ private boolean setSize(User user, List<String> args) {
             addon.getSettings().setManualBorderSize(true);
             addon.saveWorldSettings();
             // Update all players
-            Bukkit.getServer().getOnlinePlayers().stream().forEach(addon.getBorderShower()::showBorder);
+            Bukkit.getServer().getOnlinePlayers().forEach(addon.getBorderShower()::showBorder);
             user.sendMessage("general.success");
             return true;
 
diff --git a/src/main/java/world/bentobox/stranger/commands/player/ClaimCommand.java b/src/main/java/world/bentobox/stranger/commands/player/ClaimCommand.java
@@ -17,7 +17,7 @@
 
 /**
  * Handles the claim creation command.
- * A lot of this code comes from the stock create command in BentoBox and it uses 
+ * A lot of this code comes from the stock create command in BentoBox, and it uses
  * locale from that too often. References to "island" can be read as "claim".
  * <p>
  * Features:
diff --git a/src/main/java/world/bentobox/stranger/commands/player/ClaimLocationStrategy.java b/src/main/java/world/bentobox/stranger/commands/player/ClaimLocationStrategy.java
@@ -15,7 +15,7 @@
 public class ClaimLocationStrategy implements NewIslandLocationStrategy {
 
     protected final BentoBox plugin = BentoBox.getInstance();
-    private StrangerRealms addon;
+    private final StrangerRealms addon;
     
     public ClaimLocationStrategy(StrangerRealms addon) {
         this.addon = addon;
diff --git a/src/main/java/world/bentobox/stranger/generator/CustomCaveGenerator.java b/src/main/java/world/bentobox/stranger/generator/CustomCaveGenerator.java
@@ -7,11 +7,11 @@
 
 /**
  * A custom noise generator for creating 3D cave systems.
- *
+ * <p>
  * This class extends NoiseGenerator and is designed to be used within
  * a custom ChunkGenerator (like in generateNoise(), generateSurface(), or
  * generateBedrock()).
- *
+ * <p>
  * The algorithm works by combining two 3D Simplex noise fields. A "cave"
  * is formed in areas where the values of both noise fields are close to zero.
  * This creates intersecting "sheets" of noise, resulting in tunnel-like
@@ -56,11 +56,11 @@ public CustomCaveGenerator(Random rand) {
 
     /**
      * Computes the 3D "cave" noise value at the given coordinates.
-     *
+     * <p>
      * This is the core abstract method from NoiseGenerator.
      * The value returned is typically in the range [-1, 1], but this
      * implementation's "cheese" logic may exceed that slightly.
-     *
+     * <p>
      * A lower value (closer to 0) means "more likely to be a cave".
      * A higher value (closer to 1 or -1) means "more likely to be solid".
      *
@@ -139,11 +139,6 @@ public double noise(double x, double y, double z) {
         // finalNoise = Math.max(0, Math.min(1, finalNoise));
 
         // The finalNoise value is a double.
-        // In a ChunkGenerator, you would check:
-        // if (customCaveGenerator.noise(x, y, z) < 0.1) {
-        //    chunkData.setBlock(x, y, z, Material.AIR);
-        // }
-        
         return finalNoise;
     }
 }
diff --git a/src/main/java/world/bentobox/stranger/generator/NetherBiomeProvider.java b/src/main/java/world/bentobox/stranger/generator/NetherBiomeProvider.java
@@ -13,7 +13,7 @@
  */
 public class NetherBiomeProvider extends BiomeProvider {
     
-    private Random random = new Random();
+    private final Random random = new Random();
 
     @Override
     public @NotNull Biome getBiome(@NotNull WorldInfo worldInfo, int x, int y, int z) {
diff --git a/src/main/java/world/bentobox/stranger/generator/NetherChunks.java b/src/main/java/world/bentobox/stranger/generator/NetherChunks.java
@@ -37,7 +37,7 @@ public void generateNoise(@NotNull WorldInfo worldInfo, @NotNull Random random,
         // Define the Y-range for cave generation
         final int minCaveY = worldInfo.getMinHeight() + 7;
         final int maxCaveY = minCaveY + 30;
-        final double caveRange = (double)(maxCaveY - minCaveY);
+        final double caveRange = maxCaveY - minCaveY;
         
         for (int x = 0; x < 16; x++) {
             for (int z = 0; z < 16; z++) {
diff --git a/src/main/java/world/bentobox/stranger/listeners/BorderShower.java b/src/main/java/world/bentobox/stranger/listeners/BorderShower.java
@@ -10,40 +10,40 @@
  *
  */
 public interface BorderShower {
-    public static final String BORDER_STATE_META_DATA = "Crowdbound_border_state";
+    String BORDER_STATE_META_DATA = "Stranger_border_state";
 
     /**
      * Show the barrier to the player
      * @param player - player to show
      */
-    public void showBorder(Player player);
+    void showBorder(Player player);
 
     /**
      * Hide the barrier
      * @param user - user
      */
-    public void hideBorder(User user);
+    void hideBorder(User user);
 
     /**
      * Removes any cache
      * @param user - user
      */
-    public default void clearUser(User user) {
+    default void clearUser(User user) {
         // Do nothing
     }
 
     /**
      * Refreshes the barrier view, if required
      * @param user user 
      */
-    public default void refreshView(User user){
+    default void refreshView(User user){
         // Do nothing
     }
 
     /**
      * Teleports player back within the island space they are in
      * @param player player
      */
-    public void teleportPlayer(Player player);
+    void teleportPlayer(Player player);
 
 }
diff --git a/src/main/java/world/bentobox/stranger/listeners/NetherChunkMaker.java b/src/main/java/world/bentobox/stranger/listeners/NetherChunkMaker.java
diff --git a/src/main/java/world/bentobox/stranger/listeners/PlayerListener.java b/src/main/java/world/bentobox/stranger/listeners/PlayerListener.java
diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml
