Pathfinder 1e for Foundry VTT
    Preparing search index...

    Interface TargetedApplyDamageOptions

    interface TargetedApplyDamageOptions {
        asNonlethal?: boolean;
        asWounds?: boolean;
        critMult?: number;
        dualHeal?: boolean;
        element?: Element;
        event?: Event;
        forceDialog?: boolean;
        instances?: DamageInstance[];
        message?: ChatMessage<"base" | ModuleSubType>;
        reduction?: number;
        reductionDefault?: number;
        reference?: string;
        targets: (Token | Actor<"base" | ModuleSubType>)[];
    }
    Index

    Properties

    asNonlethal?: boolean
    false
    
    asWounds?: boolean

    Apply damage to wounds directly instead of vigor, as needed for Wounds & Vigor variant health rule.

    false
    
    critMult?: number

    Critical multiplier as needed for Wounds & Vigor variant health rule.

    Set to 0 for non-critical hits.

    0
    
    dualHeal?: boolean

    Is this dual dealing? If enabled, healing affects both normal health and nonlethal as magical healing should.

    false
    
    element?: Element

    Chat message reference if any.

    This is to help modules overriding this function, the system does not use it.

    event?: Event

    Triggering event, if any.

    forceDialog?: boolean
    false
    
    instances?: DamageInstance[]

    Individual instances of damage.

    This is not processed currently by the system, though does affect apply damage dialog presentation.

    message?: ChatMessage<"base" | ModuleSubType>

    Chat message reference if any.

    This is to help modules overriding this function, the system does not use it.

    reduction?: number

    Value to reduce the damage or healing by after ratio has been applied.

    reductionDefault?: number
    • Use reduction instead.
    reference?: string

    General reference to what triggered this.

    Value is expected to be an UUID.

    targets: (Token | Actor<"base" | ModuleSubType>)[]

    Targets to apply damage to.

    Has only meaning on the static function.