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

    Class default

    Data model for ActiveEffects with trigger support. Extends TypeDataModel to add custom system data to ActiveEffects.

    Hierarchy (View Summary)

    • TriggerMixin<this>
    Index
    constructor
    _sortedTriggers auraLightConfig
    isSuppressed triggerConsumerType
    getAvailableActionsForTriggers getAvailableEffectsForTriggers getTriggerOptions prepareDerivedData defineSchema migrateData triggerSchema

    • Returns default

    _sortedTriggers

    _sortedTriggers: any[] | undefined
    auraLightConfig: any
    • get isSuppressed(): boolean

      Suppress effects on toggleable features that are not enabled. Foundry reads this via ActiveEffect#isSuppressed → this.system.isSuppressed.

      Returns boolean

    • get triggerConsumerType(): string

      Returns string

    • Returns any

    • Get effects available for trigger outcomes (e.g., applyEffect). For ActiveEffects, returns sibling effects from the parent, excluding self.

      Returns { id: string; name: string }[]

    • Returns {
          conditionChoices: { [k: string]: any };
          conditionConfigFields: {};
          conditionConfigPartials: {};
          conditionsNeedValue: {};
          conditionValueHints: {};
          hookChoices: { [k: string]: any };
          localizedConditionsByHook: {};
          localizedSubConditionsByMetaType: {};
          metaConditions: {};
          outcomeChoices: { [k: string]: any };
          outcomeConfigPartials: {};
          scopeableConditions: {};
          targetScopeChoices: {};
      }

    • Ensure auraLightConfig is always a LightData instance with toObject(), even on pre-migration or never-edited docs where the field initialised as a plain object (or remained undefined). Lets every reader call system.auraLightConfig.toObject() without a null guard.

      Returns void

    • Returns {
          appendKeywords: MergeableArrayField;
          auraColor: any;
          auraDisposition: any;
          auraIncludeOwner: any;
          auraLightConfig: any;
          auraLightEnabled: any;
          auraRadiate: any;
          auraRange: any;
          auraShape: any;
          auraTargetEffectUuid: any;
          auraType: any;
          auraVisibility: any;
          changes: any;
          defaultDuration: any;
          defaultDurationUnit: any;
          drawAppend: any;
          isAura: any;
          isPassive: any;
          modifications: MergeableArrayField;
          triggers: TypedObjectField;
      }

    • Parameters

      • source: any

      Returns any

    • Build the shared triggers TypedObjectField schema.

      Returns TypedObjectField

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods