Body, Mind & Soul — API Reference
    Preparing search index...

    Class default

    Data model for Keyword items. A keyword item defines trigger-driven behavior for a named keyword. The keyword key is derived automatically from the item name as a kebab-slug (e.g. "Thousand Runes" → "thousand-runes").

    Hierarchy (View Summary)

    Index
    _sortedTriggers: any[] | undefined
    • get key(): any

      Kebab-slug derived from the parent item's name.

      Returns any

    • get transferredEffects(): ActiveEffect[]

      The full list of ActiveEffect documents this item contributes to the owning actor, including effects from sockets, keywords, and the item's own effects array. Subclasses override. Returns [] by default.

      Returns ActiveEffect[]

    • get transfersEffects(): boolean

      Whether this item currently transfers its effects to the owning actor. Subclasses override to implement item-type-specific logic.

      Returns boolean

    • Returns void

    • Convert the schema to a plain object.

      The built in toObject() method will ignore derived data when using Data Models. This additional method will instead use the spread operator to return a simplified version of the data.

      Returns object

      Plain object either via deepClone or the spread operator.

    • Returns { description: any; formula: any; isSocketable: any }

    • Parameters

      • source: any

      Returns any

    • Convert a display name to a kebab-slug key.

      Parameters

      • name: any

      Returns any