Class MessageFormData

Builds a simple two-button modal dialog.

Hierarchy

  • MessageFormData

Constructors

Methods

Constructors

Methods

  • Parameters

    • bodyText: string | RawMessage

    Returns MessageFormData

    Remarks

    Method that sets the body text for the modal form.

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

  • Parameters

    • text: string | RawMessage

    Returns MessageFormData

    Remarks

    Method that sets the text for the first button of the dialog.

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

  • Parameters

    • text: string | RawMessage

    Returns MessageFormData

    Remarks

    This method sets the text for the second button on the dialog.

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

  • Parameters

    • player: Player

      Player to show this dialog to.

    Returns Promise<MessageFormResponse>

    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

    • titleText: string | RawMessage

    Returns MessageFormData

    Remarks

    This builder method sets the title for the modal dialog.

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