Merge pull request #58 from ez-plugins/57-rtp-without-gui-auto-world-current

ez-plugins · web-flow · commit bfb74597fd34 · 2026-04-14T20:43:52.000+02:00
57 rtp without gui auto world current
diff --git a/ezrtp-common/src/main/java/com/skyblockexp/ezrtp/command/ForceRtpCommand.java b/ezrtp-common/src/main/java/com/skyblockexp/ezrtp/command/ForceRtpCommand.java
@@ -71,12 +71,21 @@ public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command
             worldName = forceConfig.getDefaultWorld();
         }
 
+        // Resolve "auto" to the target player's current world
+        if ("auto".equalsIgnoreCase(worldName)) {
+            worldName = target.getWorld().getName();
+        }
+
         EzRtpConfiguration configuration = configurationSupplier.get();
         RandomTeleportSettings settings = configuration != null ? configuration.getSettingsForWorld(worldName) : null;
         if (settings == null) {
             com.skyblockexp.ezrtp.util.MessageUtil.send(sender, plugin.getMessageProvider().format(MessageKey.FORCERTP_WORLD_MISSING, Map.of("world", worldName != null ? worldName : "default")));
             return false;
         }
+        // If getSettingsForWorld returned fallback defaults for a different world, override the world name
+        if (!worldName.equals(settings.getWorldName())) {
+            settings = settings.withWorldName(worldName);
+        }
 
         RandomTeleportService service = teleportServiceSupplier.get();
         if (service == null) {
@@ -114,8 +123,9 @@ public List<String> onTabComplete(@NotNull CommandSender sender, @NotNull Comman
         }
 
         if (args.length == 2) {
-            // Suggest world names
+            // Suggest world names and the special "auto" sentinel
             List<String> suggestions = new ArrayList<>();
+            suggestions.add("auto");
             for (org.bukkit.World world : Bukkit.getWorlds()) {
                 suggestions.add(world.getName());
             }
diff --git a/ezrtp-common/src/main/java/com/skyblockexp/ezrtp/command/subcommands/ForcertpSubcommand.java b/ezrtp-common/src/main/java/com/skyblockexp/ezrtp/command/subcommands/ForcertpSubcommand.java
@@ -58,12 +58,21 @@ public boolean execute(@NotNull CommandSender sender, @NotNull String[] args) {
         // Parse optional world argument
         String worldName = args.length >= 2 ? args[1] : null;
 
+        // Resolve "auto" to the target player's current world
+        if ("auto".equalsIgnoreCase(worldName)) {
+            worldName = target.getWorld().getName();
+        }
+
         EzRtpConfiguration configuration = configurationSupplier.get();
         RandomTeleportSettings settings = configuration != null ? configuration.getSettingsForWorld(worldName) : null;
         if (settings == null) {
             MessageUtil.send(sender, plugin.getMessageProvider().format(MessageKey.FORCERTP_WORLD_MISSING, Map.of("world", worldName != null ? worldName : "default")));
             return false;
         }
+        // If getSettingsForWorld returned fallback defaults for a different world, override the world name
+        if (worldName != null && !worldName.equals(settings.getWorldName())) {
+            settings = settings.withWorldName(worldName);
+        }
 
         RandomTeleportService service = teleportServiceSupplier.get();
         if (service == null) {
@@ -97,8 +106,9 @@ public List<String> tabComplete(@NotNull CommandSender sender, @NotNull String[]
         }
 
         if (args.length == 2) {
-            // Suggest world names
+            // Suggest world names and the special "auto" sentinel
             List<String> suggestions = new ArrayList<>();
+            suggestions.add("auto");
             for (org.bukkit.World world : Bukkit.getWorlds()) {
                 suggestions.add(world.getName());
             }
diff --git a/ezrtp-common/src/main/java/com/skyblockexp/ezrtp/config/RandomTeleportSettings.java b/ezrtp-common/src/main/java/com/skyblockexp/ezrtp/config/RandomTeleportSettings.java
@@ -156,6 +156,32 @@ public boolean isHeatmapEnabled() {
         return configSection != null && configSection.getBoolean("heatmap.enabled", false);
     }
 
+    /**
+     * Returns {@code true} when the configured world name is the special sentinel value {@code "auto"},
+     * meaning the player's current world should be used as the teleport destination world.
+     */
+    public boolean isAutoWorld() {
+        return "auto".equalsIgnoreCase(worldName);
+    }
+
+    /**
+     * Returns a new {@link RandomTeleportSettings} identical to this one, except with the given world name.
+     * Used to resolve {@code world: auto} to the player's actual current world at teleport time.
+     */
+    public RandomTeleportSettings withWorldName(String newWorldName) {
+        return new RandomTeleportSettings(
+                configSection, newWorldName, centerX, centerZ, minimumRadius, maximumRadius,
+                maxAttempts, useWorldBorderRadius, unsafeBlocks,
+                messages, particleSettings, onJoinTeleportSettings,
+                countdownBossBarSettings, countdownParticleSettings,
+                teleportCost, countdownSeconds, countdownChatMessagesEnabled, debugRejectionLogging,
+                minY, maxY, biomeInclude, biomeExclude,
+                protectionSettings, preCacheSettings, rareBiomeOptimizationSettings,
+                chunkLoadingSettings, enableFallbackToCache, biomeSearchSettings,
+                biomeFilteringEnabled, biomeSystemEnabled, safetySettings,
+                searchPattern, chunkyIntegrationSettings);
+    }
+
     public static RandomTeleportSettings fromConfiguration(ConfigurationSection section, java.util.logging.Logger logger) {
         if (section == null) {
             return new RandomTeleportSettings(null, "world", 0, 0, 100, 1000, 10, false, java.util.Collections.emptySet(),
diff --git a/ezrtp-common/src/main/java/com/skyblockexp/ezrtp/gui/GuiOptionsBuilder.java b/ezrtp-common/src/main/java/com/skyblockexp/ezrtp/gui/GuiOptionsBuilder.java
@@ -68,7 +68,12 @@ private void addWorldOptions(Inventory inventory,
                 continue;
             }
 
-            boolean bypass = hasBypass(player, option.getSettings().getWorldName());
+            // Resolve "auto" to the player's current world for permission and cooldown checks
+            String worldForChecks =
+                    option.getSettings().isAutoWorld()
+                            ? player.getWorld().getName()
+                            : option.getSettings().getWorldName();
+            boolean bypass = hasBypass(player, worldForChecks);
 
             CooldownInfo cooldownInfo = bypass ? CooldownInfo.inactive() : evaluateCooldown(option);
             if (cooldownInfo.active() && !configuration.isAllowGuiDuringCooldown()) {
@@ -94,13 +99,17 @@ private void addWorldOptions(Inventory inventory,
     }
 
     private CooldownInfo evaluateCooldown(GuiWorldOption option) {
-        RtpLimitSettings limit = configuration.getLimitSettings(
-                option.getSettings().getWorldName(), null);
+        // Resolve "auto" to the player's current world so storage lookups use the real world key
+        String worldName =
+                option.getSettings().isAutoWorld()
+                        ? player.getWorld().getName()
+                        : option.getSettings().getWorldName();
+        RtpLimitSettings limit = configuration.getLimitSettings(worldName, null);
         if (limit == null || limit.getCooldownSeconds() <= 0) {
             return CooldownInfo.inactive();
         }
 
-        long lastRtp = usageStorage.getLastRtpTime(player.getUniqueId(), option.getSettings().getWorldName());
+        long lastRtp = usageStorage.getLastRtpTime(player.getUniqueId(), worldName);
         if (lastRtp <= 0) {
             return CooldownInfo.inactive();
         }
@@ -134,8 +143,13 @@ private boolean meetsCacheRequirements(GuiWorldOption option) {
             return false;
         }
 
+        // Resolve "auto" to the player's current world for cache lookup
+        String worldName =
+                option.getSettings().isAutoWorld()
+                        ? player.getWorld().getName()
+                        : option.getSettings().getWorldName();
         return biomeCache.getCachedLocationCount(
-                org.bukkit.Bukkit.getWorld(option.getSettings().getWorldName()),
+                org.bukkit.Bukkit.getWorld(worldName),
                 option.getSettings().getBiomeInclude()) >= option.getMinimumCached();
     }
 
diff --git a/ezrtp-common/src/main/java/com/skyblockexp/ezrtp/gui/RandomTeleportGuiManager.java b/ezrtp-common/src/main/java/com/skyblockexp/ezrtp/gui/RandomTeleportGuiManager.java
@@ -228,7 +228,8 @@ public void onInventoryClick(InventoryClickEvent event) {
                 return;
             }
 
-            String worldName = settings.getWorldName();
+            // Resolve "auto" to the player's actual current world for limit checking and usage tracking
+            String worldName = settings.isAutoWorld() ? player.getWorld().getName() : settings.getWorldName();
             boolean bypass = player.isOp();
             if (!bypass) {
                 for (String perm : configuration.getBypassPermissions()) {
diff --git a/ezrtp-common/src/main/java/com/skyblockexp/ezrtp/teleport/TeleportExecutor.java b/ezrtp-common/src/main/java/com/skyblockexp/ezrtp/teleport/TeleportExecutor.java
@@ -180,10 +180,13 @@ private void performTeleport(Player player,
                                  TeleportReason reason,
                                  Consumer<Boolean> callback,
                                  Runnable completionHook) {
-        World world = plugin.getServer().getWorld(teleportSettings.getWorldName());
+        final RandomTeleportSettings effectiveSettings = teleportSettings.isAutoWorld()
+                ? teleportSettings.withWorldName(player.getWorld().getName())
+                : teleportSettings;
+        World world = plugin.getServer().getWorld(effectiveSettings.getWorldName());
         if (world == null) {
             com.skyblockexp.ezrtp.util.MessageUtil.send(player, messageProvider.format(MessageKey.WORLD_MISSING,
-                Map.of("world", teleportSettings.getWorldName()), player));
+                Map.of("world", effectiveSettings.getWorldName()), player));
             if (callback != null) callback.accept(false);
             if (completionHook != null) completionHook.run();
             return;
@@ -196,9 +199,9 @@ private void performTeleport(Player player,
         }
 
         long startTime = System.currentTimeMillis();
-        CompletableFuture<SearchResult> locationSearchFuture = locationFinder.findSafeLocationAsync(world, teleportSettings);
-        boolean rareSearch = locationFinder.isRareSearch(teleportSettings);
-        long searchTimeoutMillis = resolveSearchTimeoutMillis(teleportSettings, rareSearch);
+        CompletableFuture<SearchResult> locationSearchFuture = locationFinder.findSafeLocationAsync(world, effectiveSettings);
+        boolean rareSearch = locationFinder.isRareSearch(effectiveSettings);
+        long searchTimeoutMillis = resolveSearchTimeoutMillis(effectiveSettings, rareSearch);
         CompletableFuture<SearchResult> completionFuture = locationSearchFuture;
         if (searchTimeoutMillis > 0) {
             completionFuture = locationSearchFuture.orTimeout(searchTimeoutMillis, TimeUnit.MILLISECONDS);
@@ -215,21 +218,21 @@ private void performTeleport(Player player,
 
                 try {
                     if (throwable != null || result == null || result.location().isEmpty()) {
-                        if (throwable != null && teleportSettings.isDebugRejectionLoggingEnabled()) {
+                        if (throwable != null && effectiveSettings.isDebugRejectionLoggingEnabled()) {
                             plugin.getLogger().warning("EzRTP debug: location search failed for player '"
                                     + player.getName() + "' in world '" + world.getName() + "' after "
                                     + duration + "ms: " + throwable.getClass().getSimpleName() + " - "
                                     + throwable.getMessage());
                         }
-                        resultHandler.handleFailure(player, teleportSettings, result, duration, biome, cacheHit, cacheChecked);
+                        resultHandler.handleFailure(player, effectiveSettings, result, duration, biome, cacheHit, cacheChecked);
                         if (callback != null) callback.accept(false);
                         return;
                     }
 
                     validLocation = result.location().get();
 
                     if (!player.isOnline()) {
-                        locationFinder.cacheValidLocation(validLocation, teleportSettings);
+                        locationFinder.cacheValidLocation(validLocation, effectiveSettings);
                         statistics.recordPlayerOfflineOrCancelledFailure();
                         statistics.recordAttempt(false, duration, biome, cacheHit, cacheChecked);
                         if (callback != null) callback.accept(false);
@@ -248,15 +251,15 @@ private void performTeleport(Player player,
                         return;
                     }
 
-                    Location destination = TeleportDestinationAdjuster.adjustForSafety(validLocation, teleportSettings);
+                    Location destination = TeleportDestinationAdjuster.adjustForSafety(validLocation, effectiveSettings);
                     biome = destination.getBlock().getBiome();
                     Location oldLocation = player.getLocation(); // Store old location before teleport
                     success = player.teleport(destination);
 
                     if (success) {
-                        resultHandler.handleSuccess(player, destination, result, teleportSettings, duration, biome, cacheHit, cacheChecked, validLocation);
+                        resultHandler.handleSuccess(player, destination, result, effectiveSettings, duration, biome, cacheHit, cacheChecked, validLocation);
                     } else {
-                        locationFinder.cacheValidLocation(validLocation, teleportSettings);
+                        locationFinder.cacheValidLocation(validLocation, effectiveSettings);
                         com.skyblockexp.ezrtp.util.MessageUtil.send(player, messageProvider.format(MessageKey.TELEPORT_FAILED, player));
                         statistics.recordTeleportApiFailure();
                         statistics.recordAttempt(false, duration, biome, cacheHit, cacheChecked);
diff --git a/ezrtp-common/src/test/java/com/skyblockexp/ezrtp/config/RandomTeleportSettingsAutoWorldTest.java b/ezrtp-common/src/test/java/com/skyblockexp/ezrtp/config/RandomTeleportSettingsAutoWorldTest.java
@@ -0,0 +1,94 @@
+package com.skyblockexp.ezrtp.config;
+
+import org.bukkit.configuration.file.YamlConfiguration;
+import org.junit.jupiter.api.Test;
+
+import java.util.logging.Logger;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+class RandomTeleportSettingsAutoWorldTest {
+
+    private static final Logger LOGGER = Logger.getLogger("RandomTeleportSettingsAutoWorldTest");
+
+    @Test
+    void isAutoWorldFalseByDefault() {
+        YamlConfiguration config = new YamlConfiguration();
+
+        RandomTeleportSettings settings = RandomTeleportSettings.fromConfiguration(config, LOGGER);
+
+        assertFalse(settings.isAutoWorld(),
+                "isAutoWorld() should be false when no world key is present");
+    }
+
+    @Test
+    void isAutoWorldFalseForExplicitWorld() {
+        YamlConfiguration config = new YamlConfiguration();
+        config.set("world", "myworld");
+
+        RandomTeleportSettings settings = RandomTeleportSettings.fromConfiguration(config, LOGGER);
+
+        assertFalse(settings.isAutoWorld(),
+                "isAutoWorld() should be false for an explicit world name");
+    }
+
+    @Test
+    void isAutoWorldTrueForAutoLowercase() {
+        YamlConfiguration config = new YamlConfiguration();
+        config.set("world", "auto");
+
+        RandomTeleportSettings settings = RandomTeleportSettings.fromConfiguration(config, LOGGER);
+
+        assertTrue(settings.isAutoWorld(),
+                "isAutoWorld() should be true when world is 'auto'");
+    }
+
+    @Test
+    void isAutoWorldTrueForAutoUppercase() {
+        YamlConfiguration config = new YamlConfiguration();
+        config.set("world", "AUTO");
+
+        RandomTeleportSettings settings = RandomTeleportSettings.fromConfiguration(config, LOGGER);
+
+        assertTrue(settings.isAutoWorld(),
+                "isAutoWorld() should be true when world is 'AUTO' (case-insensitive)");
+    }
+
+    @Test
+    void withWorldNameReplacesWorldName() {
+        YamlConfiguration config = new YamlConfiguration();
+        config.set("world", "auto");
+
+        RandomTeleportSettings original = RandomTeleportSettings.fromConfiguration(config, LOGGER);
+        RandomTeleportSettings resolved = original.withWorldName("farm_nether");
+
+        assertEquals("farm_nether", resolved.getWorldName(),
+                "withWorldName() should set the new world name");
+        assertFalse(resolved.isAutoWorld(),
+                "isAutoWorld() should return false after withWorldName() replaces the sentinel");
+    }
+
+    @Test
+    void withWorldNamePreservesOtherFields() {
+        YamlConfiguration config = new YamlConfiguration();
+        config.set("world", "auto");
+        config.set("radius.min", 200);
+        config.set("radius.max", 3000);
+        config.set("max-attempts", 20);
+        config.set("search-pattern", "circle");
+
+        RandomTeleportSettings original = RandomTeleportSettings.fromConfiguration(config, LOGGER);
+        RandomTeleportSettings resolved = original.withWorldName("some_world");
+
+        assertEquals(200, resolved.getMinimumRadius(),
+                "withWorldName() should preserve minimumRadius");
+        assertEquals(3000, resolved.getMaximumRadius(),
+                "withWorldName() should preserve maximumRadius");
+        assertEquals(20, resolved.getMaxAttempts(),
+                "withWorldName() should preserve maxAttempts");
+        assertEquals(com.skyblockexp.ezrtp.config.teleport.SearchPattern.CIRCLE, resolved.getSearchPattern(),
+                "withWorldName() should preserve searchPattern");
+    }
+}
diff --git a/src/main/resources/force-rtp.yml b/src/main/resources/force-rtp.yml
@@ -1,7 +1,8 @@
 # Force RTP configuration
 # This file controls the behavior of the /forcertp command
 
-# Default world to use when no world is specified
+# Default world to use when no world is specified.
+# Set to a world name (e.g. 'world') or 'auto' to use the target player's current world.
 default-world: world
 
 # Bypass settings for the /forcertp command
diff --git a/src/main/resources/gui.yml b/src/main/resources/gui.yml
@@ -33,6 +33,20 @@ filler:
   material: GLASS_PANE
   name: "<dark_gray> </dark_gray>"
 worlds:
+  # "Current world" option — teleports the player within whichever world they are currently in.
+  # Useful on multi-world servers so a single button always works regardless of where the player is.
+  # Uncomment and adjust the slot/icon to add it to your GUI.
+  # current-world:
+  #   slot: 13
+  #   permission: ""
+  #   icon:
+  #     material: COMPASS
+  #     name: "<aqua><bold>Current World</bold></aqua>"
+  #     lore:
+  #       - "<gray>Teleport randomly within</gray>"
+  #       - "<gray>your current world.</gray>"
+  #   settings:
+  #     world: auto
   overworld:
     # Slot within the GUI (0-53). When omitted entries are placed in order.
     slot: 22
diff --git a/src/main/resources/rtp.yml b/src/main/resources/rtp.yml
@@ -15,6 +15,8 @@ rtp:
 # Optional: restrict random teleport Y-levels (inclusive).
 min-y: 54
 max-y: 320
+# World to teleport players into. Use a world name (e.g. 'world') to always RTP to that world,
+# or set to 'auto' to teleport players within their current world (useful for multi-world servers).
 world: world
 center:
   x: 0

Original file line number	Diff line number	Diff line change
`@@ -228,7 +228,8 @@ public void onInventoryClick(InventoryClickEvent event) {`
`228`	`228`	`return;`
`229`	`229`	`}`
`230`	`230`
`231`		`- String worldName = settings.getWorldName();`
	`231`	`+ // Resolve "auto" to the player's actual current world for limit checking and usage tracking`
	`232`	`+ String worldName = settings.isAutoWorld() ? player.getWorld().getName() : settings.getWorldName();`
`232`	`233`	`boolean bypass = player.isOp();`
`233`	`234`	`if (!bypass) {`
`234`	`235`	`for (String perm : configuration.getBypassPermissions()) {`