Class MessageBox`Beta`

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

Index

Constructors

constructor

Methods

body button1 button2 close isShowing 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 message box. 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 message box.

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 message box.

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

close

close(): void
Returns void
Remarks
Tell the client to close the message box. Throws FormCloseError if the message box is not open.

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

isShowing

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

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

show

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

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 box for a certain player. Use this instead of a constructor.

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

Class MessageBoxBeta

Index

Constructors

Methods

Constructors

constructor

Returns MessageBox

Methods

body

Parameters

Returns MessageBox

Remarks

World Ready

button1

Parameters

Returns MessageBox

Remarks

World Ready

button2

Parameters

Returns MessageBox

Remarks

World Ready

close

Returns void

Remarks

World Ready

isShowing

Returns boolean

Remarks

World Ready

show

Returns Promise<MessageBoxResult>

Remarks

World Ready

Staticcreate

Parameters

Returns MessageBox

Remarks

World Ready

Settings

On This Page

Class MessageBox`Beta`

`Static`create