Class Form<T>

constructor

• new Form<T>(title: string): Form<T>

  Create a new server-side form.

  Type Parameters

  • T

  Parameters

  • title: string

    The title of the form.

  Returns Form<T>

title

Readonlytype

StaticformId

close

• close(player: Player): void

  Closes the form for a player.

  Parameters

  • player: Player

    The player to close the form for.

  Returns void

show

• show(player: Player, result: FormResult<T>): this

  Shows the form to a player.

  Parameters

  • player: Player

    The player to show the form to.
  • result: FormResult<T>

  Returns this

  The form response; the value of the form.

showAsync

• showAsync(player: Player): Promise<null | T>

  Shows the form to a player and returns a promise that resolves with the form response.

  Parameters

  • player: Player

    The player to show the form to.

  Returns Promise<null | T>

  A promise that resolves with the form response or null if the form was closed without a response.

update

• update(player: Player): void

  Parameters

  • player: Player

  Returns void