Class CustomForm

Rc

A customizable data driven (DDUI) form that lets you add buttons, labels, toggles, dropdowns, sliders, text fields, and more. The form layout is built by calling methods to add components before calling show(). Any Observable values bound to form components will automatically update the UI when their values change.

Index

Constructors

constructor

Methods

button close closeButton divider dropdown header isShowing label show slider spacer textField toggle

Constructors

constructor

new CustomForm(
player: Player,
title: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
): CustomForm
Parameters
- player: Player
  The player to show this form to.
- title: string | ObservableString | ObservableUIRawMessage | UIRawMessage
  The title text to display at the top of the form.
Returns CustomForm
Remarks
Creates a new CustomForm for the specified player with the given title.

Throws
This function can throw errors.

minecraftserver.InvalidEntityError
- Defined in tmp/package/index.d.ts:383

Methods

button

button(
    label: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
    onClick: () => void,
    options?: ButtonOptions,
): CustomForm
Parameters
- label: string | ObservableString | ObservableUIRawMessage | UIRawMessage
  The text label to display on the button.
- onClick: () => void
  A callback function that is invoked when the player clicks the button.
- Optionaloptions: ButtonOptions
  Optional configuration for the button, such as a tooltip, disabled state, or visibility.
Returns CustomForm
Remarks
Adds a clickable button to the form layout. Returns the form instance to allow method chaining.

This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

InvalidFormModificationError
- Defined in tmp/package/index.d.ts:406

close

close(): void
Returns void
Remarks
Closes the form if it is currently being shown to the player. Throws a FormVisibilityError if the form is not currently open.

This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

minecraftcommon.EngineError

FormVisibilityError

minecraftserver.InvalidEntityError
- Defined in tmp/package/index.d.ts:427

closeButton

closeButton(): CustomForm
Returns CustomForm
Remarks
Adds a close button to the form at the bottom and as an 'X' in the corner. Returns the form instance to allow method chaining.

This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

InvalidFormModificationError
- Defined in tmp/package/index.d.ts:440

divider

divider(options?: DividerOptions): CustomForm
Parameters
- Optionaloptions: DividerOptions
  Optional configuration for the divider, such as visibility.
Returns CustomForm
Remarks
Adds a horizontal divider line to the form layout. Useful for visually separating sections of the form. Returns the form instance to allow method chaining.

This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

InvalidFormModificationError
- Defined in tmp/package/index.d.ts:455

dropdown(
    label: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
    value: ObservableNumber,
    items: DropdownItemData[],
    options?: DropdownOptions,
): CustomForm
Parameters
- label: string | ObservableString | ObservableUIRawMessage | UIRawMessage
  The text label displayed around the dropdown.
- value: ObservableNumber
  An ObservableNumber that holds the index of the currently selected item.
- items: DropdownItemData[]
  The list of items to display in the dropdown.
- Optionaloptions: DropdownOptions
  Optional configuration for the dropdown, such as a description, disabled state, or visibility.
Returns CustomForm
Remarks
Adds a dropdown selection control to the form layout. The current selection is tracked via an ObservableNumber and will update when the player changes the selection. Returns the form instance to allow method chaining.

This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

InvalidFormModificationError

InvalidObservableError
- Defined in tmp/package/index.d.ts:481

header(
text: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
options?: TextOptions,
): CustomForm
Parameters
- text: string | ObservableString | ObservableUIRawMessage | UIRawMessage
  The header text to display.
- Optionaloptions: TextOptions
  Optional configuration for the header, such as visibility.
Returns CustomForm
Remarks
Adds a header text component to the form layout. Headers are displayed in a larger or bolder style than regular labels, and are suitable for section titles. Returns the form instance to allow method chaining.

This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

InvalidFormModificationError
- Defined in tmp/package/index.d.ts:504

isShowing

isShowing(): boolean
Returns boolean
Remarks
Returns true if the form is currently being shown to the player, false otherwise.

This function can't be called in restricted-execution mode.
- Defined in tmp/package/index.d.ts:513

label

label(
text: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
options?: TextOptions,
): CustomForm
Parameters
- text: string | ObservableString | ObservableUIRawMessage | UIRawMessage
  The text to display in the label.
- Optionaloptions: TextOptions
  Optional configuration for the label, such as visibility.
Returns CustomForm
Remarks
Adds a read-only text label to the form layout. Returns the form instance to allow method chaining.

This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

InvalidFormModificationError
- Defined in tmp/package/index.d.ts:529

show

show(): Promise<DataDrivenScreenClosedReason>
Returns Promise<DataDrivenScreenClosedReason>
Remarks
Shows the form to the player. Returns a promise that resolves with a DataDrivenScreenClosedReason indicating how the form was closed.

This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

minecraftcommon.EngineError

FormVisibilityError

minecraftserver.InvalidEntityError
- Defined in tmp/package/index.d.ts:546

slider

slider(
    label: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
    value: ObservableNumber,
    min: number | ObservableNumber,
    max: number | ObservableNumber,
    options?: SliderOptions,
): CustomForm
Parameters
- label: string | ObservableString | ObservableUIRawMessage | UIRawMessage
  The text label displayed around the slider.
- value: ObservableNumber
  An ObservableNumber that holds the current value of the slider.
- min: number | ObservableNumber
  The minimum value of the slider range.
- max: number | ObservableNumber
  The maximum value of the slider range.
- Optionaloptions: SliderOptions
  Optional configuration for the slider, such as step size, a description, disabled state, or visibility.
Returns CustomForm
Remarks
Adds a numeric slider control to the form layout. The current value is tracked via an ObservableNumber and will update as the player moves the slider. Returns the form instance to allow method chaining.

This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

InvalidFormModificationError

InvalidObservableError
- Defined in tmp/package/index.d.ts:574

spacer

spacer(options?: SpacingOptions): CustomForm
Parameters
- Optionaloptions: SpacingOptions
  Optional configuration for the spacer, such as visibility.
Returns CustomForm
Remarks
Adds a vertical spacer component to the form layout. Useful for adding empty space between form components. Returns the form instance to allow method chaining.

This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

InvalidFormModificationError
- Defined in tmp/package/index.d.ts:595

textField

textField(
    label: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
    text: ObservableString,
    options?: TextFieldOptions,
): CustomForm
Parameters
- label: string | ObservableString | ObservableUIRawMessage | UIRawMessage
  The text label displayed around the text field.
- text: ObservableString
  An ObservableString that holds the current text value of the input field.
- Optionaloptions: TextFieldOptions
  Optional configuration for the text field, such as a description, disabled state, or visibility.
Returns CustomForm
Remarks
Adds a text input field to the form layout. The current text value is tracked via an ObservableString and will update as the player types. Returns the form instance to allow method chaining.

This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

InvalidFormModificationError

InvalidObservableError
- Defined in tmp/package/index.d.ts:619

toggle

toggle(
    label: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
    toggled: ObservableBoolean,
    options?: ToggleOptions,
): CustomForm
Parameters
- label: string | ObservableString | ObservableUIRawMessage | UIRawMessage
  The text label displayed next to the toggle.
- toggled: ObservableBoolean
  An ObservableBoolean that holds the current on/off state of the toggle.
- Optionaloptions: ToggleOptions
  Optional configuration for the toggle, such as a description, disabled state, or visibility.
Returns CustomForm
Remarks
Adds a toggle (on/off switch) control to the form layout. The current state is tracked via an ObservableBoolean and will update when the player toggles it. Returns the form instance to allow method chaining.

This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

InvalidFormModificationError

InvalidObservableError
- Defined in tmp/package/index.d.ts:647

Class CustomForm

Rc

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CustomForm

Remarks

Throws

Methods

button

Parameters

Returns CustomForm

Remarks

Throws

close

Returns void

Remarks

Throws

closeButton

Returns CustomForm

Remarks

Throws

divider

Parameters

Returns CustomForm

Remarks

Throws

dropdown

Parameters

Returns CustomForm

Remarks

Throws

header

Parameters

Returns CustomForm

Remarks

Throws

isShowing

Returns boolean

Remarks

label

Parameters

Returns CustomForm

Remarks

Throws

show

Returns Promise<DataDrivenScreenClosedReason>

Remarks

Throws

slider

Parameters

Returns CustomForm

Remarks

Throws

spacer

Parameters

Returns CustomForm

Remarks

Throws

textField

Parameters

Returns CustomForm

Remarks

Throws

toggle

Parameters

Returns CustomForm

Remarks

Throws

Settings

On This Page