Heroic Lands

Interface ContextScope

Scope passed to actions that start or resume an opposed test.

interface ContextScope {
    askBreakTies?: boolean;
    breakTies?: boolean;
    noChat?: boolean;
    priorTestResult?: null | sohl.entity.result.OpposedTestResult;
    situationalModifier?: number;
    skipDialog?: boolean;
    sourceSuccessTestResult?: sohl.entity.result.SuccessTestResult;
    targetToken?: SohlTokenDocument;
    title?: string;
    type?: string;
}

Properties

askBreakTies? breakTies? noChat? priorTestResult? situationalModifier? skipDialog? sourceSuccessTestResult? targetToken? title? type?

Properties

OptionalaskBreakTies

askBreakTies?: boolean

Show the Break Ties checkbox on the initiator's pre-roll dialog.

OptionalbreakTies

breakTies?: boolean

Whether a tie in this contest should be broken (the dialog's answer).

OptionalnoChat

noChat?: boolean

Suppress chat output when set.

OptionalpriorTestResult

priorTestResult?: null | sohl.entity.result.OpposedTestResult

The opposed test being resumed, if any.

OptionalsituationalModifier

situationalModifier?: number

A situational modifier to apply to the source's test.

OptionalskipDialog

skipDialog?: boolean

Skip the pre-roll dialog when set.

OptionalsourceSuccessTestResult

sourceSuccessTestResult?: sohl.entity.result.SuccessTestResult

A pre-rolled source success test to reuse.

OptionaltargetToken

targetToken?: SohlTokenDocument

The contest's target token.

Optionaltitle

title?: string

Override the result title.

Optionaltype

type?: string

The test type to run.

Settings

Member Visibility

On This Page

Properties