Dialog registry API

Author: Machine-Maker

paper-api/src/generated/java/io/papermc/paper/registry/keys/DialogKeys.java

@@ -0,0 +1,61 @@
+package io.papermc.paper.registry.keys;
+
+import static net.kyori.adventure.key.Key.key;
+
+import io.papermc.paper.dialog.Dialog;
+import io.papermc.paper.generated.GeneratedFrom;
+import io.papermc.paper.registry.RegistryKey;
+import io.papermc.paper.registry.TypedKey;
+import net.kyori.adventure.key.Key;
+import org.jspecify.annotations.NullMarked;
+
+/**
+ * Vanilla keys for {@link RegistryKey#DIALOG}.
+ *
+ * @apiNote The fields provided here are a direct representation of
+ * what is available from the vanilla game source. They may be
+ * changed (including removals) on any Minecraft version
+ * bump, so cross-version compatibility is not provided on the
+ * same level as it is on most of the other API.
+ */
+@SuppressWarnings({
+        "unused",
+        "SpellCheckingInspection"
+})
+@NullMarked
+@GeneratedFrom("1.21.6-pre3")
+public final class DialogKeys {
+    /**
+     * {@code minecraft:custom_options}
+     *
+     * @apiNote This field is version-dependant and may be removed in future Minecraft versions
+     */
+    public static final TypedKey<Dialog> CUSTOM_OPTIONS = create(key("custom_options"));
+
+    /**
+     * {@code minecraft:quick_actions}
+     *
+     * @apiNote This field is version-dependant and may be removed in future Minecraft versions
+     */
+    public static final TypedKey<Dialog> QUICK_ACTIONS = create(key("quick_actions"));
+
+    /**
+     * {@code minecraft:server_links}
+     *
+     * @apiNote This field is version-dependant and may be removed in future Minecraft versions
+     */
+    public static final TypedKey<Dialog> SERVER_LINKS = create(key("server_links"));
+
+    private DialogKeys() {
+    }
+
+    /**
+     * Creates a typed key for {@link Dialog} in the registry {@code minecraft:dialog}.
+     *
+     * @param key the value's key in the registry
+     * @return a new typed key
+     */
+    public static TypedKey<Dialog> create(final Key key) {
+        return TypedKey.create(RegistryKey.DIALOG, key);
+    }
+}

paper-api/src/generated/java/io/papermc/paper/registry/keys/tags/DialogTagKeys.java

@@ -0,0 +1,57 @@
+package io.papermc.paper.registry.keys.tags;
+
+import static net.kyori.adventure.key.Key.key;
+
+import io.papermc.paper.dialog.Dialog;
+import io.papermc.paper.generated.GeneratedFrom;
+import io.papermc.paper.registry.RegistryKey;
+import io.papermc.paper.registry.tag.TagKey;
+import net.kyori.adventure.key.Key;
+import org.jetbrains.annotations.ApiStatus;
+import org.jspecify.annotations.NullMarked;
+
+/**
+ * Vanilla tag keys for {@link RegistryKey#DIALOG}.
+ *
+ * @apiNote The fields provided here are a direct representation of
+ * what is available from the vanilla game source. They may be
+ * changed (including removals) on any Minecraft version
+ * bump, so cross-version compatibility is not provided on the
+ * same level as it is on most of the other API.
+ */
+@SuppressWarnings({
+        "unused",
+        "SpellCheckingInspection"
+})
+@NullMarked
+@GeneratedFrom("1.21.6-pre3")
+@ApiStatus.Experimental
+public final class DialogTagKeys {
+    /**
+     * {@code #minecraft:pause_screen_additions}
+     *
+     * @apiNote This field is version-dependant and may be removed in future Minecraft versions
+     */
+    public static final TagKey<Dialog> PAUSE_SCREEN_ADDITIONS = create(key("pause_screen_additions"));
+
+    /**
+     * {@code #minecraft:quick_actions}
+     *
+     * @apiNote This field is version-dependant and may be removed in future Minecraft versions
+     */
+    public static final TagKey<Dialog> QUICK_ACTIONS = create(key("quick_actions"));
+
+    private DialogTagKeys() {
+    }
+
+    /**
+     * Creates a tag key for {@link Dialog} in the registry {@code minecraft:dialog}.
+     *
+     * @param key the tag key's key
+     * @return a new tag key
+     */
+    @ApiStatus.Experimental
+    public static TagKey<Dialog> create(final Key key) {
+        return TagKey.create(RegistryKey.DIALOG, key);
+    }
+}

paper-api/src/main/java/io/papermc/paper/dialog/Dialog.java

@@ -0,0 +1,17 @@
+package io.papermc.paper.dialog;
+
+import io.papermc.paper.registry.RegistryBuilderFactory;
+import io.papermc.paper.registry.data.InlinedRegistryBuilderProvider;
+import io.papermc.paper.registry.data.dialog.DialogRegistryEntry;
+import java.util.function.Consumer;
+import org.bukkit.Keyed;
+import org.jetbrains.annotations.ApiStatus;
+
+@ApiStatus.NonExtendable
+public interface Dialog extends Keyed {
+
+    @ApiStatus.Experimental
+    static Dialog create(final Consumer<RegistryBuilderFactory<Dialog, ? extends DialogRegistryEntry.Builder>> value) {
+        return InlinedRegistryBuilderProvider.instance().createDialog(value);
+    }
+}

paper-api/src/main/java/io/papermc/paper/dialog/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * This package contains classes and interfaces related to the dialog system in Paper.
+ */
+@NullMarked
+package io.papermc.paper.dialog;
+
+import org.jspecify.annotations.NullMarked;

paper-api/src/main/java/io/papermc/paper/registry/RegistryKey.java

@@ -1,6 +1,7 @@
 package io.papermc.paper.registry;
 
 import io.papermc.paper.datacomponent.DataComponentType;
+import io.papermc.paper.dialog.Dialog;
 import io.papermc.paper.registry.tag.TagKey;
 import net.kyori.adventure.key.Key;
 import net.kyori.adventure.key.KeyPattern;
@@ -219,6 +220,11 @@ public sealed interface RegistryKey<T> extends Keyed permits RegistryKeyImpl {
      */
     RegistryKey<Pig.Variant> PIG_VARIANT = create("pig_variant");
 
+    /**
+     * Data-driven registry for dialogs.
+     * @see io.papermc.paper.registry.keys.DialogKeys
+     */
+    RegistryKey<Dialog> DIALOG = create("dialog");
 
 
     /* ******************* *

paper-api/src/main/java/io/papermc/paper/registry/data/InlinedRegistryBuilderProvider.java

@@ -1,21 +1,23 @@
 package io.papermc.paper.registry.data;
 
+import io.papermc.paper.dialog.Dialog;
 import io.papermc.paper.registry.RegistryBuilderFactory;
+import io.papermc.paper.registry.data.dialog.DialogRegistryEntry;
 import java.util.Optional;
 import java.util.ServiceLoader;
 import java.util.function.Consumer;
-import org.bukkit.Art;
 import org.jetbrains.annotations.ApiStatus;
 
 @ApiStatus.Internal
 @ApiStatus.NonExtendable
 public interface InlinedRegistryBuilderProvider {
 
     static InlinedRegistryBuilderProvider instance() {
-        class Holder {
+        final class Holder {
             static final Optional<InlinedRegistryBuilderProvider> INSTANCE = ServiceLoader.load(InlinedRegistryBuilderProvider.class).findFirst();
         }
         return Holder.INSTANCE.orElseThrow();
     }
 
+    Dialog createDialog(Consumer<RegistryBuilderFactory<Dialog, ? extends DialogRegistryEntry.Builder>> value);
 }

paper-api/src/main/java/io/papermc/paper/registry/data/dialog/ActionButton.java

@@ -0,0 +1,20 @@
+package io.papermc.paper.registry.data.dialog;
+
+import io.papermc.paper.registry.data.dialog.action.DialogAction;
+import net.kyori.adventure.text.Component;
+import org.jspecify.annotations.Nullable;
+
+public sealed interface ActionButton permits ActionButtonImpl {
+
+    static ActionButton create(final Component label, final @Nullable Component tooltip, final int width, final @Nullable DialogAction action) {
+        return new ActionButtonImpl(label, tooltip, width, action);
+    }
+
+    Component label();
+
+    @Nullable Component tooltip();
+
+    int width();
+
+    @Nullable DialogAction action();
+}

paper-api/src/main/java/io/papermc/paper/registry/data/dialog/ActionButtonImpl.java

@@ -0,0 +1,8 @@
+package io.papermc.paper.registry.data.dialog;
+
+import io.papermc.paper.registry.data.dialog.action.DialogAction;
+import net.kyori.adventure.text.Component;
+import org.jspecify.annotations.Nullable;
+
+record ActionButtonImpl(Component label, @Nullable Component tooltip, int width, @Nullable DialogAction action) implements ActionButton {
+}

paper-api/src/main/java/io/papermc/paper/registry/data/dialog/DialogBase.java

@@ -0,0 +1,51 @@
+package io.papermc.paper.registry.data.dialog;
+
+import io.papermc.paper.registry.data.dialog.body.DialogBody;
+import io.papermc.paper.registry.data.dialog.input.DialogInput;
+import java.util.List;
+import net.kyori.adventure.text.Component;
+import net.kyori.adventure.util.Index;
+import org.jetbrains.annotations.Unmodifiable;
+import org.jspecify.annotations.Nullable;
+
+public sealed interface DialogBase permits DialogBaseImpl {
+
+    static DialogBase create(
+        final Component title,
+        final @Nullable Component externalTitle,
+        final boolean canCloseWithEscape,
+        final boolean pause,
+        final DialogAfterAction afterAction,
+        final List<DialogBody> body,
+        final List<DialogInput> inputs
+    ) {
+        return new DialogBaseImpl(title, externalTitle, canCloseWithEscape, pause, afterAction, body, inputs);
+    }
+
+    Component title();
+
+    @Nullable
+    Component externalTitle();
+
+    boolean canCloseWithEscape();
+
+    boolean pause();
+
+    DialogAfterAction afterAction();
+
+    @Unmodifiable List<DialogBody> body();
+
+    @Unmodifiable List<DialogInput> inputs();
+
+    enum DialogAfterAction {
+        CLOSE("close"), NONE("none"), WAIT_FOR_RESPONSE("wait_for_response");
+
+        public static final Index<String, DialogAfterAction> NAMES = Index.create(DialogAfterAction.class, DialogAfterAction::name);
+
+        private final String name;
+
+        DialogAfterAction(final String name) {
+            this.name = name;
+        }
+    }
+}

paper-api/src/main/java/io/papermc/paper/registry/data/dialog/DialogBaseImpl.java

@@ -0,0 +1,24 @@
+package io.papermc.paper.registry.data.dialog;
+
+import io.papermc.paper.registry.data.dialog.body.DialogBody;
+import io.papermc.paper.registry.data.dialog.input.DialogInput;
+import java.util.List;
+import net.kyori.adventure.text.Component;
+import org.jetbrains.annotations.Unmodifiable;
+import org.jspecify.annotations.Nullable;
+
+record DialogBaseImpl(
+    Component title,
+    @Nullable Component externalTitle,
+    boolean canCloseWithEscape,
+    boolean pause,
+    DialogAfterAction afterAction,
+    @Unmodifiable List<DialogBody> body,
+    @Unmodifiable List<DialogInput> inputs
+) implements DialogBase {
+
+    DialogBaseImpl {
+        body = List.copyOf(body);
+        inputs = List.copyOf(inputs);
+    }
+}