Heroic Lands

Interface ArmorGearData<TLogic>

Remarks

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

interface ArmorGearData<
    TLogic extends ArmorGearLogic<ArmorGearData> = ArmorGearLogic<any>,
> {
    actionDefs: sohl.entity.action.SohlAction.Data[];
    actorLogic: null | SohlActorLogic<any>;
    containerId: null | string;
    docHtml: HTMLString;
    durabilityBase: number;
    encumbrance: number;
    id: string;
    isCarried: boolean;
    isOwner: boolean;
    isWorn: boolean;
    kind: string;
    lastRun?: Record<string, number>;
    locations: { flexible: string[]; rigid: string[] };
    logic: TLogic;
    material: null | string;
    name: string;
    notes: HTMLString;
    parent: null | SohlItem;
    protectionBase: {
        blunt: number;
        edged: number;
        fire: number;
        piercing: number;
    };
    qualityBase: number;
    quantity: number;
    scheduledActions?: ScheduledAction[];
    sharedWithCohortIds: string[];
    shortcode: string;
    type: string;
    uuid: string;
    valueBase: number;
    weightBase: number;
    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 containerId docHtml durabilityBase encumbrance id isCarried isOwner isWorn kind lastRun? locations logic material name notes parent protectionBase qualityBase quantity scheduledActions? sharedWithCohortIds shortcode type uuid valueBase weightBase

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.

containerId

containerId: null | string

The container this item is contained in, if any

docHtml

docHtml: HTMLString

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

durabilityBase

durabilityBase: number

Structural integrity rating

encumbrance

encumbrance: number

Encumbrance value of the armor

id

id: string

The owning document's id.

isCarried

isCarried: boolean

Whether this item is on the character's person

isOwner

isOwner: boolean

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

isWorn

isWorn: boolean

Whether this armor is currently worn

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.

locations

locations: { flexible: string[]; rigid: string[] }

Body locations covered, split by flexible and rigid coverage

Type declaration

  • flexible: string[]

    Body-location shortcodes with flexible coverage.

  • rigid: string[]

    Body-location shortcodes with rigid coverage.

logic

logic: TLogic

The logic instance built from this data.

material

material: null | string

Primary material the armor is made from

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.

protectionBase

protectionBase: { blunt: number; edged: number; fire: number; piercing: number }

Base damage reduction per impact aspect

Type declaration

  • blunt: number

    Base protection against blunt impact.

  • edged: number

    Base protection against edged impact.

  • fire: number

    Base protection against fire/heat impact.

  • piercing: number

    Base protection against piercing impact.

qualityBase

qualityBase: number

Craftsmanship quality, generally ranging from 8-12

quantity

quantity: number

Number of this item in the stack

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/.

sharedWithCohortIds

sharedWithCohortIds: string[]

References (shortcode, id, or UUID) of the Cohort actors this gear is shared with

shortcode

shortcode: string

Short identity code for this document.

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.

valueBase

valueBase: number

Base monetary value in silver pennies

weightBase

weightBase: number

Base weight of a single unit

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

  • update(data: object): Promise<unknown>

  • Persist a partial update to the owning document (self-mutation only).

    Parameters

    • data: object

    Returns Promise<unknown>

Settings

Member Visibility

On This Page

Properties
Accessors
Methods