feature: introduce RtpDimension argument type.

Author: sakurawald

CHANGELOG.md

@@ -9,6 +9,7 @@
 
 ## ✨ Features
 - [command_bundle] feature: add new command definitions (`/success` and `/failure`) into the `default config` model.
+- [rtp] feature: improve the command suggestion for `--dimension` optional argument. Now it only suggests the effective dimensions.
 
 ## 🐞 Fixes
 - [chat.style] When installed on the client-side, re-entering the single-player world would fail.

common/src/main/resources/graph/argument-type-adapter-graph.txt

@@ -84,6 +84,7 @@ mod.fuji.module.initializer.leaderboard.command.argument.adapter.LeaderBoardTime
 mod.fuji.module.initializer.rank.command.argument.adapter.NextAvailableRankNodesArgumentTypeAdapter
 mod.fuji.module.initializer.rank.command.argument.adapter.PreviousAvailableRankNodesArgumentTypeAdapter
 mod.fuji.module.initializer.rank.command.argument.adapter.RankNodeArgumentTypeAdapter
+mod.fuji.module.initializer.rtp.command.argument.adapter.RtpDimensionArgumentTypeAdapter
 mod.fuji.module.initializer.skin.command.argument.adapter.DefaultSkinNameArgumentTypeAdapter
 mod.fuji.module.initializer.world.manager.command.argument.adapter.ChunkGeneratorTypeArgumentTypeAdapter
 mod.fuji.module.initializer.world.manager.command.argument.adapter.LoadedRuntimeDimensionDescriptorArgumentTypeAdapter

fabric/src/main/java/mod/fuji/core/command/argument/adapter/impl/DimensionArgumentTypeAdapter.java

@@ -4,15 +4,15 @@
 import com.mojang.brigadier.builder.RequiredArgumentBuilder;
 import com.mojang.brigadier.context.CommandContext;
 import com.mojang.brigadier.exceptions.CommandSyntaxException;
+import java.util.List;
+import lombok.SneakyThrows;
 import mod.fuji.core.auxiliary.minecraft.RegistryHelper;
 import mod.fuji.core.auxiliary.minecraft.WorldHelper;
 import mod.fuji.core.command.argument.adapter.abst.BaseArgumentTypeAdapter;
 import mod.fuji.core.command.argument.structure.CommandArgument;
 import mod.fuji.core.command.argument.wrapper.impl.Dimension;
-import java.util.List;
-import lombok.SneakyThrows;
-import net.minecraft.commands.arguments.DimensionArgument;
 import net.minecraft.commands.CommandSourceStack;
+import net.minecraft.commands.arguments.DimensionArgument;
 import org.jetbrains.annotations.NotNull;
 
 public class DimensionArgumentTypeAdapter extends BaseArgumentTypeAdapter {
@@ -23,21 +23,19 @@ protected ArgumentType<?> makeArgumentType() {
     }
 
     /**
- *         1. The DimensionArgumentType.dimension() will not suggest the new registered dimensions, or un-registered dimensions.
-        2. The dimension registry is synced when the client joins the server, and it's fixed.
-        3. FIXME: When you call RequiredArgumentBuilder#suggests() method, the `/back {push|clear}` will also be suggested, even the command source has no permission to use it.
-
- **/
+     * 1. The DimensionArgumentType.dimension() will not suggest the new registered dimensions, or un-registered dimensions.
+     * 2. The dimension registry is synced when the client joins the server, and it's fixed.
+     **/
     @Override
     @NotNull
     protected RequiredArgumentBuilder<CommandSourceStack, ?> makeRequiredArgumentBuilder(@NotNull String argumentName) {
         return super.makeRequiredArgumentBuilder(argumentName)
             .suggests(
-            (ctx, builder) -> {
-                WorldHelper.getWorlds().forEach(it -> builder.suggest(RegistryHelper.getIdAsString(it)));
-                return builder.buildFuture();
-            }
-        );
+                (ctx, builder) -> {
+                    WorldHelper.getWorlds().forEach(it -> builder.suggest(RegistryHelper.getIdAsString(it)));
+                    return builder.buildFuture();
+                }
+            );
     }
 
     @SneakyThrows(CommandSyntaxException.class)

fabric/src/main/java/mod/fuji/module/initializer/rtp/RtpInitializer.java

@@ -16,6 +16,7 @@
 import mod.fuji.core.service.random_teleport.RandomTeleporter;
 import mod.fuji.core.service.random_teleport.structure.RandomTeleportSettings;
 import mod.fuji.module.initializer.ModuleInitializer;
+import mod.fuji.module.initializer.rtp.command.argument.wrapper.RtpDimension;
 import mod.fuji.module.initializer.rtp.config.model.RtpConfigModel;
 import net.minecraft.server.level.ServerPlayer;
 import net.minecraft.server.level.ServerLevel;
@@ -59,7 +60,7 @@ public class RtpInitializer extends ModuleInitializer {
 
     private static final BaseConfigurationHandler<RtpConfigModel> config = ObjectConfigurationHandler.ofModule(BaseConfigurationHandler.CONFIG_JSON_LITERAL, RtpConfigModel.class);
 
-    private static Optional<RandomTeleportSettings> getRandomTeleportSettings(@NotNull ServerLevel world) {
+    public static Optional<RandomTeleportSettings> getRandomTeleportSettings(@NotNull ServerLevel world) {
         List<RandomTeleportSettings> list = config.model().getDimensions().getSettings();
         String dimension = RegistryHelper.getIdAsString(world);
         return list.stream()
@@ -70,7 +71,7 @@ private static Optional<RandomTeleportSettings> getRandomTeleportSettings(@NotNu
 
     @Document(id = 1751826340406L, value = "Random rtp in specified dimension.")
     @CommandNode("rtp")
-    private static int $rtp(@CommandSource @CommandTarget ServerPlayer player, Optional<Dimension> dimension) {
+    private static int $rtp(@CommandSource @CommandTarget ServerPlayer player, Optional<RtpDimension> dimension) {
         ServerLevel serverWorld = dimension
             .map(Dimension::getValue)
             .orElseGet(() -> EntityHelper.getServerWorld(player));

fabric/src/main/java/mod/fuji/module/initializer/rtp/command/argument/adapter/RtpDimensionArgumentTypeAdapter.java

@@ -0,0 +1,57 @@
+package mod.fuji.module.initializer.rtp.command.argument.adapter;
+
+import com.mojang.brigadier.arguments.ArgumentType;
+import com.mojang.brigadier.builder.RequiredArgumentBuilder;
+import com.mojang.brigadier.context.CommandContext;
+import java.util.List;
+import mod.fuji.core.auxiliary.minecraft.RegistryHelper;
+import mod.fuji.core.auxiliary.minecraft.WorldHelper;
+import mod.fuji.core.command.argument.adapter.abst.BaseArgumentTypeAdapter;
+import mod.fuji.core.command.argument.representation.IdentifierArgumentTypeIR;
+import mod.fuji.core.command.argument.structure.CommandArgument;
+import mod.fuji.core.structure.IdentifierIR;
+import mod.fuji.module.initializer.rtp.RtpInitializer;
+import mod.fuji.module.initializer.rtp.command.argument.wrapper.RtpDimension;
+import net.minecraft.commands.CommandSourceStack;
+import net.minecraft.server.level.ServerLevel;
+import org.jetbrains.annotations.NotNull;
+
+public class RtpDimensionArgumentTypeAdapter extends BaseArgumentTypeAdapter {
+    @Override
+    public List<Class<?>> getTypeClasses() {
+        return List.of(RtpDimension.class);
+    }
+
+    @Override
+    public List<String> getTypeNames() {
+        return List.of("rtp-dimension");
+    }
+
+    @Override
+    protected ArgumentType<?> makeArgumentType() {
+        return IdentifierArgumentTypeIR.makeArgumentType();
+    }
+
+    @Override
+    protected Object makeArgumentValue(@NotNull CommandContext<CommandSourceStack> context, @NotNull CommandArgument commandArgument) {
+        IdentifierIR identifierIR = IdentifierIR.of(IdentifierArgumentTypeIR.makeArgumentValue(context, commandArgument));
+        String dimensionId = RegistryHelper.getIdAsString(identifierIR);
+        ServerLevel world = WorldHelper.getWorldOrThrow(dimensionId);
+        return new RtpDimension(world);
+    }
+
+    @Override
+    protected @NotNull RequiredArgumentBuilder<CommandSourceStack, ?> makeRequiredArgumentBuilder(@NotNull String argumentName) {
+        return super.makeRequiredArgumentBuilder(argumentName)
+            .suggests(
+                (ctx, builder) -> {
+                    WorldHelper
+                        .getWorlds()
+                        .stream()
+                        .filter(it -> RtpInitializer.getRandomTeleportSettings(it).isPresent())
+                        .forEach(it -> builder.suggest(RegistryHelper.getIdAsString(it)));
+                    return builder.buildFuture();
+                }
+            );
+    }
+}

fabric/src/main/java/mod/fuji/module/initializer/rtp/command/argument/wrapper/RtpDimension.java

@@ -0,0 +1,10 @@
+package mod.fuji.module.initializer.rtp.command.argument.wrapper;
+
+import mod.fuji.core.command.argument.wrapper.impl.Dimension;
+import net.minecraft.server.level.ServerLevel;
+
+public class RtpDimension extends Dimension {
+    public RtpDimension(ServerLevel value) {
+        super(value);
+    }
+}