Class ActorTraitsApi

Registers a custom actor trait to the actor traits section of the actor sheet.

Example: Registering an actor trait

Hooks.once('tidy5e-sheet.ready', (api) => {
  api.config.actorTraits.registerActorTrait({
    title: "Configure My Module",
    iconClass: "fa-solid fa-spaghetti-monster-flying",
    enabled: (params) =>
      ["character", "npc"].includes(params.context.actor.type),
    openConfiguration: (params) => {
      // TODO: For example, open another form to input some data.
    },
    openConfigurationTooltip: "Click to configure my module",
  });
});
Copy

Remarks

The actor traits section is a good place to put a configuration button for opening another dialog for a custom module.

Registers multiple custom traits to the actor traits section of the actor sheet.

Example: Registering vehicle traits

Hooks.once("tidy5e-sheet.ready", (api) => {
  api.config.actorTraits.registerActorTraits([
    {
      title: "Vehicle Customization Options",
      iconClass: "fa-solid fa-ferry",
      enabled: (params) => params.context.actor.type === "vehicle",
      openConfiguration: (params) => {
        // TODO: Open totally awesome config dialog for setting custom vehicle stuff.
      },
      openConfigurationTooltip: "Click to customize!",
    },
    {
      title: "Vehicle Tribble Manager",
      iconClass: "fa-solid fa-ghost",
      enabled: (params) => params.context.actor.type === "vehicle",
      openConfiguration: (params) => {
        // TODO: Open a hopeless manager dialog for dealing with a tribble infestation.
      },
      openConfigurationTooltip: "Click to manage the unmanageable tribble problem 😰",
      alwaysShow: true,
    },
  ]);
});
Copy