Heroic Lands

Function buildRegionTriggerContext

  • buildRegionTriggerContext(
        params: RegionEventInput,
    ):
        | {
            actorUuid?: string;
            name: SohlRegionTriggerName;
            regionId: string;
            regionName: string;
            regionUuid: string;
            sceneUuid: string;
            tokenUuid: string;
        }
        | undefined

  • Build the sohl.entity.event.SohlTriggerContext for a Foundry region event, or undefined when the event is not curated (the caller then does nothing). Pure: the RegionBehavior bridge resolves the Foundry region/token objects to UUIDs and names at the boundary and hands them here, so the trigger-shaping logic stays Foundry-free and unit-testable.

    Absent identifiers normalize to ""; actorUuid stays undefined when the token has no actor (a predicate can then distinguish "no character").

    Parameters

    Returns
        | {
            actorUuid?: string;
            name: SohlRegionTriggerName;
            regionId: string;
            regionName: string;
            regionUuid: string;
            sceneUuid: string;
            tokenUuid: string;
        }
        | undefined

    The region trigger context, or undefined if the event is excluded.

    • {
          actorUuid?: string;
          name: SohlRegionTriggerName;
          regionId: string;
          regionName: string;
          regionUuid: string;
          sceneUuid: string;
          tokenUuid: string;
      }
      • OptionalactorUuid?: string

        UUID of that token's actor, when it has one.

      • name: SohlRegionTriggerName

        The SoHL region trigger name.

      • regionId: string

        The region's id (for predicate scoping to one region).

      • regionName: string

        The region's display name.

      • regionUuid: string

        UUID of the region the event fired on.

      • sceneUuid: string

        UUID of the scene the region belongs to.

      • tokenUuid: string

        UUID of the token that entered/exited/acted.

    • undefined

Settings

Member Visibility