Script API - v1.26.10.23
    Preparing search index...

    Module @minecraft/server-ui - v2.1.0-betaBeta

    Advertisement

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

    • ActionFormData contain a list of buttons with captions and images that can be used for presenting a set of options to a player.
    • MessageFormData are simple two-button message experiences that are functional for Yes/No or OK/Cancel questions.
    • ModalFormData allow for a more flexible "questionnaire-style" list of controls that can be used to take input.

    Manifest Details

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

    @minecraft/common (Optional in Manifest Details)

    • Requires v1.0.0 or above
    {
    "module_name": "@minecraft/common",
    "version": "1.0.0"
    }

    @minecraft/server (Required one of the following in Manifest Details)

    • Requires v2.0.0 up to, but not including, v3.0.0
    {
    "module_name": "@minecraft/server",
    "version": "2.0.0"
    }
    • Requires v2.7.0-beta up to, but not including, v3.0.0
    {
    "module_name": "@minecraft/server",
    "version": "2.7.0-beta"
    }

    Install type definition for @minecraft/server-ui module using npm:

    npm i @minecraft/server-ui@2.1.0-beta.1.26.10-preview.23
    

    Enumerations

    FormCancelationReason
    FormRejectReason

    Classes

    ActionFormData
    ActionFormResponse
    CustomForm
    FormRejectError
    FormResponse
    MessageBox
    MessageFormData
    MessageFormResponse
    ModalFormData
    ModalFormResponse
    Observable
    UIManager

    Interfaces

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

    Variables

    uiManager
    Advertisement