Bedrock API Reference

Appearance

@minecraft/server-ui

@minecraft/server-ui / ActionFormResponse

Class: ActionFormResponse ​

Defined in: @minecraft/server-ui/index.d.ts:346

Returns data about the player results from a modal action form.

Examples ​

showActionForm.ts

typescript
import { world, DimensionLocation } from '@minecraft/server';
import { ActionFormData, ActionFormResponse } from '@minecraft/server-ui';

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

  if (playerList.length >= 1) {
    const form = new ActionFormData()
      .title('Test Title')
      .body('Body text here!')
      .button('btn 1')
      .button('btn 2')
      .button('btn 3')
      .button('btn 4')
      .button('btn 5');

    form.show(playerList[0]).then((result: ActionFormResponse) => {
      if (result.canceled) {
        log('Player exited out of the dialog. Note that if the chat window is up, dialogs are automatically canceled.');
        return -1;
      } else {
        log('Your result was: ' + result.selection);
      }
    });
  }
}

showFavoriteMonth.ts

typescript
import { world, DimensionLocation } from '@minecraft/server';
import { ActionFormData, ActionFormResponse } from '@minecraft/server-ui';

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

  if (players.length >= 1) {
    const form = new ActionFormData()
      .title('Months')
      .body('Choose your favorite month!')
      .button('January')
      .button('February')
      .button('March')
      .button('April')
      .button('May');

    form.show(players[0]).then((response: ActionFormResponse) => {
      if (response.selection === 3) {
        log('I like April too!');
        return -1;
      }
    });
  }
}

Extends ​

Properties ​

cancelationReason? ​

readonly optional cancelationReason?: FormCancelationReason

Defined in: @minecraft/server-ui/index.d.ts:659

Remarks ​

Contains additional details as to why a form was canceled.

Inherited from ​

FormResponse.cancelationReason

canceled ​

readonly canceled: boolean

Defined in: @minecraft/server-ui/index.d.ts:666

Remarks ​

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

Inherited from ​

FormResponse.canceled

selection? ​

readonly optional selection?: number

Defined in: @minecraft/server-ui/index.d.ts:353

Remarks ​

Returns the index of the button that was pushed.