• A hook event fired by the system when an item's chat card is to be displayed.

    Parameters

    • item: ItemPF

      The item whose chat card is being displayed.

    • data: {
          chatData: Record<string, unknown>;
          template: string;
          templateData: Record<string, unknown>;
      }

      Data related to the item's use.

      • chatData: Record<string, unknown>

        The data passed to ChatMessage.create (excluding content from the rendered template)

      • template: string

        The path of the template used to render the chat card

      • templateData: Record<string, unknown>

        The data to be passed to the foundry.utils.renderTemplate call. The contents of this object can change unexpectedly, as each change to the system's chat card template or item data will affect it.

    Returns boolean

    Explicitly return false to prevent the item's chat card from being displayed.

    Remarks

    Called by Hooks.call

    See

    ItemPF#displayCard

Generated using TypeDoc