Class MessageFormData`Beta`

Builds a simple two-button modal dialog.

Index

Constructors

Methods

body button1 button2 show title

Constructors

constructor

new MessageFormData(): MessageFormData
Beta
Returns MessageFormData

Methods

body

body(bodyText: string | RawMessage): MessageFormData
Beta
Parameters
- bodyText: string | RawMessage
Returns MessageFormData
Remarks
Method that sets the body text for the modal form.

This function can't be called in read-only mode.

button1

button1(text: string | RawMessage): MessageFormData
Beta
Parameters
- text: string | RawMessage
Returns MessageFormData
Remarks
Method that sets the text for the first button of the dialog.

This function can't be called in read-only mode.

button2

button2(text: string | RawMessage): MessageFormData
Beta
Parameters
- text: string | RawMessage
Returns MessageFormData
Remarks
This method sets the text for the second button on the dialog.

This function can't be called in read-only mode.

show

show(player: Player): Promise<MessageFormResponse>
Beta
Parameters
- player: Player
  Player to show this dialog to.
Returns Promise<MessageFormResponse>
Remarks
Creates and shows this modal popup form. Returns asynchronously when the player confirms or cancels the dialog.

This function can't be called in read-only mode.

Throws
This function can throw errors.

title

title(titleText: string | RawMessage): MessageFormData
Beta
Parameters
- titleText: string | RawMessage
Returns MessageFormData
Remarks
This builder method sets the title for the modal dialog.

This function can't be called in read-only mode.