Body, Mind & Soul — API Reference
    Preparing search index...

    Class default

    Hierarchy (View Summary)

    • TriggerMixin<this>
    Index
    constructor
    _sortedTriggers
    availableCards drawnCards isExhausted triggerConsumerType
    _postDrawMessage applyScryResults drawCard getAvailableActionsForTriggers getAvailableEffectsForTriggers getTriggerOptions prepareDerivedData scry shuffle syncImagesFromFolder defineSchema migrateData triggerSchema

    • Returns default

    _sortedTriggers

    _sortedTriggers: any[] | undefined
    • get availableCards(): any

      Returns any

    • get drawnCards(): any

      Returns any

    • get isExhausted(): boolean

      Returns boolean

    • get triggerConsumerType(): string

      Returns string

    _postDrawMessage

    • _postDrawMessage(card: any, speaker?: null): Promise<void>

      Parameters

      • card: any
      • speaker: null = null

      Returns Promise<void>

    • Apply scry results: reorder cards and optionally discard them.

      Parameters

      • results: object[]

        Array of {id, sort, discard} objects

      Returns Promise<void>

    • Parameters

      • __namedParameters: {
            actor?: null;
            extraActors?: never[];
            silent?: boolean;
            speaker?: null;
            suppressTriggers?: boolean;
            targetActor?: null;
        } = {}

      Returns Promise<any>

    • Returns any

    • Returns any

    • Returns {
          conditionChoices: { [k: string]: any };
          conditionConfigFields: {};
          conditionConfigPartials: {};
          conditionsNeedValue: {};
          conditionValueHints: {};
          hookChoices: { [k: string]: any };
          localizedConditionsByHook: {};
          localizedSubConditionsByMetaType: {};
          metaConditions: {};
          outcomeChoices: { [k: string]: any };
          outcomeConfigPartials: {};
          scopeableConditions: {};
          targetScopeChoices: {};
      }

    • Returns void

    • Return the top N available cards sorted by sort order. Pure read, no mutations.

      Parameters

      • count: number

        Number of cards to scry

      Returns object[]

      Array of card data objects

    • Returns Promise<void>

    • Scan the configured imageSourceFolder and update card face images to match files found there. Matching is case-insensitive by both the raw filename (without extension) and its slug form. A file named "card-back.*" (any image extension) updates the deck's own back image.

      Returns Promise<{ cardBack: boolean; updated: number }>

    • Returns { imageSourceFolder: any; shuffleOnDraw: any; triggers: TypedObjectField }

    • Parameters

      • source: any

      Returns any

    • Build the shared triggers TypedObjectField schema.

      Returns TypedObjectField

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods