Saxonberg Server API
    Preparing search index...

    Interface ChronicleEntryFields

    The fields a caller supplies to mint one chronicle entry — the ChronicleApi call shape. Everything is optional; the build seam (ChronicleLogic) resolves defaults: kind defaults to deed, template (rendered via ProseApi) takes precedence over text, a deed's when defaults to the game-time witness, and a claim's order is honored while its when is forced null.

    interface ChronicleEntryFields {
        key?: string | null;
        kind?: "claim" | "deed";
        order?: number | null;
        tags?: string[];
        template?: string;
        text?: string;
        vars?: Record<string, unknown>;
        when?: number | null;
        where?: string | null;
        who?: string[];
    }
    Index

    Properties

    key? kind? order? tags? template? text? vars? when? where? who?

    Properties

    key?: string | null
    kind?: "claim" | "deed"
    order?: number | null

    Claim prologue order.

    tags?: string[]
    template?: string

    Rendered to text via ProseApi when present (takes precedence).

    Optionaltext

    text?: string

    Authored line, used when no template is given.

    vars?: Record<string, unknown>

    Liquid vars for template.

    when?: number | null

    Deed game-time seconds; defaults to "now" for deeds when omitted.

    where?: string | null
    who?: string[]

    Settings

    Member Visibility

    On This Page

    Properties