Class TidyHooks

Something has been dropped on an item or container sheet. Return false to prevent default behavior.

The active effect context menu has established its options and is about to show.

Example

Hooks.on('dnd5e.getActiveEffectContextOptions', (effect, menuItems) => {
  return true;
});
Copy

The facility occupant context menu has established its options and is about to show.

The context menu for the advancements list has been constructed.

Example

Hooks.on('dnd5e.getItemAdvancementContext', (html, contextOptions) => {
  return true;
});
Copy

The item context menu has established its options and is about to show.

Example

Hooks.on('dnd5e.getItemContextOptions', (item, menuItems) => {
  return true;
});
Copy

The context menu is about to show for a given item on a sheet.

Example

Hooks.on('tidy5e-sheet.actorItemUseContextMenu', (item, options) => {
  // Your code here
});
Copy

An item is about to be used by an actor.

Example

Hooks.on('tidy5e-sheet.actorPreUseItem', (item, config, options) => {
  return true;
});
Copy

The facility add button has been clicked for the specified facility type. Normally, this prompts the Compendium Browser.

An empty slot on a facility was clicked. Normally, this opens the Compendium Browser, scoped to actors of any type.

The group member context menu has established its options and is about to show.

A user has hovered off an item, typically from an item table row.

Example

Hooks.on('tidy5e-sheet.itemHoverOff', (event, item) => {
  // Your code here
});
Copy

A user has hovered over an item, typically on an item table row.

Example

Hooks.on('tidy5e-sheet.itemHoverOn', (event, item) => {
  // Your code here
});
Copy

Sheet item/effect sections are about to be configured. Use this hook to inject additional items, sections, etc., or to adjust context data.

Example

Hooks.on('tidy5e-sheet.preConfigureSections', (app, element, data) => {
  // Your code here
});
Copy

An active effect is about to be created for an owning document. This was initiated specifically through Tidy 5e Sheets, whether directly by the user, or indirectly through some user interaction.

Example

Hooks.on('tidy5e-sheet.preCreateActiveEffect', (owner, createData, userId) => {
  return true;
});
Copy

An item is about to be created for an owning document. This was initiated specifically through Tidy 5e Sheets, whether directly by the user, or indirectly through some user interaction.

Example

Hooks.on('tidy5e-sheet.preCreateItem', (owner, createData, userId) => {
  return true;
});
Copy

The portrait picker is about to open.

Example

Hooks.on('tidy5e-sheet.preOpenActorPortraitFilePicker', (context, event) => {
  return true;
});
Copy

The floating context menu's positioning is being determined.

Example

Hooks.on('tidy5e-sheet.prepareFloatingContextMenuPosition', (positionInfo) => {
  return true;
});
Copy

Resources have been prepared. Use this hook to adjust them and/or add new resources.

Example

Hooks.on('tidy5e-sheet.prepareResources', (tidyResources, actor) => {
  // Your code here
});
Copy

A tab is about to be selected.

Example

Hooks.on('tidy5e-sheet.preSelectTab', (app, element, data) => {
  return true;
});
Copy

Tidy 5e Sheets is ready to be used and customized.

Example

Hooks.on('tidy5e-sheet.ready', (api) => {
  // Your code here
});
Copy

The actor sheet has rendered all content and registered custom content. Is called on partial and full renders.

Example

Hooks.on('tidy5e-sheet.renderActorSheet', (app, element, data, forced) => {
  // Your code here
});
Copy

The item sheet has rendered all content and registered custom content. Is called on partial and full renders.

Example

Hooks.on('tidy5e-sheet.renderItemSheet', (app, element, data, forced) => {
  // Your code here
});
Copy

Deprecated

This hook is now redundant for App V2 item and container sheets. It will be removed as of Tidy V8.

A tab has been selected on the sheet.

Example

Hooks.on('tidy5e-sheet.selectTab', (app, element, newTabId) => {
  // Your code here
});
Copy