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>): void

  Show the form synchronously to a player.

  Parameters

  • player: Player

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

    The result callback to call when the form is submitted.

  Returns void
• show(player: Player): Promise<Error | T>

  Show the form asynchronously to a player.

  Parameters

  • player: Player

    The player to show the form to.

  Returns Promise<Error | T>

  A promise that resolves with the form response or an error.

  Note

  If the form is cancelled, it resolves with an error.

  Note

  If the form is submitted, it resolves with the form response.

update

• update(player: Player): void

  Parameters

  • player: Player

  Returns void