Class MessageBox`Beta`

A simple message form with two buttons and a text body. Use this class to show a basic dialog to a player and handle the player's button selection.

Index

Constructors

Methods

body button1 button2 close isShowing show

Constructors

constructor

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

Throws
This function can throw errors.

InvalidEntityError
- Defined in @minecraft/server-ui.d.ts:551

Methods

body

body(
body: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
): MessageBox
World mutation
Parameters
- body: string | ObservableString | ObservableUIRawMessage | UIRawMessage
  The body text to display. Accepts either a plain string or an ObservableString.
Returns MessageBox
Remarks
Sets the body text displayed in the message box. Returns the message box instance to allow method chaining.

Throws
This function can throw errors.

InvalidFormModificationError
- Defined in @minecraft/server-ui.d.ts:569

button1

button1(
label: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
tooltip?: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
): MessageBox
World mutation
Parameters
- label: string | ObservableString | ObservableUIRawMessage | UIRawMessage
  The text label to display on the first button.
- Optionaltooltip: string | ObservableString | ObservableUIRawMessage | UIRawMessage
  Optional tooltip text shown when hovering over the first button.
Returns MessageBox
Remarks
Sets the label for the first button of the message box. Returns the message box instance to allow method chaining.

Throws
This function can throw errors.

InvalidFormModificationError
- Defined in @minecraft/server-ui.d.ts:586

button2

button2(
label: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
tooltip?: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
): MessageBox
World mutation
Parameters
- label: string | ObservableString | ObservableUIRawMessage | UIRawMessage
  The text label to display on the second button.
- Optionaltooltip: string | ObservableString | ObservableUIRawMessage | UIRawMessage
  Optional tooltip text shown when hovering over the second button.
Returns MessageBox
Remarks
Sets the label for the second button of the message box. Returns the message box instance to allow method chaining.

Throws
This function can throw errors.

InvalidFormModificationError
- Defined in @minecraft/server-ui.d.ts:606

close

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

Throws
This function can throw errors.

EngineError

FormVisibilityError

InvalidEntityError
- Defined in @minecraft/server-ui.d.ts:626

isShowing

isShowing(): boolean
World mutation
Returns boolean
Remarks
Returns true if the message box is currently being shown to the player, false otherwise.
- Defined in @minecraft/server-ui.d.ts:635

show

show(): Promise<MessageBoxResult>
World mutation
Returns Promise<MessageBoxResult>
Remarks
Shows the message box to the player. Returns a promise that resolves with a MessageBoxResult containing the close reason and the player's button selection.

Throws
This function can throw errors.

EngineError

FormVisibilityError

InvalidEntityError
- Defined in @minecraft/server-ui.d.ts:652