Class ModalFormData

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

Hierarchy

  • ModalFormData

Constructors

constructor

Methods

dropdown show slider textField title toggle

Constructors

constructor

Methods

dropdown

  • Remarks

    Adds a dropdown with choices to the form.

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

    Parameters

    • label: string | RawMessage
    • options: (string | RawMessage)[]
    • Optional defaultValueIndex: number

    Returns ModalFormData

show

  • 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.

    Parameters

    • player: Player

      Player to show this dialog to.

    Returns Promise<ModalFormResponse>

slider

  • Remarks

    Adds a numeric slider to the form.

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

    Parameters

    • label: string | RawMessage
    • minimumValue: number
    • maximumValue: number
    • valueStep: number
    • Optional defaultValue: number

    Returns ModalFormData

textField

  • Remarks

    Adds a textbox to the form.

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

    Parameters

    • label: string | RawMessage
    • placeholderText: string | RawMessage
    • Optional defaultValue: string

    Returns ModalFormData

title

  • Remarks

    This builder method sets the title for the modal dialog.

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

    Parameters

    • titleText: string | RawMessage

    Returns ModalFormData

toggle

  • Remarks

    Adds a toggle checkbox button to the form.

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

    Parameters

    • label: string | RawMessage
    • Optional defaultValue: boolean

    Returns ModalFormData

Settings

Member Visibility

Theme

On This Page