Consumables

The consumable component allows you to create generic trackers for different states of your character. This can be for anything like Spell Slots, Luck Points, or Channel Divinity.

Resetting Uses

TIP

Consumables can be automatically reset when specific events are triggered. Use the reset_on property to specify which events should reset the consumable. You can reset completely (back to 0 used) or restore a specific amount of uses.

See the Event Systems page for more information on utilizing events.

Basic Example

```consumable
items:
  - label: "Level 1"
    state_key: din_luck_spell_1
    uses: 4
    reset_on: long-rest  # Full reset on long rest
  - label: "Action Surge"
    state_key: action_surge
    uses: 1
    reset_on: ["short-rest", "long-rest"]  # Reset on either rest type
  - label: "Bardic Inspiration"
    state_key: bardic_inspiration
    uses: 3
    reset_on:
      - event: short-rest
        amount: 1  # Restore 1 use on short rest
      - event: long-rest  # Full reset on long rest (no amount = complete reset)
```

Configuration

Property	Type	Description
items	Array	Required - List of consumable items to track

Item Object

Property	Type	Description
label	String	Display name for the consumable (optional)
state_key	String	Required - Unique identifier for state storage
uses	Number	Required - Maximum number of uses
reset_on	String/Array/Object	Events that reset this consumable

Reset Configuration

The reset_on property supports multiple formats:

Simple String: Resets completely on the specified event

reset_on: long-rest

Array of Strings: Resets completely on any of the specified events

reset_on: ["short-rest", "long-rest"]

Array of Objects: Allows fine-grained control over reset amounts

reset_on:
  - event: short-rest
    amount: 1  # Restore 1 use
  - event: long-rest  # Complete reset (no amount specified)

When amount is specified, that many uses are restored (subtracted from current usage). When amount is omitted, the consumable resets completely to 0 used.

Common Use Cases

• Spell Slots: Track spell slots by level
• Class Features: Action Surge, Bardic Inspiration, etc.
• Magic Items: Limited use items
• Custom Resources: Any trackable resource your character has