Class MessageBox

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

constructor

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.

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

Methods

body

body(
body: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
): MessageBox
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.

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

Throws
This function can throw errors.

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

button1

button1(
label: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
tooltip?: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
): MessageBox
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.

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

Throws
This function can throw errors.

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

button2

button2(
label: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
tooltip?: string | ObservableString | ObservableUIRawMessage | UIRawMessage,
): MessageBox
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.

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

Throws
This function can throw errors.

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

close

close(): void
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.

Privilege
no-restricted-execution - 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:791

isShowing

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

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

show

show(): Promise<MessageBoxResult>
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.

Privilege
no-restricted-execution - 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:817

Class MessageBox

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MessageBox

Remarks

Throws

Methods

body

Parameters

Returns MessageBox

Remarks

Privilege

Throws

button1

Parameters

Returns MessageBox

Remarks

Privilege

Throws

button2

Parameters

Returns MessageBox

Remarks

Privilege

Throws

close

Returns void

Remarks

Privilege

Throws

isShowing

Returns boolean

Remarks

Privilege

show

Returns Promise<MessageBoxResult>

Remarks

Privilege

Throws

Settings

On This Page