Class MessageFormData

Builds a simple two-button modal dialog.

Example

messageFormSimple.ts

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

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

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

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

Hierarchy

  • MessageFormData

Constructors

Methods

Constructors

Methods

  • Parameters

    • bodyText: string | RawMessage

    Returns MessageFormData

    Remarks

    Method that sets the body text for the modal form.

  • Parameters

    • text: string | RawMessage

    Returns MessageFormData

    Remarks

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

  • Parameters

    • text: string | RawMessage

    Returns MessageFormData

    Remarks

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

  • Parameters

    • player: Player

      Player to show this dialog to.

    Returns Promise<MessageFormResponse>

    Remarks

    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.

    Throws

    This function can throw errors.

  • Parameters

    • titleText: string | RawMessage

    Returns MessageFormData

    Remarks

    This builder method sets the title for the modal dialog.