Interface TargetedApplyDamageOptions

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

Properties

asNonlethal? asWounds? critMult? dualHeal? element? event? forceDialog? instances? message? reduction? reductionDefault? reference? targets

Properties

OptionalasNonlethal

asNonlethal?: boolean

Default Value

false

OptionalasWounds

asWounds?: boolean

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

Default Value

false

OptionalcritMult

critMult?: number

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

Set to 0 for non-critical hits.

Default Value

0

OptionaldualHeal

dualHeal?: boolean

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

Default Value

false

Optionalelement

element?: Element

Chat message reference if any.

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

Optionalevent

event?: Event

Triggering event, if any.

OptionalforceDialog

forceDialog?: boolean

Default Value

false

Optionalinstances

instances?: DamageInstance[]

Individual instances of damage.

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

Optionalmessage

message?: ChatMessage

Chat message reference if any.

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

Optionalreduction

reduction?: number

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

OptionalreductionDefault

reductionDefault?: number

Deprecated

  • Use reduction instead.

Optionalreference

reference?: string

General reference to what triggered this.

Value is expected to be an UUID.

targets

targets: (Actor | Token)[]

Targets to apply damage to.

Has only meaning on the static function.

Settings

Member Visibility

On This Page

Properties