Add-On Documentation
  • Preparing search index...
  • The search index is not available
8Crafter's Server Utilities API
  • 8Crafter's Server Utilities API
  • Globals
  • modules
  • uis
  • forceShow

Function forceShow

  • forceShow<T extends ModalFormData | ActionFormData | MessageFormData>(
        form: T,
        player: Player,
        timeout?: number,
    ): Promise<
        T extends ModalFormData
            ? ModalFormResponse
            : T extends ActionFormData ? ActionFormResponse : MessageFormResponse,
    >

    Forces a form to show even if the player has another form or menu open.

    If the player has another form or menu open then it will wait until they close it.

    Type Parameters

    • T extends ModalFormData | ActionFormData | MessageFormData

    Parameters

    • form: T

      The form to show

    • player: Player

      The player to show the form to

    • Optionaltimeout: number

      The number of ticks before the function will give up and return the failed response, it defaults to 9999

    Returns Promise<
        T extends ModalFormData
            ? ModalFormResponse
            : T extends ActionFormData ? ActionFormResponse : MessageFormResponse,
    >

    The response of the form

    • Defined in modules/ui/functions/forceShow.ts:14

Settings

Member Visibility
Add-On Documentation
8Crafter's Server Utilities API
  • Loading...

Generated using TypeDoc