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

    Class default

    TypeDataModel for the bmsEffect JournalEntryPage type.

    Stores a complete ActiveEffect definition as structured system data on a journal page. The page name doubles as the effect name; the icon is stored in system.img. This model mirrors the core AE schema plus all BMS system fields (triggers, modifications, aura config).

    Pages of this type serve as master copies — applied AEs track their origin back to the page UUID and auto-sync when the master changes.

    Hierarchy (View Summary)

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

    • Returns default

    _sortedTriggers

    _sortedTriggers: any[] | undefined
    auraLightConfig: any
    • get triggerConsumerType(): string

      Returns string

    • Returns any

    • Returns any

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

    • Mirror the BodyMindSoulActiveEffect coercion: ensure auraLightConfig is always a LightData instance with toObject() so downstream callers don't need null guards.

      Returns void

    • Build a plain ActiveEffect data object from this page's system data. The returned object is suitable for createEmbeddedDocuments("ActiveEffect", [data]).

      Parameters

      • name: string

        The effect name (typically the page's name)

      • Optionaloverrides: object = {}

        Per-instance field overrides merged last

      Returns object

      Plain AE construction data

    • Returns {
          auraColor: any;
          auraDisposition: any;
          auraIncludeOwner: any;
          auraLightConfig: any;
          auraLightEnabled: any;
          auraRange: any;
          auraShape: any;
          auraTargetEffectUuid: any;
          auraType: any;
          auraVisibility: any;
          changes: any;
          defaultDuration: any;
          defaultDurationUnit: any;
          description: any;
          drawAppend: any;
          img: any;
          isAura: any;
          isPassive: any;
          modifications: MergeableArrayField;
          showIcon: any;
          statuses: any;
          tint: any;
          transfer: any;
          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