Heroic Lands

Interface Data<S>

Constructor input for SohlActionContext. Every field is optional except that a speaker must be supplied (validated at construction).

interface Data<S extends UnknownObject = UnknownObject> {
    noChat: boolean;
    scope: S;
    skipDialog: boolean;
    speaker:
        | sohl.core.logic.SohlSpeaker
        | Partial<sohl.core.logic.SohlSpeaker.Data>;
    target: SohlActorLogic<any>;
    thisLogic?: SohlLogic<any>;
    title: string;
    type: string;
}

Type Parameters

  • S extends UnknownObject = UnknownObject

    Shape of the scope payload.

Properties

noChat scope skipDialog speaker target thisLogic? title type

Properties

noChat

noChat: boolean

Suppress chat-card output.

scope

scope: S

Arbitrary per-action payload.

skipDialog

skipDialog: boolean

Skip the action's configuration dialog.

speaker

speaker: sohl.core.logic.SohlSpeaker | Partial<sohl.core.logic.SohlSpeaker.Data>

The speaker, as a sohl.core.logic.SohlSpeaker or its data.

target

target: SohlActorLogic<any>

The target token/actor; normalized to a token document.

OptionalthisLogic

thisLogic?: SohlLogic<any>

The Logic of the document the action runs on (stamped at dispatch).

title

title: string

Human-readable title.

type

type: string

Action type discriminator.

Settings

Member Visibility

On This Page

Properties