ModalFormData

Class in @minecraft/server-ui

A form of inputs.

import { ModalFormData } from '@minecraft/server-ui';

Example

TypeScript JavaScript

import { world, type Player } from '@minecraft/server';
import { ModalFormData } from '@minecraft/server-ui';

async function openSettings(player: Player): Promise<void> {
    const form = new ModalFormData()
        .title('Settings')
        .textField('Nickname', 'Type a name')
        .toggle('Show scoreboard', { defaultValue: true })
        .slider('Render distance', 4, 16, { defaultValue: 8 })
        .submitButton('Save');
    const response = await form.show(player);
    if (response.canceled || !response.formValues) return;

    // One value per field, in the order the fields were added.
    const [nickname, scoreboard, distance] = response.formValues;
    player.sendMessage(`Saved: ${nickname}, ${scoreboard}, ${distance}`);
}

world.afterEvents.itemUse.subscribe((event) => {
    if (event.itemStack.typeId === 'minecraft:book') openSettings(event.source);
});

import { world } from '@minecraft/server';
import { ModalFormData } from '@minecraft/server-ui';

async function openSettings(player) {
    const form = new ModalFormData()
        .title('Settings')
        .textField('Nickname', 'Type a name')
        .toggle('Show scoreboard', { defaultValue: true })
        .slider('Render distance', 4, 16, { defaultValue: 8 })
        .submitButton('Save');
    const response = await form.show(player);
    if (response.canceled || !response.formValues)
        return;

    // One value per field, in the order the fields were added.
    const [nickname, scoreboard, distance] = response.formValues;
    player.sendMessage(`Saved: ${nickname}, ${scoreboard}, ${distance}`);
}

world.afterEvents.itemUse.subscribe((event) => {
    if (event.itemStack.typeId === 'minecraft:book')
        openSettings(event.source);
});

Constructor

constructor();

Methods

title

title(titleText: Text): ModalFormData;

Parameters

titleText

Text

Returns

ModalFormData

textField

textField(label: Text, placeholderText: Text, textFieldOptions?: ModalFormDataTextFieldOptions): ModalFormData;
textField(label: Text, placeholderText: Text, defaultValue?: string): ModalFormData;

Deprecated

The 1.x form; pass { defaultValue } instead.

Types

ModalFormDataTextFieldOptions

toggle

toggle(label: Text, toggleOptions?: ModalFormDataToggleOptions): ModalFormData;
toggle(label: Text, defaultValue?: boolean): ModalFormData;

Deprecated

The 1.x form; pass { defaultValue } instead.

Types

ModalFormDataToggleOptions

slider

slider(label: Text, minimumValue: number, maximumValue: number, sliderOptions?: ModalFormDataSliderOptions): ModalFormData;
slider(label: Text, minimumValue: number, maximumValue: number, valueStep: number, defaultValue?: number): ModalFormData;

Deprecated

The 1.x form; pass { valueStep, defaultValue } instead.

Types

ModalFormDataSliderOptions

dropdown

dropdown(label: Text, items: Text[], dropdownOptions?: ModalFormDataDropdownOptions): ModalFormData;
dropdown(label: Text, items: Text[], defaultValueIndex?: number): ModalFormData;

Deprecated

The 1.x form; pass { defaultValueIndex } instead.

Types

ModalFormDataDropdownOptions

header

header(text: Text): ModalFormData;

Parameters

text

Text

Returns

ModalFormData

label

label(text: Text): ModalFormData;

Parameters

text

Text

Returns

ModalFormData

divider

divider(): ModalFormData;

Returns

ModalFormData

submitButton

submitButton(submitButtonText: Text): ModalFormData;

Parameters

submitButtonText

Text

Returns

ModalFormData

show

show(player: Player): Promise<ModalFormResponse>;

Parameters

player

Player

Returns

Promise<ModalFormResponse>

Types

PlayerModalFormResponse

Used by

UIManager.setServerSettings