Class ModalFormData

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

Hierarchy

ModalFormData

Index

Constructors

Methods

dropdown show slider textField title toggle

Constructors

constructor

new ModalFormData(): ModalFormData
Returns ModalFormData

Methods

dropdown

dropdown(label, options, defaultValueIndex?): ModalFormData
Parameters
- label: string
- options: string[]
- Optional defaultValueIndex: number
Returns ModalFormData

Remarks
Adds a dropdown with choices to the form.
- Defined in index.d.ts:200

show

show(player): Promise<ModalFormResponse>
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.

Throws
This function can throw errors.
- Defined in index.d.ts:210

slider

slider(label, minimumValue, maximumValue, valueStep, defaultValue?): ModalFormData
Parameters
- label: string
- minimumValue: number
- maximumValue: number
- valueStep: number
- Optional defaultValue: number
Returns ModalFormData

Remarks
Adds a numeric slider to the form.
- Defined in index.d.ts:220

textField

textField(label, placeholderText, defaultValue?): ModalFormData
Parameters
- label: string
- placeholderText: string
- Optional defaultValue: string
Returns ModalFormData

Remarks
Adds a textbox to the form.
- Defined in index.d.ts:234

title

title(titleText): ModalFormData
Parameters
- titleText: string
Returns ModalFormData

Remarks
This builder method sets the title for the modal dialog.
- Defined in index.d.ts:240

toggle

toggle(label, defaultValue?): ModalFormData
Parameters
- label: string
- Optional defaultValue: boolean
Returns ModalFormData

Remarks
Adds a toggle checkbox button to the form.
- Defined in index.d.ts:247