类 CustomForm`预览版`

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.

索引

构造函数

constructor

方法

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

构造函数

constructor

new CustomForm(
player: Player,
title: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
): CustomForm
参数
- 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.
返回 CustomForm
备注
Creates a new CustomForm for the specified player with the given title.

抛出
This function can throw errors.

InvalidEntityError
- 定义于 @minecraft/server-ui.d.ts:281

方法

button

button(
    label: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
    onClick: () => void,
    options?: ButtonOptions,
): CustomForm
世界修改
参数
- 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.
- 可选options: ButtonOptions
  Optional configuration for the button, such as a tooltip, disabled state, or visibility.
返回 CustomForm
备注
Adds a clickable button to the form layout. Returns the form instance to allow method chaining.

抛出
This function can throw errors.

InvalidFormModificationError
- 定义于 @minecraft/server-ui.d.ts:304

close

close(): void
世界修改
返回 void
备注
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 throw errors.

EngineError

FormVisibilityError

InvalidEntityError
- 定义于 @minecraft/server-ui.d.ts:325

closeButton

closeButton(): CustomForm
世界修改
返回 CustomForm
备注
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 throw errors.

InvalidFormModificationError
- 定义于 @minecraft/server-ui.d.ts:338

divider

divider(options?: DividerOptions): CustomForm
世界修改
参数
- 可选options: DividerOptions
  Optional configuration for the divider, such as visibility.
返回 CustomForm
备注
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 throw errors.

InvalidFormModificationError
- 定义于 @minecraft/server-ui.d.ts:353

dropdown(
    label: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
    value: ObservableNumber,
    items: DropdownItemData[],
    options?: DropdownOptions,
): CustomForm
世界修改
参数
- 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.
- 可选options: DropdownOptions
  Optional configuration for the dropdown, such as a description, disabled state, or visibility.
返回 CustomForm
备注
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 throw errors.

InvalidFormModificationError

InvalidObservableError
- 定义于 @minecraft/server-ui.d.ts:379

header(
text: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
options?: TextOptions,
): CustomForm
世界修改
参数
- text: string | ObservableString | ObservableUIRawMessage | UIRawMessage
  The header text to display.
- 可选options: TextOptions
  Optional configuration for the header, such as visibility.
返回 CustomForm
备注
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 throw errors.

InvalidFormModificationError
- 定义于 @minecraft/server-ui.d.ts:402

isShowing

isShowing(): boolean
世界修改
返回 boolean
备注
Returns true if the form is currently being shown to the player, false otherwise.
- 定义于 @minecraft/server-ui.d.ts:411

label

label(
text: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
options?: TextOptions,
): CustomForm
世界修改
参数
- text: string | ObservableString | ObservableUIRawMessage | UIRawMessage
  The text to display in the label.
- 可选options: TextOptions
  Optional configuration for the label, such as visibility.
返回 CustomForm
备注
Adds a read-only text label to the form layout. Returns the form instance to allow method chaining.

抛出
This function can throw errors.

InvalidFormModificationError
- 定义于 @minecraft/server-ui.d.ts:427

show

show(): Promise<DataDrivenScreenClosedReason>
世界修改
返回 Promise<DataDrivenScreenClosedReason>
备注
Shows the form to the player. Returns a promise that resolves with a DataDrivenScreenClosedReason indicating how the form was closed.

抛出
This function can throw errors.

EngineError

FormVisibilityError

InvalidEntityError
- 定义于 @minecraft/server-ui.d.ts:444

slider

slider(
    label: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
    value: ObservableNumber,
    min: number | ObservableNumber,
    max: number | ObservableNumber,
    options?: SliderOptions,
): CustomForm
世界修改
参数
- 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.
- 可选options: SliderOptions
  Optional configuration for the slider, such as step size, a description, disabled state, or visibility.
返回 CustomForm
备注
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 throw errors.

InvalidFormModificationError

InvalidObservableError
- 定义于 @minecraft/server-ui.d.ts:472

spacer

spacer(options?: SpacingOptions): CustomForm
世界修改
参数
- 可选options: SpacingOptions
  Optional configuration for the spacer, such as visibility.
返回 CustomForm
备注
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 throw errors.

InvalidFormModificationError
- 定义于 @minecraft/server-ui.d.ts:493

textField

textField(
    label: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
    text: ObservableString,
    options?: TextFieldOptions,
): CustomForm
世界修改
参数
- 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.
- 可选options: TextFieldOptions
  Optional configuration for the text field, such as a description, disabled state, or visibility.
返回 CustomForm
备注
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 throw errors.

InvalidFormModificationError

InvalidObservableError
- 定义于 @minecraft/server-ui.d.ts:517

toggle

toggle(
    label: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
    toggled: ObservableBoolean,
    options?: ToggleOptions,
): CustomForm
世界修改
参数
- 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.
- 可选options: ToggleOptions
  Optional configuration for the toggle, such as a description, disabled state, or visibility.
返回 CustomForm
备注
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 throw errors.

InvalidFormModificationError

InvalidObservableError
- 定义于 @minecraft/server-ui.d.ts:545

类 CustomForm预览版

索引

构造函数

方法

构造函数

constructor

参数

返回 CustomForm

备注

抛出

方法

button

参数

返回 CustomForm

备注

抛出

close

返回 void

备注

抛出

closeButton

返回 CustomForm

备注

抛出

divider

参数

返回 CustomForm

备注

抛出

dropdown

参数

返回 CustomForm

备注

抛出

header

参数

返回 CustomForm

备注

抛出

isShowing

返回 boolean

备注

label

参数

返回 CustomForm

备注

抛出

show

返回 Promise<DataDrivenScreenClosedReason>

备注

抛出

slider

参数

返回 CustomForm

备注

抛出

spacer

参数

返回 CustomForm

备注

抛出

textField

参数

返回 CustomForm

备注

抛出

toggle

参数

返回 CustomForm

备注

抛出

显示设置

目录

类 CustomForm`预览版`