Differences

This shows you the differences between two versions of the page.

--- zh_cn:tutorial:command_argument_types [2023/04/20 11:09] – 没有必要使用 SystemUtil solidblock
+++ zh_cn:tutorial:command_argument_types [2024/04/15 07:24] (current) – solidblock
@@ Line 3: / Line 3: @@
 Brigadier 支持自定义的参数类型，本页会展示如何创建一个简单的参数类型。
-注意：自定义的参数类型要求客户端也正确注册，如果是服务器的插件，请考虑使用已存在的参数类型和一个自定义的建议提供器。
+**注意：**自定义的参数类型要求客户端也正确注册，如果是服务器的插件，请考虑使用已存在的参数类型和一个自定义的建议提供器。
-本例中，我们将会创建一个 UuidArgumentType。
+===== 解析 =====
+本例中，我们将会创建一个 ''UuidArgumentType''。
-首先创建一个类并继承 ''ArgumentType''。注意 ''ArgumentType'' 是泛型，因此泛型会定义这个 ''ArgumentType'' 会返回什么。
+首先创建一个类并继承 ''ArgumentType''。注意 ''ArgumentType'' 是泛型，因此泛型会定义这个 ''ArgumentType'' 会返回什么类型。
 <code java>
@@ Line 21: / Line 22: @@
 所以的解析都发生在此方法中。此方法会根据命令行中提供的参数返回一个对象，或者抛出一个 ''CommandSyntaxException'' 即解析失败。
-接下来你会存在当前指针（cursor）的位置，这样你可以截取子字符串，截出特定的参数。指针总是出现在参数在命令行中出现的开始的位置。
+接下来你会存储当前指针（cursor）的位置，这样你可以截取子字符串，截出特定的参数。指针总是出现在参数在命令行中出现的开始的位置。
 <code java [enable_line_numbers="true"]>
-int argBeginning = reader.getCursor(); // 指针的开始位置，是参数的开始位置。
+    int argBeginning = reader.getCursor(); // 指针开始的位置是参数开始的位置。
-if (!reader.canRead()) {
+    if (!reader.canRead()) {
-    reader.skip();
+        reader.skip();
-}
+    }
 </code>
-现在抓取整个参数。你可能会有不同的标准，或像一些参数一样，检测到命令行中有 ''{'' 时会要求其能够闭合，具体取决于你的参数类型。对于 UUID，我们只需要指出参数结束时的指针的位置。
+现在抓取整个参数。你可能会有不同的标准，或像一些参数一样，检测到命令行中有 ''{'' 时会要求其能够闭合，具体取决于你的参数类型。
 <code java [enable_line_numbers="true"]>
-while (reader.canRead() && reader.peek() != ' ') { // “peek”提供了当前指针位置的字符。
+    while (reader.canRead() && reader.peek() != ' ') { // “peek”提供了当前指针位置的字符。
-    reader.skip(); // 告诉 StringReader，将其指针移动到下一个位置。
+        reader.skip(); // 告诉 StringReader，将其指针移动到下一个位置。
-}
+    }
 </code>
 接下来我们会从这个 ''StringReader'' 中，获取命令行中的指针位置的子字符串。
-<code java [enable_line_numbers="true"]>String uuidString = reader.getString().substring(argBeginning, reader.getCursor());</code>
+<code java [enable_line_numbers="true"]>
+    String uuidString = reader.getString().substring(argBeginning, reader.getCursor());
+</code>
-最终，我们检票我们的参数是否正确，并解析我们的参数，如果解析失败则抛出异常。
+最终，我们检查我们的参数是否正确，并解析我们的参数，如果解析失败则抛出异常。
 <code java [enable_line_numbers="true"]>
-try {
+    public static final DynamicCommandExceptionType INVALID_UUID = new DynamicCommandExceptionType(o -> Text.literal("无效的uuid：" + o));
-    UUID uuid = UUID.fromString(uuidString); // 我们的正常逻辑。
-    return uuid; // 我们返回我们的类型，在这个例子中，解析器会认为类型已经正确解析，并继续。
+    @Override
-} catch (Exception ex) {
+    public UUID parse(StringReader reader) throws CommandSyntaxException {
-    // UUID 在由字符串生成时，可能会抛出异常，因此我们捕获这个异常，并将其包装成 CommandSyntaxException 类型。
+        // ...
-    // 创建时会带有环境，告诉 Brigadier，根据这个环境来告诉玩家，命令在哪里解析失败了。
+        try {
-    // 尽管应该使用正常的 create 方法。
+            UUID uuid = UUID.fromString(uuidString); // 我们的正常逻辑。
-    throw new SimpleCommandExceptionType(Text.literal(ex.getMessage())).createWithContext(reader);
+            return uuid; // 我们返回我们的类型，在这个例子中，解析器会认为类型已经正确解析，并继续。
-}
+        } catch (InvalidArgumentException ex) {
+            // UUID 在由字符串生成时，可能会抛出异常，因此我们捕获这个异常，并将其包装成 CommandSyntaxException 类型。
+            // 创建时会带有环境，告诉 Brigadier，根据这个环境来告诉玩家，命令在哪里解析失败了。
+            // 尽管也可以使用正常的 create 方法。
+            reader.setCursor(argBeginning);
+            throw INVALID_UUID.createWithContext(reader, ex.getMessage());
+        }
+        // ...
+    }
 </code>
+===== 定义参数示例 =====
+有时候参数需要有一些示例，通常存储在作为静态常量字段的不可变集合中。示例是用于检测二义性的。
+<code java>
+    private static final Collection<String> EXAMPLES = List.of(
+        "765e5d33-c991-454f-8775-b6a7a394c097", // i509VCB: Username The_1_gamers
+        "069a79f4-44e9-4726-a5be-fca90e38aaf5", // Notch
+        "61699b2e-d327-4a01-9f1e-0ea8c3f06bc6"  // Dinnerbone
+    );
+    @Override
+    public Collection<String> getExamples() {
+        // Brigadier 支持显示示例，表示这个命令应该像是什么样子，这应该包含一个集合，
+        // 集合的内容是此类型能够返回的参数。
+        // 这主要用于检测二义性，即一种参数可能会被作为另一种参数解析。
+        return EXAMPLES;
+    }
+</code>
+===== 注册参数类型 =====
 ''ArgumentType'' 完成了，你的客户端却会拒绝解析参数并抛出错误。这是因为服务器会告诉客户端这是什么参数类型。而客户端不会解析它不知道的参数类型。要解决这个问题，我们需要在 ''ModInitializer'' 中注册一个 ''ArgumentSerializer''。对于更加复杂的参数类型，你可能还需要创建自己的 ''ArgumentSerializer''。
 <code java [enable_line_numbers="true"]>
-ArgumentTypeRegistry.registerArgumentType(new Identifier("tutorial", "uuid"), UuidArgumentType.class, ConstantArgumentSerializer.of(UuidArgumentType::uuid));
+ArgumentTypeRegistry.registerArgumentType(
-// 这个参数会创建 ArgumentType。
+  new Identifier("tutorial", "uuid"),
+  UuidArgumentType.class, ConstantArgumentSerializer.of(UuidArgumentType::uuid));
+// 参数会创建 ArgumentType。
 </code>
-参数类型的完整代码会是这样：
+===== 完整参数类型示例 =====
 <file java UuidArgumentType.java [enable_line_numbers="true"]>
@@ Line 88: / Line 121: @@
     public static <S> UUID getUuid(String name, CommandContext<S> context) {
         // 注意你应该假设 CommandContext 中包含的 CommandSource 是一个泛型类型。
-        // 如果你需要访问 ServerCommandSource，确保你在强转之前验证了源。
+        // 如果你需要访问 ServerCommandSource，确保你在强转之前验证了命令源。
         return context.getArgument(name, UUID.class);
     }
@@ Line 129: / Line 162: @@
         // Brigadier 支持显示示例，表示这个命令应该像是什么样子，这应该包含一个集合，
         // 集合的内容是此类型能够返回的参数。
-        // 这主要用于计算共享了同一个的难懂的命令。
+        // 这主要用于检测二义性，即一种参数可能会被作为另一种参数解析。
         return EXAMPLES;
     }
 }
 </file>
+===== 指定建议 =====
+很多参数类型都支持建议。不像在注册过程中定义的自定义建议，当没有自定义建议时，始终会应用这些建议。建议是在客户端中计算的。例如，''BlockPosArgumentType'' 可能会建议客户端的准星目标的位置，''EntityArgumentType'' 可能会建议准星目标实体的准确 UUID。
+关于如何提供建议，请参见[[command suggestions|命令建议]]。在这个例子中，我们会建议服务器中的所有玩家的 UUID，以及当前客户端的准星目标实体。
+<code java>
+  @Override
+  public <S> CompletableFuture<Suggestions> listSuggestions(CommandContext<S> context, SuggestionsBuilder builder) {
+    final String remaining = builder.getRemaining();
+    if (context.getSource() instanceof FabricClientCommandSource clientCommandSource) {
+      if (clientCommandSource.getClient().crosshairTarget instanceof EntityHitResult entityHitResult) {
+        final UUID uuid = entityHitResult.getEntity().getUuid();
+        if (CommandSource.shouldSuggest(remaining, uuid.toString())) {
+          builder.suggest(uuid.toString());
+        }
+      }
+      return CommandSource.suggestMatching(Collections2.transform(clientCommandSource.getClient().getNetworkHandler().getPlayerUuids(), UUID::toString), builder);
+    }
+    if (context.getSource() instanceof ServerCommandSource source) {
+      return CommandSource.suggestMatching(Lists.transform(source.getServer().getPlayerManager().getPlayerList(), Entity::getUuidAsString), builder);
+    }
+    return builder.buildFuture();
+  }
+</code>
+===== 自定义参数序列化 ======
+在上面的例子中，UUID 是简单的。如果参数是复杂的，如何让它能够正确地被客户端理解呢？这就是 ''ArgumentSerializer'' 有用的地方。
+''ArgumentSerializer'' 有两个泛型参数：
+  * ''ArgumentType''。
+  * ''ArgumentSerializer.ArgumentTypeProperties<A>'',，其中 ''A'' 是第一个类型参数。通常是一个不可变的对象（可以是记录），包含参数类型基本的信息（不包含 ''CommandRegistryAccess''）。一些情况下，如果 ''ArgumentType'' 是不可变的、不包含 ''CommandRegistryAccess''，那么它自己就可以直接继承 ''ArgumentSerializer.ArgumentTypeProperties<A>''。
+在这个例子中，我们创建一个新的参数类型，包含一个布尔值和一个整数。这个例子中，需要 ''CommandRegistryAccess''。
+<code java>
+public record ExampleArgumentType(CommandRegistryAccess commandRegistryAccess, boolean booleanValue, int intValue) implements ArgumentType<String> {
+  @Override
+  public String parse(StringReader reader) throws CommandSyntaxException {
+    ...
+  }
+  public static class Serializer implements ArgumentSerializer<ExampleArgumentType, Serializer.Properties> {
+    @Override
+    public void writePacket(Properties properties, PacketByteBuf buf) {
+      // 将基本的属性写到数据包中，需要确保所有的参数都以适当方式存储在数据包中。
+      buf.writeBoolean(properties.booleanValue).writeInt(properties.intValue);
+    }
+    @Override
+    public Properties fromPacket(PacketByteBuf buf) {
+      // 从数据包中读取信息。返回的是 ''ArgumentSerializer.ArgumentTypeProperties'' 而不是 ''ArgumentType''。
+      return new Properties(buf.readBoolean(), buf.readInt());
+    }
+    @Override
+    public void writeJson(Properties properties, JsonObject json) {
+      // 以 JSON 的形式呈现参数类型。
+      json.addProperty("booleanValue", properties.booleanValue);
+      json.addProperty("intValue", properties.intValue);
+    }
+    @Override
+    public Properties getArgumentTypeProperties(ExampleArgumentType argumentType) {
+      return new Properties(argumentType.booleanValue, argumentType.intValue);
+    }
+    public record Properties(boolean booleanValue, int intValue) implements ArgumentTypeProperties<ExampleArgumentType> {
+      @Override
+      public ExampleArgumentType createType(CommandRegistryAccess commandRegistryAccess) {
+        // 只有在此方法中会提供 ''CommandRegistryAccess''。
+        // 会创建需要 ''CommandRegistryAccess'' 的参数类型。
+        return new ExampleArgumentType(commandRegistryAccess, booleanValue, intValue);
+      }
+      @Override
+      public ArgumentSerializer<ExampleArgumentType, Serializer.Properties> getSerializer() {
+        // 不要在这里创建新的 ''Serializer'' 对象。
+        return Serializer.this;
+      }
+    }
+  }
+}
+</code>
+现在你可以像这样注册：
+<code java>
+ArgumentTypeRegistry.registerArgumentType(new Identifier("tutorial", "example"), ExampleArgumentType.class, new ExampleArgumentType.Serializer());
+</code>
+==== 另一种可能的定义序列化的方式 ====
+如果参数不需要 ''CommandRegistryAccess''，那么它自己就可以继承 ''ArgumentSerializer.ArgumentTypeProperties''。
+<code java>
+public record ExampleArgumentType(boolean booleanValue, int intValue) implements ArgumentType<String>, ArgumentSerializer.ArgumentTypeProperties<ExampleArgumentType> {
+  @Override
+  public String parse(StringReader reader) throws CommandSyntaxException {
+    ...
+  }
+  @Override
+  public ExampleArgumentType createType(CommandRegistryAccess commandRegistryAccess) {
+    return this;
+  }
+  @Override
+  public ArgumentSerializer<ExampleArgumentType, ?> getSerializer() {
+    // 这里总是返回同一个对象，以避免无法序列化。
+    return Serializer.INSTANCE;
+  }
+  public static class Serializer implements ArgumentSerializer<ExampleArgumentType, ExampleArgumentType> {
+    public static final Serializer INSTANCE = new Serializer();
+    private Serializer() {}
+    @Override
+    public void writePacket(ExampleArgumentType properties, PacketByteBuf buf) {
+      buf.writeBoolean(properties.booleanValue).writeInt(properties.intValue);
+    }
+    @Override
+    public ExampleArgumentType fromPacket(PacketByteBuf buf) {
+      return new ExampleArgumentType(buf.readBoolean(), buf.readInt());
+    }
+    @Override
+    public void writeJson(ExampleArgumentType properties, JsonObject json) {
+      json.addProperty("booleanValue", properties.booleanValue);
+      json.addProperty("intValue", properties.intValue);
+    }
+    @Override
+    public ExampleArgumentType getArgumentTypeProperties(ExampleArgumentType argumentType) {
+      return argumentType;
+    }
+  }
+}
+</code>
+现在你可以像这样注册：
+<code java>
+ArgumentTypeRegistry.registerArgumentType(new Identifier("tutorial", "example"), ExampleArgumentType.class, ExampleArgumentType.Serializer.INSTANCE);
+</code>