Heroic Lands

Interface MysteryData<TLogic>

Remarks

The shape of system on a mystery item — i.e. item.system (equivalently item.logic.data) when item.type === "mystery". The backing DataModel implements this interface.

interface MysteryData<
    TLogic extends MysteryLogic<MysteryData> = MysteryLogic<any>,
> {
    actionDefs: sohl.entity.action.SohlAction.Data[];
    actorLogic: null | SohlActorLogic<any>;
    assocAffiliationCode?: null | string;
    assocSkillCode?: null | string;
    charges: { max: null | number; value: null | number };
    docHtml: HTMLString;
    id: string;
    isOwner: boolean;
    kind: string;
    lastRun?: Record<string, number>;
    levelBase: null | number;
    logic: TLogic;
    name: string;
    notes: HTMLString;
    parent: null | SohlItem;
    scheduledActions?: ScheduledAction[];
    shortcode: string;
    subType: MysterySubType;
    type: string;
    uuid: string;
    get item(): SohlItem;
    getFlag(scope: string, key: string): unknown;
    label(options?: { withName: boolean; withSubType: boolean }): string;
    setFlag(scope: string, key: string, value: unknown): Promise<unknown>;
    update(data: object): Promise<unknown>;
}

Type Parameters

Hierarchy (View Summary)

Properties

actionDefs actorLogic assocAffiliationCode? assocSkillCode? charges docHtml id isOwner kind lastRun? levelBase logic name notes parent scheduledActions? shortcode subType type uuid

Accessors

item

Methods

getFlag label setFlag update

Properties

actionDefs

actionDefs: sohl.entity.action.SohlAction.Data[]

Serialized action definitions used to build the logic's actions map.

actorLogic

actorLogic: null | SohlActorLogic<any>

The logic of the owning actor — this actor's own logic when the data is an actor's, the owning actor's logic when it is an item's, or null.

OptionalassocAffiliationCode

assocAffiliationCode?: null | string

Shortcode of the faction/Affiliation whose standing confers this mystery — a religion, an arcane or alchemical school, an ancestor/totem/spirit — null when the mystery is not affiliation-associated. Resolved to MysteryLogic.affiliation during MysteryLogic.evaluate.

OptionalassocSkillCode

assocSkillCode?: null | string

Shortcode of the skill this mystery is associated with (the skill a boon or boost affects, a fate success-level bump applies to, etc.); blank for mysteries that name no skill.

charges

charges: { max: null | number; value: null | number }

Usage tracking: current charges and maximum. Whether the mystery uses charges at all is carried by max alone — there is no separate flag.

Type declaration

  • max: null | number

    Maximum number of charges. 0 means no maximum; null means the mystery does not use charges.

  • value: null | number

    Current number of charges remaining. null means infinite.

docHtml

docHtml: HTMLString

Rich-text description shown on the item's sheet and chat cards.

id

id: string

The owning document's id.

isOwner

isOwner: boolean

Whether the current user owns the document (edit permission).

kind

kind: string

The document kind (its actor or item type id).

OptionallastRun

lastRun?: Record<string, number>

Generic run record (issue #579) — a map of actionName → the world time (seconds) that action last performed on this document, stamped at the action chokepoint for actions flagged recordsLastRun. The past-tense mirror of scheduledActions: "when did X last happen here?" for any action, without a bespoke field, and it survives after a schedule ends. For an event-driven trigger (no computable next fire) it is the only meaningful temporal fact.

levelBase

levelBase: null | number

The base level of the mystery, or null if not applicable. For a boon it is the flat ±N modifier magnitude; for a boost it is the boost count N applied to the associated skill.

logic

logic: TLogic

The logic instance built from this data.

name

name: string

The owning document's name.

notes

notes: HTMLString

Rich-text GM/player notes for the item.

parent

parent: null | SohlItem

The Foundry document (actor or item) this data belongs to, or null.

OptionalscheduledActions

scheduledActions?: ScheduledAction[]

Persisted recurring/deferred schedules for this document (issue #588) — each entry defers actionName to anchor + interval. The generic store that replaces the retired bespoke last*Date anchors; a recurring effect's finalize() re-arms these into the event queue on every preparation. Only documents whose data model extends the base SohlDataModel (actors, items, combatants) carry it — hence optional here. See https://kb.heroiclands.org/dev/reference/event-queue/.

shortcode

shortcode: string

Short identity code for this document.

subType

subType: MysterySubType

The mystery's subtype: boon / boost name a skill-affecting mystery, fate / grace / piety a passive pool, and other a catch-all.

type

type: string

The owning document's type (its actor or item kind).

uuid

uuid: string

The owning document's globally-unique id, treated as an opaque identity token: pass it through (e.g. into chat-card data) and resolve it back to logic via fvttLogicFromUuid / fvttLogicFromUuidSync — never fromUuid it to a Foundry document inside the logic layer.

Accessors

item

Methods

getFlag

label

  • label(options?: { withName: boolean; withSubType: boolean }): string

  • The item's display label; with withName, includes the item's name, and with withSubType, includes its sub-type.

    Parameters

    • Optionaloptions: { withName: boolean; withSubType: boolean }

    Returns string

setFlag

  • setFlag(scope: string, key: string, value: unknown): Promise<unknown>

  • Write a namespaced flag on the owning document.

    Parameters

    • scope: string
    • key: string
    • value: unknown

    Returns Promise<unknown>

update

Settings

Member Visibility

On This Page

Properties
Accessors
Methods