Heroic Lands

Interface Data

Construction data for a CombatResult.

interface Data {
    __kind?: string;
    attackResult?: sohl.entity.result.AttackResult;
    breakTies: boolean;
    defendResult?:
        | sohl.entity.result.AttackResult
        | sohl.entity.result.DefendResult;
    description: string;
    name: string;
    rollMode: string;
    sourceTestResult: sohl.entity.result.SuccessTestResult;
    speaker: sohl.core.logic.SohlSpeaker;
    targetTestResult: sohl.entity.result.SuccessTestResult;
    targetToken: null
    | SohlTokenDocument;
    tieBreak: number;
    tieBreakReason: TieBreakReason;
    title: string;
}

Hierarchy (View Summary)

Properties

__kind? attackResult? breakTies defendResult? description name rollMode sourceTestResult speaker targetTestResult targetToken tieBreak tieBreakReason title

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.

OptionalattackResult

attackResult?: sohl.entity.result.AttackResult

The attacker's evaluated AttackResult. Optional alias for sourceTestResult — supply one or the other (or both).

breakTies

breakTies: boolean

Whether a tie should be broken rather than reported as a tie.

OptionaldefendResult

defendResult?: sohl.entity.result.AttackResult | sohl.entity.result.DefendResult

The defender's evaluated DefendResult or AttackResult (for counterstrikes). Optional alias for targetTestResult.

description

description: string

Human-readable description shown on the chat card.

name

name: string

Internal identifier for the result.

rollMode

rollMode: string

Foundry roll mode for chat output.

sourceTestResult

sourceTestResult: sohl.entity.result.SuccessTestResult

The initiating actor's success test.

speaker

speaker: sohl.core.logic.SohlSpeaker

Speaker identity for the result's chat card.

targetTestResult

targetTestResult: sohl.entity.result.SuccessTestResult

The responding actor's success test (or built from targetToken).

targetToken

targetToken: null | SohlTokenDocument

The target's token, used to build a target test when one isn't supplied.

tieBreak

tieBreak: number

The side a tie is awarded to (an OPPOSED_TEST_RESULT_TIEBREAK value).

tieBreakReason

tieBreakReason: TieBreakReason

Which rule settled a broken tie.

title

title: string

Title shown on the chat card.

Settings

Member Visibility

On This Page

Properties