More configuration option for respawning

Author: benwoo1110

src/main/java/org/mvplugins/multiverse/core/api/MVConfig.java

@@ -166,13 +166,17 @@ public interface MVConfig {
      * Sets defaultRespawnToWorldSpawn.
      * @param defaultRespawnToWorldSpawn The new value
      */
-    void setDefaultRespawnToWorldSpawn(boolean defaultRespawnToWorldSpawn);
+    void setDefaultRespawnWithinSameWorld(boolean defaultRespawnToWorldSpawn);
 
     /**
      * Gets defaultRespawnToWorldSpawn
      * @return defaultRespawnToWorldSpawn
      */
-    boolean getDefaultRespawnToWorldSpawn();
+    boolean getDefaultRespawnWithinSameWorld();
+
+    void setEnforceRespawnAtWorldSpawn(boolean enforceRespawnAtWorldSpawn);
+
+    boolean getEnforceRespawnAtWorldSpawn();
 
     /**
      * Sets whether or not to let Bukkit determine portal search radius on its own or if Multiverse should give input.

src/main/java/org/mvplugins/multiverse/core/config/MVCoreConfig.java

@@ -78,6 +78,9 @@ public class MVCoreConfig implements MVConfig {
                                 .addAction(MoveMigratorAction.of("world.teleport-intercept", "teleport.teleport-intercept"))
                                 .addAction(MoveMigratorAction.of("world.resolve-alias-name", "command.resolve-alias-name"))
                                 .build())
+                        .addVersionMigrator(VersionMigrator.builder(5.2)
+                                .addAction(MoveMigratorAction.of("spawn.default-respawn-to-world-spawn", "world.enforce-respawn-at-world-spawn"))
+                                .build())
                         .build())
                 .build();
         this.stringPropertyHandle = new StringPropertyHandle(configHandle);
@@ -245,13 +248,23 @@ public String getJoinDestination() {
     }
 
     @Override
-    public void setDefaultRespawnToWorldSpawn(boolean defaultRespawnToWorldSpawn) {
-        configHandle.set(configNodes.DEFAULT_RESPAWN_TO_WORLD_SPAWN, defaultRespawnToWorldSpawn);
+    public void setDefaultRespawnWithinSameWorld(boolean defaultRespawnToWorldSpawn) {
+        configHandle.set(configNodes.DEFAULT_RESPAWN_WITHIN_SAME_WORLD, defaultRespawnToWorldSpawn);
+    }
+
+    @Override
+    public boolean getDefaultRespawnWithinSameWorld() {
+        return configHandle.get(configNodes.DEFAULT_RESPAWN_WITHIN_SAME_WORLD);
+    }
+
+    @Override
+    public void setEnforceRespawnAtWorldSpawn(boolean enforceRespawnAtWorldSpawn) {
+        configHandle.set(configNodes.ENFORCE_RESPAWN_AT_WORLD_SPAWN, enforceRespawnAtWorldSpawn);
     }
 
     @Override
-    public boolean getDefaultRespawnToWorldSpawn() {
-        return configHandle.get(configNodes.DEFAULT_RESPAWN_TO_WORLD_SPAWN);
+    public boolean getEnforceRespawnAtWorldSpawn() {
+        return configHandle.get(configNodes.ENFORCE_RESPAWN_AT_WORLD_SPAWN);
     }
 
     @Override

src/main/java/org/mvplugins/multiverse/core/config/MVCoreConfigNodes.java

@@ -185,14 +185,34 @@ private <N extends Node> N node(N node) {
             .name("join-destination")
             .build());
 
-    final ConfigNode<Boolean> DEFAULT_RESPAWN_TO_WORLD_SPAWN = node(ConfigNode.builder("spawn.default-respawn-to-world-spawn", Boolean.class)
+    final ConfigNode<Boolean> DEFAULT_RESPAWN_WITHIN_SAME_WORLD = node(ConfigNode.builder("spawn.default-respawn-within-same-world", Boolean.class)
+            .comment("")
+            .comment("This only applies if the `respawn-world` property is not set for the world that the player died in,")
+            .comment("and the player does not have bed or anchor set.")
+            .comment("----")
+            .comment("When this option is enabled, players will respawn in the same world's that they died in.")
+            .comment("If the /spawnpoint is already within that world and `enforce-respawn-at-world-spawn` is disabled,")
+            .comment("Multiverse will use that spawn location, else it will use the world's spawn where the player died in.")
+            .comment("----")
+            .comment("You can set `respawn-world` property with the command: `/mv modify <worldname> set respawn-world <worldname>`")
+            .comment("You can reset `respawn-world` property with the command: `/mv modify <worldname> reset respawn-world`")
+            .comment("----")
+            .comment("Set this to false if you want another plugin to handle respawning.")
+            .defaultValue(true)
+            .name("default-respawn-within-same-world")
+            .build());
+
+    final ConfigNode<Boolean> ENFORCE_RESPAWN_AT_WORLD_SPAWN = node(ConfigNode.builder("spawn.enforce-respawn-at-world-spawn", Boolean.class)
             .comment("")
-            .comment("By default when `respawn-world` is not set, players will respawn at the world's spawn location that they died in.")
-            .comment("If you want another plugin to handle respawn, or use vanilla /spawnpoint, set this to false.")
-            .comment("This only applies if the `respawn-world` property is not set for the world that the player died in.")
-            .comment("You can set `respawn-world` property by running the command: `/mv modify <worldname> set respawn-world <worldname>`")
+            .comment("This config will only apply if `respawn-world` is set, or `default-respawn-within-same-world` is enabled.")
+            .comment("----")
+            .comment("When this option is enabled, players will always respawn at the world's spawn location of `respawn-world`,")
+            .comment("unless bed or anchor is set and `bed-respawn` or `anchor-spawn` is enabled respectively.")
+            .comment("If respawn-world is set, Multiverse will use that world's spawn location, else it will use the world's spawn where the player died in.")
+            .comment("----")
+            .comment("Set this to false if you want to use the /spawnpoint instead of the world's spawn location.")
             .defaultValue(true)
-            .name("default-respawn-to-world-spawn")
+            .name("enforce-respawn-at-world-spawn")
             .build());
 
     private final ConfigHeaderNode PORTAL_HEADER = node(ConfigHeaderNode.builder("portal")

src/main/java/org/mvplugins/multiverse/core/listeners/MVPlayerListener.java

@@ -14,7 +14,6 @@
 import io.vavr.control.Option;
 import jakarta.inject.Inject;
 import jakarta.inject.Provider;
-import org.bukkit.Bukkit;
 import org.bukkit.Location;
 import org.bukkit.Material;
 import org.bukkit.Server;
@@ -132,31 +131,37 @@ public void playerRespawn(PlayerRespawnEvent event) {
                         Logging.fine("Spawning %s at their anchor.", player.getName());
                         return false;
                     }
-                    if (!config.getDefaultRespawnToWorldSpawn() && mvWorld.getRespawnWorldName().isBlank()) {
+                    if (!config.getDefaultRespawnWithinSameWorld() && mvWorld.getRespawnWorldName().isEmpty()) {
                         Logging.fine("Not overriding respawn location for player '%s' as " +
-                                "default-respawn-to-world-spawn is disabled and no respawn-world is set.", player.getName());
+                                "default-respawn-within-same-world is disabled and no respawn-world is set.", player.getName());
                         return false;
                     }
                     return true;
                 })
-                .flatMap(mvWorld -> getMostAccurateRespawnLocation (player, mvWorld))
+                .flatMap(mvWorld -> getMostAccurateRespawnLocation(player, mvWorld, event.getRespawnLocation()))
                 .peek(newRespawnLocation -> {
                     MVRespawnEvent respawnEvent = new MVRespawnEvent(newRespawnLocation, event.getPlayer(), "compatability");
                     this.server.getPluginManager().callEvent(respawnEvent);
                     event.setRespawnLocation(respawnEvent.getPlayersRespawnLocation());
                 });
     }
 
-    private Option<Location> getMostAccurateRespawnLocation(Player player, LoadedMultiverseWorld mvWorld) {
-        return Option.of(mvWorld.getRespawnWorldName().isBlank()
+    private Option<Location> getMostAccurateRespawnLocation(Player player, LoadedMultiverseWorld mvWorld, Location defaultRespawnLocation) {
+        return Option.of(mvWorld.getRespawnWorldName().isEmpty()
                         ? player.getWorld()
                         : server.getWorld(mvWorld.getRespawnWorldName()))
                 .onEmpty(() -> Logging.warning("World '%s' has respawn-world property of '%s' that does not exist!",
                         player.getWorld().getName(), mvWorld.getRespawnWorldName()))
-                .map(newRespawnWorld -> getWorldManager()
-                        .getLoadedWorld(newRespawnWorld)
-                        .map(newMVRespawnWorld -> (Location) newMVRespawnWorld.getSpawnLocation())
-                        .getOrElse(newRespawnWorld::getSpawnLocation));
+                .map(newRespawnWorld -> {
+                    if (!config.getEnforceRespawnAtWorldSpawn() && newRespawnWorld.equals(defaultRespawnLocation.getWorld())) {
+                        Logging.fine("Respawn location is within same world as respawn-world, not overriding.");
+                        return defaultRespawnLocation;
+                    }
+                    return getWorldManager()
+                            .getLoadedWorld(newRespawnWorld)
+                            .map(newMVRespawnWorld -> (Location) newMVRespawnWorld.getSpawnLocation())
+                            .getOrElse(newRespawnWorld::getSpawnLocation);
+                });
     }
 
     @EventHandler