Interface ContextScope

Scope passed to actions that resume a prior defense.

interface ContextScope {
    aimBodyPartCode: string;
    impactModifier: sohl.entity.modifier.ImpactModifier;
    label: string;
    mode: sohl.entity.strikemode.StrikeModeBase;
    priorTestResult: sohl.entity.result.ImpactResult;
    spread: number;
}

Index

Properties

aimBodyPartCode impactModifier label mode priorTestResult spread

Properties

aimBodyPartCode

aimBodyPartCode: string

The targeted body part shortcode, or "" when unaimed.

impactModifier

impactModifier: sohl.entity.modifier.ImpactModifier

The impact modifier for this impact.

label

label: string

A label for what caused the impact (weapon name, "fall", "spell", …).

mode

mode: sohl.entity.strikemode.StrikeModeBase

The base strike mode that produced the impact (for melee/missile).

priorTestResult

priorTestResult: sohl.entity.result.ImpactResult

The prior impact test result.

spread

spread: number

Strike spread for hit-location scatter (0 when unaimed).