Class MessageBox`Beta`

A simple message form UI, 2 buttons and a text body.

Index

Constructors

Methods

body button1 button2 close show create

Constructors

constructor

new MessageBox(): MessageBox
Returns MessageBox

Methods

body

body(
    text:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
): MessageBox
Parameters
- text: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
Returns MessageBox
Remarks
Sets the data for the text in the body of the form. It is contained within a scroll view to allow for lots of text.

World Ready
This function can't be called in early-execution mode.

button1

button1(
    label:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
    tooltip?:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
): MessageBox
Parameters
- label: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
- Optionaltooltip: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
Returns MessageBox
Remarks
Sets the data for the top button in the form.

World Ready
This function can't be called in early-execution mode.

button2

button2(
    label:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
    tooltip?:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
): MessageBox
Parameters
- label: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
- Optionaltooltip: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
Returns MessageBox
Remarks
Sets the data for the bottom button in the form.

World Ready
This function can't be called in early-execution mode.

close

close(): void
Returns void
Remarks
Closes the form. Will throw an error if the form is not open.

World Ready
This function can't be called in early-execution mode.

show

show(): Promise<MessageBoxResult>
Returns Promise<MessageBoxResult>
Remarks
Show this modal to the player. Will throw an error if the modal is already showing.

World Ready
This function can't be called in early-execution mode.

`Static`create

create(
    player: Player,
    title:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
): MessageBox
Parameters
- player: Player
- title: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
Returns MessageBox
Remarks
Creates a message form for a certain player. Use this instead of a constructor.

World Ready
This function can't be called in early-execution mode.