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

    Class BodyMindSoulItem

    Extend the basic Item with some very simple modifications.

    Hierarchy

    • Item
      • BodyMindSoulItem

    Indexable

    • [key: string]: any
    Index
    • get actions(): any

      Returns synthesized SyntheticActionItem instances from system.actions raw data. For gear items, also includes actions from socketed gear upgrades.

      Returns any

    • Override createEmbeddedDocuments to default transfer:false for effects on action and rune items (trigger templates) and unequipped gear. Feature effects are left alone — they transfer freely as passive bonuses.

      Parameters

      • embeddedName: any
      • dataArray: any
      • options: any

      Returns Promise<any>

    • Equip this item, enabling its passive effects and marking it as equipped.

      Returns Promise<void>

    • Prepare a data object which defines the data schema used by dice roll commands against this Item

      Returns any

    • Augment the basic Item data model with additional dynamic data.

      Returns void

    • Convert the actor document 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.

    • Parameters

      • id: any

      Returns TriggerProxy | null

    • Flat array of TriggerProxy for every trigger on this item, regardless of nesting.

      Returns TriggerProxy[]

    • Unequip this item, disabling its passive effects and marking it as unequipped.

      Returns Promise<void>

    • Use this item, firing the bms.itemUsed hook for trigger processing.

      Returns Promise<void>