@minecraft/server-ui Module

The @minecraft/server-ui module contains types for expressing simple dialog-based user experiences.

• @minecraft/server-ui.ActionFormData contain a list of buttons with captions and images that can be used for presenting a set of options to a player.

• @minecraft/server-ui.MessageFormData are simple two-button message experiences that are functional for Yes/No or OK/Cancel questions.

• @minecraft/server-ui.ModalFormData allow for a more flexible "questionnaire-style" list of controls that can be used to take input.

Changelog

Manifest Details

{
    "module_name": "@minecraft/server-ui",
    "version": "2.0.0"
}

This is version 2.x.x of this module, which is the latest as of version 1.26.30-beta.20 of Minecraft.

Available Versions

• 2.1.0-beta
• 2.0.0

Prior Versions

The following API versions are from a major version that is documented here: @minecraft/server-ui:

• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

Enumerations

• DataDrivenScreenClosedReason
• FormCancelationReason
• FormRejectReason
• TextFilteringError

Classes

• ActionFormData
• ActionFormResponse
• CustomForm
• FormCloseError
• FormResponse
• MessageBox
• MessageFormData
• MessageFormResponse
• ModalFormData
• ModalFormResponse
• Observable
• PlayerLeftError
• ServerShutdownError
• UIManager

Interfaces

• ButtonOptions
• DividerOptions
• DropdownItem
• DropdownOptions
• MessageBoxResult
• ModalFormDataDropdownOptions
• ModalFormDataSliderOptions
• ModalFormDataTextFieldOptions
• ModalFormDataToggleOptions
• ObservableOptions
• SliderOptions
• SpacingOptions
• TextFieldOptions
• TextOptions
• ToggleOptions
• UIRawMessage

Errors

• FormRejectError

Objects

uiManager

static read-only uiManager: UIManager;

Type: UIManager

Peer Dependencies

• @minecraft/common
• @minecraft/server