Merge pull request #3 from BentoBoxWorld/code_clean_up

Add unclaim command

Author: tastybento

src/main/java/world/bentobox/stranger/Settings.java

@@ -22,6 +22,7 @@
 import world.bentobox.bentobox.database.objects.adapters.Adapter;
 import world.bentobox.bentobox.database.objects.adapters.FlagSerializer;
 import world.bentobox.bentobox.database.objects.adapters.FlagSerializer2;
+import world.bentobox.stranger.border.BorderType;
 
 /**
  * All the plugin settings are here
@@ -60,9 +61,9 @@ public class Settings implements WorldSettings {
     private String friendlyName = "StrangerRealms";
 
     @ConfigComment("Name of the world - if it does not exist then it will be generated.")
-    @ConfigComment("It acts like a prefix for nether and end (e.g. stranger_world, stranger_world_nether, stranger_world_end)")
+    @ConfigComment("It acts like a prefix for nether and end (e.g. stranger-world, stranger-world_nether, stranger-world_end)")
     @ConfigEntry(path = "world.world-name")
-    private String worldName = "stranger_world";
+    private String worldName = "stranger-world";
 
     @ConfigComment("World seed.")
     @ConfigEntry(path = "world.generator.seed", needsReset = true)

src/main/java/world/bentobox/stranger/StrangerRealms.java

@@ -4,6 +4,7 @@
 import java.util.Collections;
 import java.util.EnumSet;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
 
 import org.bukkit.Bukkit;
@@ -19,7 +20,6 @@
 import org.bukkit.inventory.meta.ItemMeta;
 import org.bukkit.scheduler.BukkitTask;
 import org.eclipse.jdt.annotation.Nullable;
-import org.jetbrains.annotations.NotNull;
 
 import net.kyori.adventure.text.Component;
 import net.kyori.adventure.text.format.NamedTextColor;
@@ -31,9 +31,14 @@
 import world.bentobox.bentobox.api.configuration.WorldSettings;
 import world.bentobox.bentobox.database.objects.Island;
 import world.bentobox.bentobox.managers.IslandsManager;
+import world.bentobox.stranger.border.BorderType;
+import world.bentobox.stranger.border.PerPlayerBorderProxy;
+import world.bentobox.stranger.border.ShowBarrier;
+import world.bentobox.stranger.border.ShowWorldBorder;
 import world.bentobox.stranger.commands.admin.WorldBorderCommand;
 import world.bentobox.stranger.commands.player.ClaimCommand;
 import world.bentobox.stranger.commands.player.SpawnCommand;
+import world.bentobox.stranger.commands.player.UnclaimCommand;
 import world.bentobox.stranger.generator.NetherBiomeProvider;
 import world.bentobox.stranger.generator.NetherChunks;
 import world.bentobox.stranger.listeners.BorderShower;
@@ -93,6 +98,7 @@ public void setup()
                 super.setup();
                 // Commands
                 new ClaimCommand(this);
+                new UnclaimCommand(this);
                 new SpawnCommand(this);
             }
         };
@@ -145,6 +151,7 @@ public void onEnable() {
             Island spawn = getPlugin().getIslands().createIsland(getOverWorld().getSpawnLocation());
             if (spawn != null) {
                 spawn.setSpawn(true);
+                spawn.setSpawnPoint(Map.of(Environment.NORMAL, getOverWorld().getSpawnLocation()));
                 IslandsManager.saveIsland(spawn);
             } else {
                 this.logError("Could not make a spawn claim. You will have to set one manually in the world.");

…/world/bentobox/stranger/BorderType.java …bentobox/stranger/border/BorderType.javasrc/main/java/world/bentobox/stranger/BorderType.java renamed to src/main/java/world/bentobox/stranger/border/BorderType.java src/main/java/world/bentobox/stranger/BorderType.java renamed to src/main/java/world/bentobox/stranger/border/BorderType.java

@@ -1,4 +1,4 @@
-package world.bentobox.stranger;
+package world.bentobox.stranger.border;
 
 import java.util.Optional;
 

…tobox/stranger/PerPlayerBorderProxy.java …tranger/border/PerPlayerBorderProxy.javasrc/main/java/world/bentobox/stranger/PerPlayerBorderProxy.java renamed to src/main/java/world/bentobox/stranger/border/PerPlayerBorderProxy.java src/main/java/world/bentobox/stranger/PerPlayerBorderProxy.java renamed to src/main/java/world/bentobox/stranger/border/PerPlayerBorderProxy.java

@@ -1,8 +1,9 @@
-package world.bentobox.stranger;
+package world.bentobox.stranger.border;
 
 import org.bukkit.entity.Player;
 
 import world.bentobox.bentobox.api.user.User;
+import world.bentobox.stranger.StrangerRealms;
 import world.bentobox.stranger.listeners.BorderShower;
 
 public final class PerPlayerBorderProxy implements BorderShower {

…world/bentobox/stranger/ShowBarrier.java …entobox/stranger/border/ShowBarrier.javasrc/main/java/world/bentobox/stranger/ShowBarrier.java renamed to src/main/java/world/bentobox/stranger/border/ShowBarrier.java src/main/java/world/bentobox/stranger/ShowBarrier.java renamed to src/main/java/world/bentobox/stranger/border/ShowBarrier.java

@@ -1,4 +1,4 @@
-package world.bentobox.stranger;
+package world.bentobox.stranger.border;
 
 import java.util.HashMap;
 import java.util.HashSet;
@@ -22,6 +22,7 @@
 import world.bentobox.bentobox.api.metadata.MetaDataValue;
 import world.bentobox.bentobox.api.user.User;
 import world.bentobox.bentobox.util.Util;
+import world.bentobox.stranger.StrangerRealms;
 import world.bentobox.stranger.listeners.BorderShower;
 
 /**

…d/bentobox/stranger/ShowWorldBorder.java …box/stranger/border/ShowWorldBorder.javasrc/main/java/world/bentobox/stranger/ShowWorldBorder.java renamed to src/main/java/world/bentobox/stranger/border/ShowWorldBorder.java src/main/java/world/bentobox/stranger/ShowWorldBorder.java renamed to src/main/java/world/bentobox/stranger/border/ShowWorldBorder.java

@@ -1,4 +1,4 @@
-package world.bentobox.stranger;
+package world.bentobox.stranger.border;
 
 import java.util.Objects;
 
@@ -14,6 +14,7 @@
 import world.bentobox.bentobox.api.user.User;
 import world.bentobox.bentobox.util.Util;
 import world.bentobox.bentobox.util.teleport.SafeSpotTeleport;
+import world.bentobox.stranger.StrangerRealms;
 import world.bentobox.stranger.listeners.BorderShower;
 
 /**

src/main/java/world/bentobox/stranger/commands/player/ClaimCommand.java

@@ -70,6 +70,11 @@ public void setup() {
      */
     @Override
     public boolean canExecute(User user, String label, List<String> args) {
+        // Check if the player is in a claim
+       if (getIslands().getIslandAt(user.getLocation()).isPresent()) {
+            user.sendMessage("strangerrealms.errors.already-claimed");
+            return false;
+       }
         // Check if the island is reserved
         @Nullable
         Island island = getIslands().getPrimaryIsland(getWorld(), user.getUniqueId());
@@ -131,7 +136,9 @@ public boolean execute(User user, String label, List<String> args) {
     private boolean makeClaim(User user, String name) {
         user.sendMessage("commands.island.create.creating-island");
         try {
-            NewIsland.builder().player(user).addon(getAddon()).reason(Reason.CREATE).name(name).locationStrategy(strategy).noPaste().build();
+            NewIsland.builder().player(user).addon(getAddon()).reason(Reason.CREATE)
+            .name(name).locationStrategy(strategy)
+            .noPaste().build();
         } catch (IOException e) {
             user.sendMessage(e.getMessage());
             return false;

src/main/java/world/bentobox/stranger/commands/player/UnclaimCommand.java

@@ -0,0 +1,106 @@
+package world.bentobox.stranger.commands.player;
+
+import java.util.List;
+import java.util.Optional;
+import java.util.UUID;
+
+import org.bukkit.entity.Player;
+
+import world.bentobox.bentobox.api.commands.CompositeCommand;
+import world.bentobox.bentobox.api.commands.ConfirmableCommand;
+import world.bentobox.bentobox.api.events.IslandBaseEvent;
+import world.bentobox.bentobox.api.events.island.IslandEvent;
+import world.bentobox.bentobox.api.events.island.IslandEvent.Reason;
+import world.bentobox.bentobox.api.user.User;
+import world.bentobox.bentobox.database.objects.Island;
+import world.bentobox.bentobox.database.objects.IslandDeletion;
+import world.bentobox.stranger.StrangerRealms;
+
+/**
+ * Handles removing a claim
+ *
+ * @author tastybento
+ */
+public class UnclaimCommand extends ConfirmableCommand {
+
+    private StrangerRealms addon;
+    /**
+     * Command to create a claim
+     * 
+     * @param playerCommand - parent command
+     */
+    public UnclaimCommand(CompositeCommand playerCommand) {
+        super(playerCommand, "unclaim");
+    }
+
+    @Override
+    public void setup() {
+        setPermission("unclaim");
+        setOnlyPlayer(true);
+        setDescription("commands.unclaim.description");
+        addon = (StrangerRealms)getAddon();
+    }
+
+    /**
+     * Checks if the command can be executed by this user.
+     */
+    @Override
+    public boolean execute(User user, String label, List<String> args) {
+        // If args are not right, show help
+        if (!args.isEmpty()) {
+            showHelp(this, user);
+            return false;
+        }
+        if (!getIslands().hasIsland(getWorld(), user)) {
+            user.sendMessage("general.errors.no-island");
+            return false;
+        }
+        // Check if the player is in a claim
+        Optional<Island> opClaim =  getIslands().getIslandAt(user.getLocation())
+                .filter(is -> ((StrangerRealms)getAddon()).inWorld(is.getWorld()))
+                .filter(is -> is.getOwner() != null && is.getOwner().equals(user.getUniqueId()));
+        if (opClaim.isEmpty()) {
+            user.sendMessage("strangerrealms.errors.must-be-in");
+            return false;
+        }
+        askConfirmation(user, () -> deleteClaim(user,opClaim.get() ));
+        return true;
+    }
+
+    /**
+     * Handles the unclaim creation process.
+     * There isn't a neat way to do this through IslandsManager so it has to be done manually 
+     */
+    public boolean deleteClaim(User user, Island claim) {
+        UUID uuid = user.getUniqueId();
+        // Fire preclear event
+        IslandEvent.builder().involvedPlayer(uuid).reason(Reason.PRECLEAR).island(claim)
+        .oldIsland(claim).location(claim.getCenter()).build();
+        // Fire delete event
+        IslandBaseEvent event = IslandEvent.builder().island(claim).involvedPlayer(uuid)
+                .reason(Reason.DELETE).build();
+        if (event.getNewEvent().map(IslandBaseEvent::isCancelled).orElse(event.isCancelled())) {
+            return false;
+        }
+        // Get a list of any players in the claim
+        List<Player> players = claim.getPlayersOnIsland();
+        // Set the owner of the island to no one.
+        claim.setOwner(null);
+        // Remove players from island
+        getIslands().removePlayersFromIsland(claim);
+        // Mark island as deletable
+        claim.setDeletable(true);
+        // Remove island from the cache
+        getIslands().getIslandCache().deleteIslandFromCache(claim);
+        // Delete the island from the database
+        getIslands().deleteIslandId(claim.getUniqueId());
+        // Fire the deletion event immediately
+        IslandEvent.builder().deletedIslandInfo(new IslandDeletion(claim)).reason(Reason.DELETED).build();
+        // Tell user
+        user.sendMessage("strangerrealms.commands.unclaim.success");     
+        // Refresh borders
+        players.forEach(p -> addon.getBorderShower().showBorder(p));
+        return true;
+    }
+
+}

src/main/resources/config.yml

@@ -227,17 +227,17 @@ world:
     FROST_WALKER: 200
     LEAF_DECAY: 200
     COLLECT_LAVA: 200
-    ENDERMAN_TELEPORT: 200
+    ENDERMAN_TELEPORT: 500
     LEVER: 200
-    HURT_MONSTERS: 200
+    HURT_MONSTERS: 0
     CAKE: 200
-    FIRE_SPREAD: 200
+    FIRE_SPREAD: 500
     CHANGE_SETTINGS: 1000
     SIGN_EDITING: 200
     TRADING: 200
     EGGS: 200
     CHEST: 200
-    TNT_DAMAGE: 200
+    TNT_DAMAGE: 500
     FLINT_AND_STEEL: 200
     SCULK_SENSOR: 200
     CROP_TRAMPLE: 200
@@ -262,7 +262,7 @@ world:
     ANIMAL_SPAWNERS_SPAWN: 200
     ENCHANTING: 200
     BLOCK_EXPLODE_DAMAGE: 200
-    BOAT: 200
+    BOAT: 0
     BED: 200
     SPAWN_EGGS: 200
     MONSTER_NATURAL_SPAWN: 200
@@ -287,26 +287,26 @@ world:
     FURNACE: 200
     MONSTER_SPAWNERS_SPAWN: 200
     MINECART: 200
-    FIRE_IGNITE: 200
+    FIRE_IGNITE: 1
     FISH_SCOOPING: 200
     END_PORTAL: 200
     BREEDING: 200
     HURT_VILLAGERS: 200
     TURTLE_EGGS: 200
     BREAK_SPAWNERS: 200
-    RIDING: 200
+    RIDING: 0
     ARMOR_STAND: 200
     NAME_TAG: 200
-    ITEM_DROP: 200
+    ITEM_DROP: 0
     NOTE_BLOCK: 200
     NETHER_PORTAL: 200
     LECTERN: 200
     GRINDSTONE: 200
     SHULKER_BOX: 200
-    ITEM_PICKUP: 200
+    ITEM_PICKUP: 0
     BREWING: 200
     STONECUTTING: 200
-    FIRE_EXTINGUISH: 200
+    FIRE_EXTINGUISH: 0
     BEACON: 200
     ALLAY: 200
     PRESSURE_PLATE: 200

src/main/resources/locales/en-US.yml

@@ -11,8 +11,9 @@ strangerrealms:
     Islands: Claims
   teleporting-to-spawn: "&c You were outside the border. Teleported to spawn.."
   errors:
-    not-in-world: "&c You must be in the world to claim"
+    not-in-world: "&c You must be in the world to claim."
     already-claimed: "&c This location is already claimed!"
+    must-be-in: "&c You must be in your claim to do that."
     overlap: "&c You cannot make a claim here because it would overlap another claim
       at [xyz]."
     too-close-to-spawn: "&c You are too close to spawn to make a claim. Move further out."
@@ -36,6 +37,9 @@ strangerrealms:
                 needs-value: "&c Set needs an integer value for the size of the world border"          
     claim:
         description: "Attemtps to make a claim"
+    unclaim:
+        description: "Removes a claim"
+        success: "&a Your claim was removed successfully"
     island:
       create:
         creating-island: "&a Trying to claim..."