Class MessageBox`Beta`

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

Index

Constructors

Methods

body button1 button2 close isShowing show create

Constructors

constructor

new MessageBox(): MessageBox
Beta
Returns MessageBox

Methods

body

body(
    text:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
): MessageBox
Beta
Parameters
- text: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
Returns MessageBox
Remarks
Sets the data for the text in the body of the message box. It is contained within a scroll view to allow for lots of text.
- Defined in tmp/package/index.d.ts:413

button1

button1(
    label:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
    tooltip?:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
): MessageBox
Beta
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 message box.
- Defined in tmp/package/index.d.ts:419

button2

button2(
    label:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
    tooltip?:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
): MessageBox
Beta
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 message box.
- Defined in tmp/package/index.d.ts:428

close

close(): void
Beta
Returns void
Remarks
Tell the client to close the message box. Throws FormCloseError if the message box is not open.
- Defined in tmp/package/index.d.ts:438

isShowing

isShowing(): boolean
Beta
Returns boolean
Remarks
Returns true if the message box is currently being shown to the player.
- Defined in tmp/package/index.d.ts:445

show

show(): Promise<MessageBoxResult>
Beta
Returns Promise<MessageBoxResult>
Remarks
Show this message box to the player. Will return a result even if the client was busy (i.e. in another menu). Will throw if the user disconnects.
- Defined in tmp/package/index.d.ts:453

`Static`create

create(
    player: Player,
    title:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
): MessageBox
Beta
Parameters
- player: Player
- title: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
Returns MessageBox
Remarks
Creates a message box for a certain player. Use this instead of a constructor.
- Defined in tmp/package/index.d.ts:460