Tidy 5e Sheets API
    Preparing search index...

    Class ItemSummaryApi

    API functionality related to the Item Summary.

    The item summary makes multiple appearances in Tidy 5e Sheets. Particularly, it shows up when expanding an item table row or when flying out an item info card.

    Index

    Constructors

    Methods

    Constructors

    Methods

    • Registers item summary commands which Tidy 5e can render at select locations on the sheet.

      Parameters

      Returns void

      Hooks.once('tidy5e-sheet.ready', (api) => {
      api.config.itemSummary.registerCommands([
      {
      label: 'Character Button',
      enabled: (params) => params.item.actor?.type === 'character',
      iconClass: 'fas fa-dice-d20',
      execute: (params) => {
      console.log('Clicked Character button', params.item);
      },
      },
      {
      label: 'NPC Button',
      enabled: (params) => params.item.actor?.type === 'npc',
      execute: (params) => {
      console.log('Clicked NPC button', params.item);
      },
      },
      {
      label: 'Vehicle Button',
      enabled: (params) => params.item.actor?.type === 'vehicle',
      execute: (params) => {
      console.log('Clicked Vehicle button', params.item);
      },
      },
      ]);
      });
      Hooks.once('tidy5e-sheet.ready', (api) => {
      api.config.itemSummary.registerCommands([
      {
      label: 'Versatile Weapon Button',
      enabled: (params) =>
      params.item.type === 'weapon' &&
      params.item.system?.properties?.has('ver') &&
      params.item.system?.damage?.versatile,
      iconClass: 'fa-solid fa-hands-praying',
      execute: (params) => {
      console.log('Do something versatile', params.item);
      },
      },
      ]);
      });