Class ModalFormData`Beta`

Used to create a fully customizable pop-up form for a player.

Index

Constructors

Methods

dropdown show slider textField title toggle

Constructors

constructor

new ModalFormData(): ModalFormData
Beta
Returns ModalFormData

Methods

dropdown(
    label: string | RawMessage,
    options: (string | RawMessage)[],
    defaultValueIndex?: number,
): ModalFormData
Beta
Parameters
- label: string | RawMessage
- options: (string | RawMessage)[]
- OptionaldefaultValueIndex: number
Returns ModalFormData
Remarks
Adds a dropdown with choices to the form.

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

show

show(player: Player): Promise<ModalFormResponse>
Beta
Parameters
- player: Player
  Player to show this dialog to.
Returns Promise<ModalFormResponse>
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.

slider

slider(
    label: string | RawMessage,
    minimumValue: number,
    maximumValue: number,
    valueStep: number,
    defaultValue?: number,
): ModalFormData
Beta
Parameters
- label: string | RawMessage
- minimumValue: number
- maximumValue: number
- valueStep: number
- OptionaldefaultValue: number
Returns ModalFormData
Remarks
Adds a numeric slider to the form.

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

textField

textField(
    label: string | RawMessage,
    placeholderText: string | RawMessage,
    defaultValue?: string,
): ModalFormData
Beta
Parameters
- label: string | RawMessage
- placeholderText: string | RawMessage
- OptionaldefaultValue: string
Returns ModalFormData
Remarks
Adds a textbox to the form.

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

title

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

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

toggle

toggle(label: string | RawMessage, defaultValue?: boolean): ModalFormData
Beta
Parameters
- label: string | RawMessage
- OptionaldefaultValue: boolean
Returns ModalFormData
Remarks
Adds a toggle checkbox button to the form.

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