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

    Class ModalFormDataBeta

    Used to create a fully customizable pop-up form for a player.

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

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

    const modalForm = new ModalFormData().title("Example Modal Controls for §o§7ModalFormData§r");

    modalForm.toggle("Toggle w/o default");
    modalForm.toggle("Toggle w/ default", true);

    modalForm.slider("Slider w/o default", 0, 50, 5);
    modalForm.slider("Slider w/ default", 0, 50, 5, 30);

    modalForm.dropdown("Dropdown w/o default", ["option 1", "option 2", "option 3"]);
    modalForm.dropdown("Dropdown w/ default", ["option 1", "option 2", "option 3"], 2);

    modalForm.textField("Input w/o default", "type text here");
    modalForm.textField("Input w/ default", "type text here", "this is default");

    modalForm
    .show(players[0])
    .then((formData) => {
    players[0].sendMessage(`Modal form results: ${JSON.stringify(formData.formValues, undefined, 2)}`);
    })
    .catch((error: Error) => {
    log("Failed to show form: " + error);
    return -1;
    });
    }
    Index

    Constructors

    Methods

    • Beta

      Parameters

      • label: string | RawMessage
      • options: (string | RawMessage)[]
      • OptionaldefaultValueIndex: number

      Returns ModalFormData

      Adds a dropdown with choices to the form.

    • Beta

      Parameters

      • text: string | RawMessage

        Text to display.

      Returns ModalFormData

      Adds a header to the form.

    • Beta

      Parameters

      • text: string | RawMessage

        Text to display.

      Returns ModalFormData

      Adds a label to the form.

    • Beta

      Parameters

      • player: Player

        Player to show this dialog to.

      Returns Promise<ModalFormResponse>

      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.

    • Beta

      Parameters

      • label: string | RawMessage
      • minimumValue: number
      • maximumValue: number
      • valueStep: number
      • OptionaldefaultValue: number

      Returns ModalFormData

      Adds a numeric slider to the form.

    • Beta

      Parameters

      • submitButtonText: string | RawMessage

      Returns ModalFormData

    • Beta

      Parameters

      • label: string | RawMessage
      • placeholderText: string | RawMessage
      • OptionaldefaultValue: string | RawMessage

      Returns ModalFormData

      Adds a textbox to the form.

    • Beta

      Parameters

      • titleText: string | RawMessage

      Returns ModalFormData

      This builder method sets the title for the modal dialog.

    • Beta

      Parameters

      • label: string | RawMessage
      • OptionaldefaultValue: boolean

      Returns ModalFormData

      Adds a toggle checkbox button to the form.