Class DialogueForm

constructor

• new DialogueForm(
      target: Entity,
      title: string,
      content?: string,
      fromTrait?: boolean,
  ): DialogueForm

  Creates a new dialogue form.

  Parameters

  • target: Entity

    The target entity that the dialogue is focused on.
  • title: string

    The title of the dialogue form.
  • Optionalcontent: string

    The content of the dialogue form.
  • fromTrait: boolean = false

    Whether the dialogue form is from a trait.

  Returns DialogueForm

Readonlybuttons

content

fromTrait

Readonlytarget

Readonlytype

button

• button(text: string): this

  Adds a button to the dialogue form.

  Parameters

  • text: string

    The text of the button.

  Returns this

  The current instance of the dialogue form.

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

  Shows the dialogue synchronously to a player.

  Parameters

  • player: Player

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

    The result callback to call when the form is submitted.

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

  Shows the dialogue asynchronously to a player.

  Parameters

  • player: Player

    The player to show the form to.

  Returns Promise<number | Error>

  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.

StaticcloseForm

• closeForm(player: Player, id: bigint): void

  Parameters

  • player: Player
  • id: bigint

  Returns void