@minecraft/server-ui
    Preparing search index...

    Class ActionFormDataBeta

    Builds a simple player form with buttons that let the player take action.

    import { world, DimensionLocation } from "@minecraft/server";
    import { ActionFormData, ActionFormResponse } from "@minecraft/server-ui";

    function showActionForm(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
      const playerList = world.getPlayers();

      if (playerList.length >= 1) {
        const form = new ActionFormData()
          .title("Test Title")
          .body("Body text here!")
          .button("btn 1")
          .button("btn 2")
          .button("btn 3")
          .button("btn 4")
          .button("btn 5");

        form.show(playerList[0]).then((result: ActionFormResponse) => {
          if (result.canceled) {
            log("Player exited out of the dialog. Note that if the chat window is up, dialogs are automatically canceled.");
            return -1;
          } else {
            log("Your result was: " + result.selection);
          }
        });
      }
    }

    import { world, DimensionLocation } from "@minecraft/server";
    import { ActionFormData, ActionFormResponse } from "@minecraft/server-ui";

    function showFavoriteMonth(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
      const players = world.getPlayers();

      if (players.length >= 1) {
        const form = new ActionFormData()
          .title("Months")
          .body("Choose your favorite month!")
          .button("January")
          .button("February")
          .button("March")
          .button("April")
          .button("May");

        form.show(players[0]).then((response: ActionFormResponse) => {
          if (response.selection === 3) {
            log("I like April too!");
            return -1;
          }
        });
      }
    }
    Index

    Constructors

    constructor

    Methods

    body button divider header label show title

    Constructors

    Methods

    body

    • body(bodyText: string | RawMessage): ActionFormData
      Beta

      Parameters

      • bodyText: string | RawMessage

      Returns ActionFormData

      Method that sets the body text for the modal form.

    • Beta

      Parameters

      • text: string | RawMessage
      • OptionaliconPath: string

      Returns ActionFormData

      Adds a button to this form with an icon from a resource pack.

    • Beta

      Parameters

      • text: string | RawMessage

        Text to display.

      Returns ActionFormData

      Adds a header to the form.

    • Beta

      Parameters

      • text: string | RawMessage

        Text to display.

      Returns ActionFormData

      Adds a label to the form.

    • Beta

      Parameters

      • player: Player

        Player to show this dialog to.

      Returns Promise<ActionFormResponse>

      Creates and shows this modal popup form. Returns asynchronously when the player confirms or cancels the dialog.

      This function can't be called in read-only mode.

      This function can throw errors.

      minecraftcommon.EngineError

      minecraftserver.InvalidEntityError

      minecraftserver.RawMessageError

    • Beta

      Parameters

      • titleText: string | RawMessage

      Returns ActionFormData

      This builder method sets the title for the modal dialog.

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods