For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /server-ui/classes/ModalFormResponse.md.

Class: ModalFormResponse

Beta

Returns data about player responses to a modal form. 返回有关玩家对模态表单响应的数据。

Example

showBasicModalForm.ts

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;
    });
}

Extends

Properties

cancelationReason?

readonly optional cancelationReason?: FormCancelationReason

Beta

Remarks

包含关于表单为何被取消的附加详细信息。

Contains additional details as to why a form was canceled.

Inherited from

FormResponse.cancelationReason


canceled

readonly canceled: boolean

Beta

Remarks

如果为 true,则表示表单已被玩家取消(例如,他们点击了弹窗的 X 关闭按钮)。

If true, the form was canceled by the player (e.g., they selected the pop-up X close button).

Inherited from

FormResponse.canceled


formValues?

readonly optional formValues?: (string | number | boolean | undefined)[]

Beta

Remarks

An ordered set of values based on the order of controls specified by ModalFormData. 基于 ModalFormData 指定的控件顺序的有序值集合。