Class ActionFormData

Builds a simple player form with buttons that let the player take action.

Hierarchy

  • ActionFormData

Constructors

constructor

Methods

body button show title

Constructors

constructor

Methods

body

  • Remarks

    Method that sets the body text for the modal form.

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

    Parameters

    • bodyText: string | RawMessage

    Returns ActionFormData

button

  • Remarks

    Adds a button to this form with an icon from a resource pack.

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

    Parameters

    • text: string | RawMessage
    • Optional iconPath: string

    Returns ActionFormData

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<ActionFormResponse>

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 ActionFormData

Settings

Member Visibility

Theme

On This Page