fix(ui): fit quest board dialogs on screen

2026-09-05 08:52:28 -04:00
parent 719cd49609
commit 2624c2bc02
8 changed files with 528 additions and 92 deletions
@@ -0,0 +1,87 @@
+package games.dmg.spigotquestboard;
+
+import java.util.List;
+import java.util.Objects;
+
+/** A server-independent description of the quest-board dialog hierarchy. */
+record QuestBoardDialogSpec(
+    int maximumBodyWidth,
+    Screen dashboard,
+    Screen browse,
+    Screen create,
+    Screen claims,
+    List<QuestEntry> questEntries
+) {
+    QuestBoardDialogSpec {
+        if (maximumBodyWidth <= 0) {
+            throw new IllegalArgumentException("Maximum body width must be positive");
+        }
+        Objects.requireNonNull(dashboard, "dashboard");
+        Objects.requireNonNull(browse, "browse");
+        Objects.requireNonNull(create, "create");
+        Objects.requireNonNull(claims, "claims");
+        questEntries = List.copyOf(Objects.requireNonNull(questEntries, "questEntries"));
+    }
+
+    List<String> dashboardActions() {
+        return dashboard.actions().stream().map(Action::label).toList();
+    }
+
+    record Screen(
+        String title,
+        String externalTitle,
+        String message,
+        List<Action> actions,
+        List<Input> inputs,
+        boolean hasBackAction
+    ) {
+        Screen {
+            Objects.requireNonNull(title, "title");
+            Objects.requireNonNull(externalTitle, "externalTitle");
+            Objects.requireNonNull(message, "message");
+            actions = List.copyOf(Objects.requireNonNull(actions, "actions"));
+            inputs = List.copyOf(Objects.requireNonNull(inputs, "inputs"));
+        }
+    }
+
+    record QuestEntry(
+        String title,
+        String message,
+        List<Action> actions,
+        boolean hasBackAction
+    ) {
+        QuestEntry {
+            Objects.requireNonNull(title, "title");
+            Objects.requireNonNull(message, "message");
+            actions = List.copyOf(Objects.requireNonNull(actions, "actions"));
+        }
+    }
+
+    record Action(String label, Route route, String questId) {
+        Action {
+            Objects.requireNonNull(label, "label");
+            Objects.requireNonNull(route, "route");
+        }
+    }
+
+    record Input(String key, String label, String initial, int maximumLength) {
+        Input {
+            Objects.requireNonNull(key, "key");
+            Objects.requireNonNull(label, "label");
+            Objects.requireNonNull(initial, "initial");
+            if (maximumLength <= 0) {
+                throw new IllegalArgumentException("Maximum input length must be positive");
+            }
+        }
+    }
+
+    enum Route {
+        OPEN_BROWSE,
+        OPEN_CREATE,
+        OPEN_CLAIMS,
+        SUBMIT_CREATE,
+        COMPLETE,
+        CANCEL,
+        COLLECT
+    }
+}
@@ -1,16 +1,17 @@
 package games.dmg.spigotquestboard;

 import io.papermc.paper.dialog.Dialog;
+import io.papermc.paper.registry.RegistryKey;
 import io.papermc.paper.registry.data.dialog.ActionButton;
 import io.papermc.paper.registry.data.dialog.DialogBase;
 import io.papermc.paper.registry.data.dialog.action.DialogAction;
 import io.papermc.paper.registry.data.dialog.body.DialogBody;
 import io.papermc.paper.registry.data.dialog.input.DialogInput;
 import io.papermc.paper.registry.data.dialog.type.DialogType;
+import io.papermc.paper.registry.set.RegistrySet;
 import java.io.IOException;
 import java.time.Clock;
 import java.time.Duration;
-import java.util.ArrayList;
 import java.util.List;
 import java.util.Objects;
 import net.kyori.adventure.text.Component;
@@ -18,6 +19,12 @@ import net.kyori.adventure.text.event.ClickCallback;
 import org.bukkit.entity.Player;

 final class QuestBoardDialogUi implements QuestBoardUi {
+    private static final int DIALOG_WIDTH = 420;
+    private static final ClickCallback.Options CALLBACK_OPTIONS = ClickCallback.Options.builder()
+        .uses(1)
+        .lifetime(Duration.ofMinutes(10))
+        .build();
+
    private final QuestCreationGateway creator;
    private final QuestBrowser browser;
    private final QuestCompletionGateway completer;
@@ -66,9 +73,131 @@ final class QuestBoardDialogUi implements QuestBoardUi {

    @Override
    public void open(Player player) {
+        Objects.requireNonNull(player, "player");
+        player.showDialog(renderDashboard(specification(player), player));
+    }
+
+    QuestBoardDialogSpec specification(Player player) {
+        Objects.requireNonNull(player, "player");
+        java.time.Instant now = clock.instant();
+        List<QuestBoardDialogSpec.QuestEntry> entries = browser.activeQuests(now).stream()
+            .map(quest -> questEntry(quest, player, now))
+            .toList();
+        List<QuestBoardDialogSpec.Action> dashboardActions = List.of(
+            action("Browse quests", QuestBoardDialogSpec.Route.OPEN_BROWSE),
+            action("Create quest", QuestBoardDialogSpec.Route.OPEN_CREATE),
+            action("Pending claims", QuestBoardDialogSpec.Route.OPEN_CLAIMS)
+        );
+        QuestBoardDialogSpec.Screen dashboard = new QuestBoardDialogSpec.Screen(
+            "Quest Board",
+            "Quest Board",
+            "Choose what you want to do.",
+            dashboardActions,
+            List.of(),
+            false
+        );
+        QuestBoardDialogSpec.Screen browse = new QuestBoardDialogSpec.Screen(
+            "Browse Quests",
+            "Browse quests",
+            entries.isEmpty()
+                ? "No active quests."
+                : "Select a quest to view its request, reward, issuer, and time remaining.",
+            List.of(),
+            List.of(),
+            true
+        );
+        QuestBoardDialogSpec.Screen create = new QuestBoardDialogSpec.Screen(
+            "Create Quest",
+            "Create quest",
+            "Hold the reward in your main hand. The entire exact stack, including all item "
+                + "metadata, is escrowed only if the quest saves successfully.",
+            List.of(action("Create quest", QuestBoardDialogSpec.Route.SUBMIT_CREATE)),
+            List.of(
+                new QuestBoardDialogSpec.Input("requested_material", "Requested block", "", 64),
+                new QuestBoardDialogSpec.Input("requested_quantity", "Quantity", "64", 10)
+            ),
+            true
+        );
+        QuestBoardDialogSpec.Screen claims = new QuestBoardDialogSpec.Screen(
+            "Pending Claims",
+            "Pending claims",
+            claimListingText(player),
+            claimant == null
+                ? List.of()
+                : List.of(action("Collect pending claims", QuestBoardDialogSpec.Route.COLLECT)),
+            List.of(),
+            true
+        );
+        return new QuestBoardDialogSpec(
+            DIALOG_WIDTH, dashboard, browse, create, claims, entries
+        );
+    }
+
+    private QuestBoardDialogSpec.QuestEntry questEntry(
+        Quest quest,
+        Player player,
+        java.time.Instant now
+    ) {
+        List<QuestBoardDialogSpec.Action> actions = new java.util.ArrayList<>();
+        if (completer != null) {
+            actions.add(new QuestBoardDialogSpec.Action(
+                "Complete quest", QuestBoardDialogSpec.Route.COMPLETE, quest.id().toString()
+            ));
+        }
+        if (canceller != null && quest.issuerId().equals(player.getUniqueId())) {
+            actions.add(new QuestBoardDialogSpec.Action(
+                "Cancel quest", QuestBoardDialogSpec.Route.CANCEL, quest.id().toString()
+            ));
+        }
+        return new QuestBoardDialogSpec.QuestEntry(
+            quest.requestedAmount() + " × " + quest.requestedMaterial(),
+            QuestListingFormatter.format(quest, now),
+            actions,
+            true
+        );
+    }
+
+    private static QuestBoardDialogSpec.Action action(
+        String label,
+        QuestBoardDialogSpec.Route route
+    ) {
+        return new QuestBoardDialogSpec.Action(label, route, null);
+    }
+
+    private Dialog renderDashboard(QuestBoardDialogSpec specification, Player player) {
+        List<Dialog> screens = List.of(
+            renderBrowse(specification, player),
+            renderCreate(specification, player),
+            renderClaims(specification, player)
+        );
+        return dialog(
+            specification.dashboard(),
+            DialogType.dialogList(
+                RegistrySet.valueSet(RegistryKey.DIALOG, screens), null, 1, 260
+            )
+        );
+    }
+
+    private Dialog renderBrowse(QuestBoardDialogSpec specification, Player player) {
+        ActionButton back = backToDashboard(player);
+        if (specification.questEntries().isEmpty()) {
+            return dialog(specification.browse(), DialogType.notice(back));
+        }
+        List<Dialog> quests = specification.questEntries().stream()
+            .map(entry -> renderQuest(entry, player))
+            .toList();
+        return dialog(
+            specification.browse(),
+            DialogType.dialogList(
+                RegistrySet.valueSet(RegistryKey.DIALOG, quests), back, 1, 260
+            )
+        );
+    }
+
+    private Dialog renderCreate(QuestBoardDialogSpec specification, Player player) {
        ActionButton create = ActionButton.builder(Component.text("Create quest"))
            .tooltip(Component.text("Escrow your held stack and publish this quest"))
-            .width(150)
+            .width(180)
            .action(DialogAction.customClick((response, audience) -> {
                if (audience instanceof Player respondingPlayer) {
                    submit(
@@ -77,64 +206,111 @@ final class QuestBoardDialogUi implements QuestBoardUi {
                        response.getText("requested_quantity")
                    );
                }
-            }, ClickCallback.Options.builder()
-                .uses(1)
-                .lifetime(Duration.ofMinutes(10))
-                .build()))
+            }, CALLBACK_OPTIONS))
            .build();
-        java.time.Instant now = clock.instant();
-        List<Quest> activeQuests = browser.activeQuests(now);
-        String listing = QuestListingFormatter.formatAll(activeQuests, now);
-        String claimListing = claimListingText(player);
-        List<ActionButton> actions = new ArrayList<>();
-        actions.add(create);
-        if (claimant != null) {
-            actions.add(ActionButton.builder(Component.text("Collect pending claims"))
-                .tooltip(Component.text("Collect delivered blocks and returned rewards"))
-                .width(250)
-                .action(DialogAction.customClick((response, audience) -> {
-                    if (audience instanceof Player respondingPlayer) {
-                        submitClaim(respondingPlayer);
-                    }
-                }, ClickCallback.Options.builder()
-                    .uses(1)
-                    .lifetime(Duration.ofMinutes(10))
-                    .build()))
-                .build());
+        return dialog(
+            specification.create(),
+            DialogType.multiAction(List.of(create), backToDashboard(player), 1)
+        );
+    }
+
+    private Dialog renderClaims(QuestBoardDialogSpec specification, Player player) {
+        ActionButton back = backToDashboard(player);
+        if (claimant == null) {
+            return dialog(specification.claims(), DialogType.notice(back));
        }
-        for (Quest quest : activeQuests) {
-            if (completer != null) {
-                actions.add(completionButton(quest));
-            }
-            if (canceller != null && quest.issuerId().equals(player.getUniqueId())) {
-                actions.add(cancellationButton(quest));
-            }
-        }
-        DialogBase base = DialogBase.builder(Component.text("Quest Board"))
-            .externalTitle(Component.text("Quest Board — Active quests and create"))
-            .body(List.of(DialogBody.plainMessage(Component.text(
-                "ACTIVE QUESTS\n" + listing + "\n\nYOUR PENDING CLAIMS\n" + claimListing
-                    + "\n\nCREATE A QUEST\n"
-                    + "Hold the reward in your main hand. The entire exact stack, including all item metadata, "
-                    + "will be removed and held in escrow only if this quest saves successfully."
-            ), 800)))
-            .inputs(List.of(
-                DialogInput.text("requested_material", Component.text("Requested block"))
-                    .initial("")
-                    .maxLength(64)
-                    .build(),
-                DialogInput.text("requested_quantity", Component.text("Quantity"))
-                    .initial("64")
-                    .maxLength(10)
-                    .build()
-            ))
+        ActionButton collect = callbackButton(
+            "Collect pending claims",
+            "Collect delivered blocks and returned rewards",
+            250,
+            respondingPlayer -> submitClaim(respondingPlayer)
+        );
+        return dialog(
+            specification.claims(), DialogType.multiAction(List.of(collect), back, 1)
+        );
+    }
+
+    private Dialog renderQuest(QuestBoardDialogSpec.QuestEntry entry, Player player) {
+        QuestBoardDialogSpec.Screen screen = new QuestBoardDialogSpec.Screen(
+            entry.title(), entry.title(), entry.message(), entry.actions(), List.of(), true
+        );
+        ActionButton back = backToBrowse(player);
+        List<ActionButton> actions = entry.actions().stream()
+            .map(action -> renderQuestAction(action))
+            .toList();
+        return dialog(
+            screen,
+            actions.isEmpty() ? DialogType.notice(back) : DialogType.multiAction(actions, back, 1)
+        );
+    }
+
+    private ActionButton renderQuestAction(QuestBoardDialogSpec.Action action) {
+        return switch (action.route()) {
+            case COMPLETE -> callbackButton(
+                action.label(), "Deliver the requested blocks", 180,
+                player -> submitCompletion(player, action.questId())
+            );
+            case CANCEL -> callbackButton(
+                action.label(), "Return the escrowed reward to pending claims", 180,
+                player -> submitCancellation(player, action.questId())
+            );
+            default -> throw new IllegalArgumentException("Unsupported quest action route");
+        };
+    }
+
+    private Dialog dialog(QuestBoardDialogSpec.Screen screen, DialogType type) {
+        DialogBase.Builder base = DialogBase.builder(Component.text(screen.title()))
+            .externalTitle(Component.text(screen.externalTitle()))
+            .body(List.of(DialogBody.plainMessage(Component.text(screen.message()), DIALOG_WIDTH)))
            .canCloseWithEscape(true)
            .pause(false)
-            .afterAction(DialogBase.DialogAfterAction.CLOSE)
+            .afterAction(DialogBase.DialogAfterAction.CLOSE);
+        if (!screen.inputs().isEmpty()) {
+            base.inputs(screen.inputs().stream().map(input -> DialogInput.text(
+                    input.key(), Component.text(input.label())
+                )
+                .initial(input.initial())
+                .maxLength(input.maximumLength())
+                .build()).toList());
+        }
+        DialogBase builtBase = base.build();
+        return Dialog.create(factory -> factory.empty().base(builtBase).type(type));
+    }
+
+    private ActionButton backToDashboard(Player player) {
+        return callbackButton(
+            "Back", "Return to the quest-board dashboard", 120,
+            respondingPlayer -> respondingPlayer.showDialog(
+                renderDashboard(specification(respondingPlayer), respondingPlayer)
+            )
+        );
+    }
+
+    private ActionButton backToBrowse(Player player) {
+        return callbackButton(
+            "Back", "Return to active quests", 120,
+            respondingPlayer -> {
+                QuestBoardDialogSpec current = specification(respondingPlayer);
+                respondingPlayer.showDialog(renderBrowse(current, respondingPlayer));
+            }
+        );
+    }
+
+    private ActionButton callbackButton(
+        String label,
+        String tooltip,
+        int width,
+        java.util.function.Consumer<Player> callback
+    ) {
+        return ActionButton.builder(Component.text(label))
+            .tooltip(Component.text(tooltip))
+            .width(width)
+            .action(DialogAction.customClick((response, audience) -> {
+                if (audience instanceof Player respondingPlayer) {
+                    callback.accept(respondingPlayer);
+                }
+            }, CALLBACK_OPTIONS))
            .build();
-        player.showDialog(Dialog.create(factory -> factory.empty()
-            .base(base)
-            .type(DialogType.multiAction(actions).columns(1).build())));
    }

    String listingText() {
@@ -161,42 +337,6 @@ final class QuestBoardDialogUi implements QuestBoardUi {
        }).reduce((left, right) -> left + "\n" + right).orElseThrow();
    }

-    private ActionButton completionButton(Quest quest) {
-        String id = quest.id().toString();
-        return ActionButton.builder(Component.text(
-                "Complete " + quest.requestedAmount() + " " + quest.requestedMaterial()
-            ))
-            .tooltip(Component.text("Deliver blocks for quest " + id))
-            .width(250)
-            .action(DialogAction.customClick((response, audience) -> {
-                if (audience instanceof Player respondingPlayer) {
-                    submitCompletion(respondingPlayer, id);
-                }
-            }, ClickCallback.Options.builder()
-                .uses(1)
-                .lifetime(Duration.ofMinutes(10))
-                .build()))
-            .build();
-    }
-
-    private ActionButton cancellationButton(Quest quest) {
-        String id = quest.id().toString();
-        return ActionButton.builder(Component.text(
-                "Cancel " + quest.requestedAmount() + " " + quest.requestedMaterial()
-            ))
-            .tooltip(Component.text("Return the escrowed reward to claims for quest " + id))
-            .width(250)
-            .action(DialogAction.customClick((response, audience) -> {
-                if (audience instanceof Player respondingPlayer) {
-                    submitCancellation(respondingPlayer, id);
-                }
-            }, ClickCallback.Options.builder()
-                .uses(1)
-                .lifetime(Duration.ofMinutes(10))
-                .build()))
-            .build();
-    }
-
    List<String> cancellableQuestIds(Player player) {
        return browser.cancellableQuestIds(player.getUniqueId(), clock.instant());
    }