ActionFormData

Class in @minecraft/server-ui

A list of buttons.

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

Example

TypeScript JavaScript

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

async function openWarps(player: Player): Promise<void> {
    const form = new ActionFormData().title('Warps').body('Where to?').button('Spawn').button('Shop');
    const response = await form.show(player);
    if (response.canceled) return;
    player.sendMessage(response.selection === 0 ? 'Off to spawn.' : 'Off to the shop.');
}

// Open the form when a player uses a compass.
world.afterEvents.itemUse.subscribe((event) => {
    if (event.itemStack.typeId === 'minecraft:compass') openWarps(event.source);
});

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

async function openWarps(player) {
    const form = new ActionFormData().title('Warps').body('Where to?').button('Spawn').button('Shop');
    const response = await form.show(player);
    if (response.canceled)
        return;
    player.sendMessage(response.selection === 0 ? 'Off to spawn.' : 'Off to the shop.');
}

// Open the form when a player uses a compass.
world.afterEvents.itemUse.subscribe((event) => {
    if (event.itemStack.typeId === 'minecraft:compass')
        openWarps(event.source);
});

Constructor

constructor();

Methods

title

title(titleText: Text): ActionFormData;

Parameters

titleText

Text

Returns

ActionFormData

body

body(bodyText: Text): ActionFormData;

Parameters

bodyText

Text

Returns

ActionFormData

button

button(text: Text, iconPath?: string): ActionFormData;

Parameters

text

Text

iconPathoptional

stringA resource pack texture path, or an http(s) address.

Returns

ActionFormData

header

header(text: Text): ActionFormData;

Parameters

text

Text

Returns

ActionFormData

label

label(text: Text): ActionFormData;

Parameters

text

Text

Returns

ActionFormData

divider

divider(): ActionFormData;

Returns

ActionFormData

show

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

Parameters

player

Player

Returns

Promise<ActionFormResponse>

Types

PlayerActionFormResponse