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

    Custom region behavior that applies ActiveEffects from a source actor to tokens entering the region, with an optional disposition filter.

    Effects are copied from the source actor (identified by UUID) onto entering tokens. On exit, all copies marked with the region's origin key are deleted.

    Only the lead GM executes these handlers; the GM client is authoritative.

    Hierarchy

    • any
      • default
    Index
    • Returns default

    events: { [key: number]: (event: any) => Promise<void> } = ...
    LOCALIZATION_PREFIXES: string[] = ...
    • get _originKey(): string

      The origin key stamped on every cloned effect so we can find and delete them on exit.

      Returns string

    • Returns true if the token's disposition matches the filter.

      Parameters

      • tokenDoc: TokenDocument
      • sourceActor: any

        For relative disposition (not used here; kept for future extension)

      Returns boolean

    • Returns { disposition: any; effectUuids: any; includeOwner: any; sourceActorUuid: any }

    • Parameters

      • source: any

      Returns any

    • Parameters

      • event: any

      Returns Promise<void>

    • Parameters

      • event: any

      Returns Promise<void>

    • Apply this behavior's effects to all tokens currently inside the region. TOKEN_ENTER does not fire for tokens that are already inside when the region is first created, so callers must invoke this after creation.

      Parameters

      • behaviorDoc: RegionBehavior

        The behavior document (not the system type)

      Returns Promise<void>