Heroic Lands

Interface Data

Construction data for an AttackResult.

interface Data {
    __kind?: string;
    autoCriticalFail?: boolean;
    canFate: boolean;
    combatantUuid: string;
    description: string;
    impact: sohl.entity.modifier.ImpactModifier;
    isSuccessValue?: boolean;
    label: string;
    masteryLevelModifier: sohl.entity.modifier.MasteryLevelModifier;
    mishaps: string[];
    mode: PointerData;
    movement: SuccessTestResultMovement;
    name: string;
    roll: sohl.entity.roll.SimpleRoll;
    rollMode: SohlSpeakerRollMode;
    situationalModifier: number;
    speaker: sohl.core.logic.SohlSpeaker;
    successLevel: number;
    successStarTable: LimitedDescription[];
    targetValueFunc: (sl: number) => number;
    testType: string;
    title: string;
    tokenUuid: string;
}

Hierarchy (View Summary)

Properties

__kind? autoCriticalFail? canFate combatantUuid description impact isSuccessValue? label masteryLevelModifier mishaps mode movement name roll rollMode situationalModifier speaker successLevel successStarTable targetValueFunc testType title tokenUuid

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.

OptionalautoCriticalFail

autoCriticalFail?: boolean

Force an auto-Critical-Failure (#568) — the test requires a body part the actor cannot use. Defaults false.

canFate

canFate: boolean

Whether fate may be spent on this test.

combatantUuid

combatantUuid: string

The UUID of the combatant performing this attack

description

description: string

Human-readable description shown on the chat card.

impact

impact: sohl.entity.modifier.ImpactModifier

The impact (damage) formula/capability for this attack.

OptionalisSuccessValue

isSuccessValue?: boolean

Whether this is a Success Value test (#848) — graded into a Success Value and Success Stars via successStarTable. Defaults false.

label

label: string

The label for this attack result (shown on card).

masteryLevelModifier

masteryLevelModifier: sohl.entity.modifier.MasteryLevelModifier

The mastery-level modifier to test against.

mishaps

mishaps: string[]

Mishap codes to seed (e.g. fumble, stumble).

mode

mode: PointerData

The strike mode used for this attack.

movement

movement: SuccessTestResultMovement

Tactical movement state for the test.

name

name: string

Internal identifier for the result.

roll

roll: sohl.entity.roll.SimpleRoll

A pre-seeded d100 roll (omit to roll fresh in SuccessTestResult.evaluate).

rollMode

rollMode: SohlSpeakerRollMode

Foundry roll mode for chat output.

situationalModifier

situationalModifier: number

The player-entered situational modifier from the attack dialog.

speaker

speaker: sohl.core.logic.SohlSpeaker

Speaker identity for the result's chat card.

successLevel

successLevel: number

A previously-evaluated success level to restore (e.g. a cross-client snapshot).

successStarTable

successStarTable: LimitedDescription[]

The description table used to derive result text and stars. Rides the wire as data (#206); the display outcome (text, stars) is computed from it on read, never stored (#205).

targetValueFunc

targetValueFunc: (sl: number) => number

Maps a success level to the test's target value (identity for a plain success test).

testType

testType: string

Which kind of test this is (a TEST_TYPE id).

title

title: string

Title shown on the chat card.

tokenUuid

tokenUuid: string

The token the test is associated with.

Settings

Member Visibility

On This Page

Properties