Heroic Lands

Interface Data

Construction data for an ImpactModifier.

interface Data {
    __kind?: string;
    aimBodyPartCode: string;
    aspect: ImpactAspect;
    baseValue: null | number;
    customFunction: null | Function;
    deltas: sohl.entity.modifier.ValueDelta[];
    disabledReason: string;
    roll: sohl.entity.roll.SimpleRoll;
    spread: number;
    variant: ImpactVariant;
}

Hierarchy (View Summary)

Properties

__kind? aimBodyPartCode aspect baseValue customFunction deltas disabledReason roll spread variant

Properties

Optional__kind

__kind?: string

Discriminator kind, written on serialization (SohlEntity.toJSON) and read back on revival. Optional as constructor input — it is derived from the concrete class, not supplied by callers.

aimBodyPartCode

aimBodyPartCode: string

The body part shortcode this attack aims at (empty when unaimed).

aspect

aspect: ImpactAspect

The damage aspect (blunt/edged/piercing/fire); defaults to blunt.

baseValue

baseValue: null | number

The base value before deltas (null to leave unset).

customFunction

customFunction: null | Function

Handler for a CUSTOM delta (null if unused).

deltas

deltas: sohl.entity.modifier.ValueDelta[]

The deltas applied on top of the base.

disabledReason

disabledReason: string

Reason the value is disabled; "" (or falsy) means enabled.

roll

roll: sohl.entity.roll.SimpleRoll

Pre-rolled or seed dice for the impact.

spread

spread: number

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

variant

variant: ImpactVariant

The impact variant (e.g., normal, frost, piercing); defaults to normal.

Settings

Member Visibility

On This Page

Properties