跳到正文
本頁目錄

顯示錶單

表單就是 Minecraft 基岩版的對話框:帶標題、文本和按鈕的窗口,或帶輸入控件的窗口。插件把表單發給一個玩家,並在回調中得到玩家的回答。 本指南用一個命令打開菜單,請玩家輸入內容,再請玩家確認。

示例使用 JavaScript;API 在每種語言中都相同。參考見普通表單構建器 API 和表單 API。

1. 按鈕菜單

普通表單有標題、文本和按鈕。用 mc.newSimpleForm() 構建它;每個函數都返回表單本身,因此可以鏈式調用:

JavaScript
const menu = mc.newSimpleForm()
    .setTitle("Menu")
    .setContent("What do you want to do?")
    .addButton("Rules", "textures/items/apple")
    .addButton("Players online")
    .addButton("Close");

addButton 的第二個參數是可選的圖片:遊戲中某個紋理的路徑,例如 textures/items/apple,或者一個 URL。

2. 發送表單並處理回答

pl.sendForm(form, callback) 把表單顯示給一個玩家。回調得到玩家和他按下的按鈕序號(從 0 開始);如果玩家關閉了表單,序號為 Null:

JavaScript
function openMenu(player) {
    player.sendForm(menu, (player, id) => {
        if (id == null) return; // 已关闭
        switch (id) {
            case 0:
                player.tell("Be nice, and have fun.");
                break;
            case 1:
                player.tell(`Online: ${mc.getOnlinePlayers().map((p) => p.name).join(", ")}`);
                break;
        }
    });
}

mc.regPlayerCmd("menu", "Opens the menu", (player, args) => {
    openMenu(player);
});

重啟服務器,在遊戲中輸入 /menu。一個表單對象可以發送任意多次、發給任意多個玩家:每次發送都有自己的回調。

3. 帶輸入控件的表單

自定義表單包含玩家要填寫的控件:輸入框、開關、下拉菜單和滑塊。用 mc.newCustomForm() 構建它:

JavaScript
const settings = mc.newCustomForm()
    .setTitle("Settings")
    .addInput("Nickname", "Enter a nickname", "")
    .addSwitch("Show welcome messages", true)
    .addDropdown("Team", ["Red", "Blue", "Green"], 0)
    .addSlider("View distance", 2, 16, 1, 8);

回調得到一個數組,按表單中的順序存放每個控件的值;如果玩家關閉了表單,則為 Null:

JavaScript
player.sendForm(settings, (player, data) => {
    if (data == null) return; // 已关闭
    const [nickname, welcome, team, distance] = data;
    player.tell(`Nickname: ${nickname}, welcome messages: ${welcome}, team: ${team}, view distance: ${distance}`);
});

構建你自己的表單時,先用 log 輸出一次 data,看看哪個下標對應哪個控件、每個值是什麼樣子。

4. 請玩家確認

模式表單有一段文本和兩個按鈕。pl.sendModalForm 一次調用就能發送它;按下第一個按鈕時回調得到 true,第二個按鈕得到 false,玩家關閉表單時得到 Null:

JavaScript
player.sendModalForm("Reset", "Reset your settings?", "Yes", "No", (player, result) => {
    if (result) {
        player.tell("Your settings were reset.");
    }
});

須知

  • sendForm 和 sendModalForm 返回表單的 ID;無法發送時返回 Null。
  • 回調還會得到第三個參數,即表單關閉的原因:0 表示玩家關閉了它,1 表示玩家正忙。它可能為 Null。
  • pl.closeForm() 關閉玩家當前打開的表單。
  • 也可以不用構建器發送表單:pl.sendSimpleForm 以文本數組和圖片數組給出按鈕,pl.sendCustomForm 接受表單的 JSON。 見表單 API。