Heroic Lands

Function resolveEffectTargetLabel

  • resolveEffectTargetLabel(
        scope: undefined | string,
        ctx: {
            actorName?: string;
            isActorEffect: boolean;
            parentItemType?: string;
        },
    ): string

  • The human-readable, localized label for an active effect's target, derived from its system.scope and the documents it is embedded in. Mirrors the scope semantics of SohlActiveEffect.targets:

    • "this" → "This {itemType}" for an item-embedded effect, or "This Actor: {actorName}" for an actor-embedded effect;
    • "actor" → the localized "Actor" label;
    • "meleestrikemode" / "missilestrikemode" → the strike-mode scope label;
    • an item kind (e.g. "weapongear") → that item type's localized label (the effect targets every item of the kind, filtered by its predicate);
    • anything else → the raw scope string.

    Parameters

    • scope: undefined | string

      The effect's system.scope, or undefined.

    • ctx: { actorName?: string; isActorEffect: boolean; parentItemType?: string }

      The embedding context.

      • OptionalactorName?: string

        The owning actor's name, for the "this" label on an actor effect.

      • isActorEffect: boolean

        Whether the effect is embedded directly on an actor (rather than on an item).

      • OptionalparentItemType?: string

        The owning item's kind, for the "this" label on an item effect.

    Returns string

    The localized target label.

Settings

Member Visibility