Class MessageForm

Hierarchy (View Summary)

Form<boolean>
- MessageForm

Index

Constructors

Properties

button1 button2 content formId title type formId

Methods

close show update

Constructors

constructor

new MessageForm(
    title: string,
    content?: string,
    button1?: string,
    button2?: string,
): MessageForm
Create a new server-sided message form.
Parameters
- title: string
  The title of the form.
- Optionalcontent: string
  The content of the form; defaults to an empty string.
- Optionalbutton1: string
  The text of the first button; defaults to "OK".
- Optionalbutton2: string
  The text of the second button; defaults to "Cancel".
Returns MessageForm
Overrides Form.constructor
- Defined in packages/core/src/ui/message.ts:30

Properties

button1

button1: string

The text of the first button.

button2

button2: string

The text of the second button.

content

content: string

The content of the form.

`Protected` `Readonly`formId

formId: number = ++Form.formId

The form id of the form.

title

title: string

The title of the form.

`Readonly`type

type: Message = ModalFormType.Message

The type of form.

`Static`formId

formId: number = 0

The next form id to use when creating a new form.

Methods

close

close(player: Player): void
Closes the form for a player.
Parameters
- player: Player
  The player to close the form for.
Returns void
Inherited from Form.close
- Defined in packages/core/src/ui/form.ts:84

show

show(player: Player, result: FormResult<boolean>): this
Shows the form to a player.
Parameters
- player: Player
  The player to show the form to.
- result: FormResult<boolean>
Returns this
The form response; the value of the form.
Inherited from Form.show
- Defined in packages/core/src/ui/form.ts:59

update

update(player: Player): void
Parameters
- player: Player
Returns void
Inherited from Form.update
- Defined in packages/core/src/ui/form.ts:92