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

    Class BodyMindSoulActiveEffect

    Hierarchy

    • any
      • BodyMindSoulActiveEffect
    Index
    • Find this effect's remaining resolution time in the BMS combat tracker. Searches all started combats rather than only game.combat (the active scene's combat) so that effects in non-viewed scenes resolve correctly.

      Returns number | null

      Remaining downs, or null if not in tracker.

    • Build forwarded data from an origin document.

      Parameters

      • originDoc: Document

        The resolved origin (page or AE)

      Returns { doc: object; system: object } | null

      Document-level and system-level data, or null.

    • Parameters

      • data: any
      • options: any
      • userId: any

      Returns Promise<void>

    • Parameters

      • options: any
      • userId: any

      Returns void

    • Parameters

      • changed: any
      • options: any
      • userId: any

      Returns Promise<void>

    • Resolve the origin document synchronously. Returns the source document (a JournalEntryPage for bmsEffect pages, or an ActiveEffect) or null.

      Returns Document | null

    • Show scrolling floating text on the actor's token when this effect is gained or lost.

      Parameters

      • gained: boolean

        true = gained (green), false = lost (red)

      Returns void

    • Returns void

    • Parameters

      • source: boolean = true

      Returns any

    • Parameters

      • id: any

      Returns TriggerProxy | null

    • Override updateDuration to inject BMS tracker-based remaining downs. Always installs live-reading getters for remaining/label on this.duration so they reflect tracker changes without requiring a full re-prepare. Falls back to native Foundry values when the effect is not in the tracker.

      Returns any