V5.7

build.gradle

@@ -27,7 +27,7 @@ repositories {
 configure(apiDependencies) {
     serverApiVersion = '1.21.11-R0.1-SNAPSHOT'
     mockBukkitServerApiVersion = '1.21'
-    mockBukkitVersion = '4.100.0'
+    mockBukkitVersion = '4.110.0'
 }
 
 dependencies {

src/main/java/org/mvplugins/multiverse/core/MultiverseCoreApi.java

@@ -24,7 +24,7 @@
 /**
  * Provides access to the MultiverseCore API.
  */
-public class MultiverseCoreApi {
+public final class MultiverseCoreApi {
 
     private static MultiverseCoreApi instance;
     private static final List<Consumer<MultiverseCoreApi>> whenLoadedCallbacks = new ArrayList<>();

src/main/java/org/mvplugins/multiverse/core/command/MVCommandCompletions.java

@@ -52,6 +52,7 @@
 import org.mvplugins.multiverse.core.world.WorldManager;
 import org.mvplugins.multiverse.core.world.generators.GeneratorPlugin;
 import org.mvplugins.multiverse.core.world.generators.GeneratorProvider;
+import org.mvplugins.multiverse.core.world.helpers.PotentialWorldFinder;
 
 import static org.mvplugins.multiverse.core.utils.StringFormatter.addOnToCommaSeparated;
 
@@ -65,6 +66,7 @@ public class MVCommandCompletions extends PaperCommandCompletions {
     private final CorePermissionsChecker corePermissionsChecker;
     private final AnchorManager anchorManager;
     private final GeneratorProvider generatorProvider;
+    private final PotentialWorldFinder potentialWorldFinder;
 
     @Inject
     MVCommandCompletions(
@@ -74,7 +76,8 @@ public class MVCommandCompletions extends PaperCommandCompletions {
             @NotNull CoreConfig config,
             @NotNull CorePermissionsChecker corePermissionsChecker,
             @NotNull AnchorManager anchorManager,
-            @NotNull GeneratorProvider generatorProvider
+            @NotNull GeneratorProvider generatorProvider,
+            @NotNull PotentialWorldFinder potentialWorldFinder
     ) {
         super(mvCommandManager);
         this.commandManager = mvCommandManager;
@@ -84,6 +87,7 @@ public class MVCommandCompletions extends PaperCommandCompletions {
         this.corePermissionsChecker = corePermissionsChecker;
         this.anchorManager = anchorManager;
         this.generatorProvider = generatorProvider;
+        this.potentialWorldFinder = potentialWorldFinder;
 
         registerAsyncCompletion("anchornames", this::suggestAnchorNames);
         registerAsyncCompletion("commands", this::suggestCommands);
@@ -297,7 +301,7 @@ private Collection<String> suggestMVWorlds(BukkitCommandCompletionContext contex
                         .toList();
             }
             case "potential" -> {
-                return worldManager.getPotentialWorlds();
+                return potentialWorldFinder.findPotentialWorlds();
             }
         }
         Logging.severe("Invalid MVWorld scope: " + scope);

src/main/java/org/mvplugins/multiverse/core/command/MVCommandContexts.java

@@ -42,6 +42,7 @@
 import org.mvplugins.multiverse.core.locale.message.Message;
 import org.mvplugins.multiverse.core.utils.PlayerFinder;
 import org.mvplugins.multiverse.core.utils.REPatterns;
+import org.mvplugins.multiverse.core.utils.tick.TickDuration;
 import org.mvplugins.multiverse.core.world.LoadedMultiverseWorld;
 import org.mvplugins.multiverse.core.world.MultiverseWorld;
 import org.mvplugins.multiverse.core.world.WorldManager;
@@ -93,6 +94,7 @@ public class MVCommandContexts extends PaperCommandContexts {
         registerIssuerAwareContext(PlayerArrayValue.class, playerArrayContextBuilder().generateContext(PlayerArrayValue::new));
         registerIssuerAwareContext(PlayerLocation.class, this::parsePlayerLocation);
         registerContext(SpawnCategory[].class, this::parseSpawnCategories);
+        registerContext(TickDuration.class, this::parseTickDuration);
     }
 
     private MVCommandIssuer parseMVCommandIssuer(BukkitCommandExecutionContext context) {
@@ -393,4 +395,13 @@ private SpawnCategory[] parseSpawnCategories(BukkitCommandExecutionContext conte
         }
         return categories.toArray(new SpawnCategory[0]);
     }
+
+    private TickDuration parseTickDuration(BukkitCommandExecutionContext context) {
+        String arg = context.popFirstArg();
+        return TickDuration.parseString(arg)
+                .getOrElseThrow(failure ->
+                        new InvalidCommandArgument("Invalid time duration format: \"" +arg + "\". Use a number " +
+                                "followed by an optional suffix (s for seconds, d for game days) or just a number " +
+                                "for ticks. Examples: 100, 5s, 2d"));
+    }
 }

src/main/java/org/mvplugins/multiverse/core/command/flag/CommandValueFlag.java

@@ -5,8 +5,10 @@
 import java.util.List;
 import java.util.Locale;
 import java.util.function.Function;
+import java.util.function.Supplier;
 
 import co.aikar.commands.InvalidCommandArgument;
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -40,34 +42,34 @@ public class CommandValueFlag<T> extends CommandFlag {
 
     private final Class<T> type;
     private final boolean optional;
-    private final T defaultValue;
+    private final Supplier<? extends T> defaultValueSupplier;
     private final Function<String, T> context;
     private final Function<String, Collection<String>>  completion;
 
     /**
      * Creates a new flag.
      *
-     * @param key               The key for the new flag.
-     * @param aliases           The aliases that also refer to this flag.
-     * @param type              The type of the value.
-     * @param optional          Allow for flag without value.
-     * @param defaultValue      The default value if optional is true and user does not specify a value.
-     * @param context           Function to parse string into value type.
-     * @param completion        Function to get completion for this flag.
+     * @param key                   The key for the new flag.
+     * @param aliases               The aliases that also refer to this flag.
+     * @param type                  The type of the value.
+     * @param optional              Allow for flag without value.
+     * @param defaultValueSupplier  The default value if optional is true and user does not specify a value.
+     * @param context               Function to parse string into value type.
+     * @param completion            Function to get completion for this flag.
      */
     protected CommandValueFlag(
             @NotNull String key,
             @NotNull List<String> aliases,
             @NotNull Class<T> type,
             boolean optional,
-            @Nullable T defaultValue,
+            @Nullable Supplier<? extends T> defaultValueSupplier,
             @Nullable Function<String, T> context,
             @Nullable Function<String, Collection<String>>  completion
     ) {
         super(key, aliases);
         this.type = type;
         this.optional = optional;
-        this.defaultValue = defaultValue;
+        this.defaultValueSupplier = defaultValueSupplier;
         this.context = context;
         this.completion = completion;
     }
@@ -96,7 +98,7 @@ public boolean isOptional() {
      * @return The default value.
      */
     public @Nullable T getDefaultValue() {
-        return defaultValue;
+        return defaultValueSupplier == null ? null : defaultValueSupplier.get();
     }
 
     /**
@@ -126,7 +128,7 @@ public boolean isOptional() {
     public static class Builder<T, S extends Builder<T, S>> extends CommandFlag.Builder<S> {
         protected final Class<T> type;
         protected boolean optional = false;
-        protected T defaultValue = null;
+        protected Supplier<? extends T> defaultValueSupplier = null;
         protected Function<String, T> context = null;
         protected Function<String, Collection<String>> completion = null;
 
@@ -158,7 +160,21 @@ public Builder(@NotNull String key, @NotNull Class<T> type) {
          * @return The builder.
          */
         public @NotNull S defaultValue(@NotNull T defaultValue) {
-            this.defaultValue = defaultValue;
+            return defaultValue(() -> defaultValue);
+        }
+
+        /**
+         * Set the default value supplier. Used if optional is true and user does not specify a value.
+         * Supplier is only called when command is executed with the flag is present in input.
+         *
+         * @param defaultValueSupplier The default value supplier
+         * @return The builder
+         *
+         * @since 5.7
+         */
+        @ApiStatus.AvailableSince("5.7")
+        public @NotNull S defaultValue(@NotNull Supplier<? extends T> defaultValueSupplier) {
+            this.defaultValueSupplier = defaultValueSupplier;
             return (S) this;
         }
 
@@ -194,7 +210,7 @@ public Builder(@NotNull String key, @NotNull Class<T> type) {
             if (context == null && !String.class.equals(type)) {
                 throw new IllegalStateException("Context is required for non-string value flags");
             }
-            return new CommandValueFlag<>(key, aliases, type, optional, defaultValue, context, completion);
+            return new CommandValueFlag<>(key, aliases, type, optional, defaultValueSupplier, context, completion);
         }
     }
 
@@ -207,7 +223,7 @@ public Builder(@NotNull String key, @NotNull Class<T> type) {
     public static class EnumBuilder<T extends Enum<T>, S extends EnumBuilder<T, S>> extends CommandFlag.Builder<S> {
         protected final Class<T> type;
         protected boolean optional = false;
-        protected T defaultValue = null;
+        protected Supplier<? extends T> defaultValueSupplier = null;
         protected Function<String, T> context = null;
         protected Function<String, Collection<String>>  completion = null;
 
@@ -253,7 +269,21 @@ private void setEnumCompletion() {
          * @return The builder.
          */
         public @NotNull S defaultValue(@NotNull T defaultValue) {
-            this.defaultValue = defaultValue;
+            return defaultValue(() -> defaultValue);
+        }
+
+        /**
+         * Set the default value to supply. Used if optional is true and user does not specify a value.
+         * Supplier is only called when command is executed with the flag is present in input.
+         *
+         * @param defaultValueSupplier The default value supplier.
+         * @return The builder.
+         *
+         * @since 5.7
+         */
+        @ApiStatus.AvailableSince("5.7")
+        public @NotNull S defaultValue(@NotNull Supplier<? extends T> defaultValueSupplier) {
+            this.defaultValueSupplier = defaultValueSupplier;
             return (S) this;
         }
 
@@ -264,7 +294,7 @@ private void setEnumCompletion() {
          */
         @Override
         public @NotNull CommandValueFlag<T> build() {
-            return new CommandValueFlag<>(key, aliases, type, optional, defaultValue, context, completion);
+            return new CommandValueFlag<>(key, aliases, type, optional, defaultValueSupplier, context, completion);
         }
     }
 }

src/main/java/org/mvplugins/multiverse/core/command/flags/RemovePlayerDestinationFlags.java

@@ -0,0 +1,65 @@
+package org.mvplugins.multiverse.core.command.flags;
+
+import co.aikar.commands.InvalidCommandArgument;
+import jakarta.inject.Inject;
+import org.bukkit.Bukkit;
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
+import org.jvnet.hk2.annotations.Service;
+import org.mvplugins.multiverse.core.command.flag.CommandFlagsManager;
+import org.mvplugins.multiverse.core.command.flag.CommandValueFlag;
+import org.mvplugins.multiverse.core.command.flag.FlagBuilder;
+import org.mvplugins.multiverse.core.destination.DestinationInstance;
+import org.mvplugins.multiverse.core.destination.DestinationsProvider;
+import org.mvplugins.multiverse.core.destination.core.WorldDestination;
+import org.mvplugins.multiverse.core.exceptions.command.MVInvalidCommandArgument;
+import org.mvplugins.multiverse.core.world.WorldManager;
+
+@ApiStatus.AvailableSince("5.7")
+@Service
+public class RemovePlayerDestinationFlags extends FlagBuilder {
+
+    public static final String NAME = "removeplayer";
+
+    private WorldManager worldManager;
+    private DestinationsProvider destinationsProvider;
+    private WorldDestination worldDestination;
+
+    protected RemovePlayerDestinationFlags(
+            @NotNull String name,
+            @NotNull CommandFlagsManager flagsManager,
+            @NotNull WorldManager worldManager,
+            @NotNull DestinationsProvider destinationsProvider,
+            @NotNull WorldDestination worldDestination
+    ) {
+        super(name, flagsManager);
+        this.worldManager = worldManager;
+        this.destinationsProvider = destinationsProvider;
+        this.worldDestination = worldDestination;
+    }
+
+    @Inject
+    private RemovePlayerDestinationFlags(
+            @NotNull CommandFlagsManager flagsManager,
+            @NotNull WorldManager worldManager,
+            @NotNull DestinationsProvider destinationsProvider,
+            @NotNull WorldDestination worldDestination
+    ) {
+        super(NAME, flagsManager);
+        this.destinationsProvider = destinationsProvider;
+        this.worldManager = worldManager;
+        this.worldDestination = worldDestination;
+    }
+
+    public final CommandValueFlag<DestinationInstance> removePlayers = flag(CommandValueFlag.builder("--remove-players", DestinationInstance.class)
+            .addAlias("-r")
+            .defaultValue(() -> worldManager.getDefaultWorld()
+                    .map(defaultWorld -> worldDestination.fromWorld(defaultWorld))
+                    .getOrElseThrow(() -> new InvalidCommandArgument("No default world found, so the --remove-players flag requires a destination argument."))) //TODO: locale
+            .completion(input -> destinationsProvider.suggestDestinationStrings(Bukkit.getConsoleSender(), input))
+            .context(input -> destinationsProvider.parseDestination(input)
+                    .getOrThrow(failure ->
+                            MVInvalidCommandArgument.of(failure.getFailureMessage())))
+            .optional()
+            .build());
+}

src/main/java/org/mvplugins/multiverse/core/command/flags/RemovePlayerFlags.java

@@ -1,14 +1,21 @@
 package org.mvplugins.multiverse.core.command.flags;
 
 import jakarta.inject.Inject;
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jvnet.hk2.annotations.Service;
 import org.mvplugins.multiverse.core.command.flag.CommandFlag;
 import org.mvplugins.multiverse.core.command.flag.CommandFlagsManager;
 import org.mvplugins.multiverse.core.command.flag.FlagBuilder;
 
+/**
+ * @deprecated The --remove-players flag is being removed in favor of a more flexible system that allows for specifying
+ * a destination for players to be teleported to when a world is unloaded. See {@link RemovePlayerDestinationFlags}.
+ */
+@Deprecated(forRemoval = true, since = "5.7")
+@ApiStatus.ScheduledForRemoval(inVersion = "6.0")
 @Service
 public class RemovePlayerFlags extends FlagBuilder {
 
     public static final String NAME = "removeplayer";