类 MessageBox`实验性`

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

索引

构造函数

方法

body button1 button2 close isShowing show create

构造函数

constructor

new MessageBox(): MessageBox
返回 MessageBox

方法

body

body(
    text:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
): MessageBox
参数
- text: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
返回 MessageBox
备注
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.
- 定义于 @minecraft/server-ui.d.ts:381

button1

button1(
    label:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
    tooltip?:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
): MessageBox
参数
- label: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
- 可选tooltip: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
返回 MessageBox
备注
Sets the data for the top button in the message box.
- 定义于 @minecraft/server-ui.d.ts:387

button2

button2(
    label:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
    tooltip?:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
): MessageBox
参数
- label: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
- 可选tooltip: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
返回 MessageBox
备注
Sets the data for the bottom button in the message box.
- 定义于 @minecraft/server-ui.d.ts:396

close

close(): void
返回 void
备注
Tell the client to close the message box. Throws FormCloseError if the message box is not open.
- 定义于 @minecraft/server-ui.d.ts:406

isShowing

isShowing(): boolean
返回 boolean
备注
Returns true if the message box is currently being shown to the player.
- 定义于 @minecraft/server-ui.d.ts:413

show

show(): Promise<MessageBoxResult>
返回 Promise<MessageBoxResult>
备注
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.
- 定义于 @minecraft/server-ui.d.ts:421

`静态`create

create(
    player: Player,
    title:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
): MessageBox
参数
- player: Player
- title: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
返回 MessageBox
备注
Creates a message box for a certain player. Use this instead of a constructor.
- 定义于 @minecraft/server-ui.d.ts:428