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

    Class MessageFormDataBeta

    Builds a simple two-button modal dialog.

    import { world, DimensionLocation } from '@minecraft/server';
    import { MessageFormResponse, MessageFormData } from '@minecraft/server-ui';

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

      const messageForm = new MessageFormData()
        .title('Message Form Example')
        .body('This shows a simple example using §o§7MessageFormData§r.')
        .button1('Button 1')
        .button2('Button 2');

      messageForm
        .show(players[0])
        .then((formData: MessageFormResponse) => {
          // player canceled the form, or another dialog was up and open.
          if (formData.canceled || formData.selection === undefined) {
            return;
          }

          log(`You selected ${formData.selection === 0 ? 'Button 1' : 'Button 2'}`);
        })
        .catch((error: Error) => {
          log('Failed to show form: ' + error);
          return -1;
        });
    }

    import { world, DimensionLocation } from '@minecraft/server';
    import { MessageFormResponse, MessageFormData } from '@minecraft/server-ui';

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

      const messageForm = new MessageFormData()
        .title({ translate: 'permissions.removeplayer' })
        .body({ translate: 'accessibility.list.or.two', with: ['Player 1', 'Player 2'] })
        .button1('Player 1')
        .button2('Player 2');

      messageForm
        .show(players[0])
        .then((formData: MessageFormResponse) => {
          // player canceled the form, or another dialog was up and open.
          if (formData.canceled || formData.selection === undefined) {
            return;
          }

          log(`You selected ${formData.selection === 0 ? 'Player 1' : 'Player 2'}`);
        })
        .catch((error: Error) => {
          log('Failed to show form: ' + error);
          return -1;
        });
    }
    Index

    Constructors

    constructor

    Methods

    body button1 button2 show title

    Constructors

    Methods

    body

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

      Parameters

      • bodyText: string | RawMessage

      Returns MessageFormData

      Method that sets the body text for the modal form.

    • Beta

      Parameters

      • text: string | RawMessage

      Returns MessageFormData

      Method that sets the text for the first button of the dialog.

    • Beta

      Parameters

      • text: string | RawMessage

      Returns MessageFormData

      This method sets the text for the second button on the dialog.

    • Beta

      Parameters

      • player: Player

        Player to show this dialog to.

      Returns Promise<MessageFormResponse>

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

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.EngineError

      minecraftserver.InvalidEntityError

      minecraftserver.RawMessageError

    • Beta

      Parameters

      • titleText: string | RawMessage

      Returns MessageFormData

      This builder method sets the title for the modal dialog.

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods