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

    Class default

    Persistent action-log panel anchored above the player list. Captures damage, negates, restores, card draws, checks, and custom chat messages so the main chat log stays clean for player communication.

    Singleton: access via game.bms.actionLog.

    Hierarchy

    • any
      • default
    Index
    constructor
    _activeFilters _entries _escapeHandler _groupingEnabled _initialScrollDone _outsideHandler _positionListenerAttached _positionRestored _saveDebounce _tooltipEl _tooltipEntryId _tooltipHideTimer _tooltipPinned _groupingEnabled DEFAULT_OPTIONS PARTS
    _posKey
    _cancelHide _dismissTooltip _ensureTooltipEl _hideTooltip _onClose _onRender _pinTooltip _positionTooltip _prepareContext _scheduleHide _scheduleSave _showTooltip addEntry clearEntries loadEntries _onClearLog _onScrollToBottom _onScrollToTop _onToggleFilter _onToggleGrouping

    • Returns default

    _activeFilters

    _activeFilters: Set<string> = ...

    _entries

    _entries: object[] = []

    _escapeHandler

    _escapeHandler: ((ev: any) => void) | null | undefined

    _groupingEnabled

    _groupingEnabled: boolean = false

    _initialScrollDone

    _initialScrollDone: boolean = false

    _outsideHandler

    _outsideHandler: ((ev: any) => void) | null | undefined

    _positionListenerAttached

    _positionListenerAttached: boolean = false

    _positionRestored

    _positionRestored: boolean = false

    _saveDebounce

    _saveDebounce: number | null = null

    _tooltipEl

    _tooltipEl: HTMLElement | null = null

    _tooltipEntryId

    _tooltipEntryId: string | null = null

    _tooltipHideTimer

    _tooltipHideTimer: number | null = null

    _tooltipPinned

    _tooltipPinned: boolean = false

    Static_groupingEnabled

    _groupingEnabled: any
    DEFAULT_OPTIONS: {
        actions: {
            clearLog: (event: any, target: any) => Promise<void>;
            scrollToBottom: () => void;
            scrollToTop: () => void;
            toggleFilter: (event: any, target: any) => Promise<void>;
            toggleGrouping: (event: any, target: any) => Promise<void>;
        };
        classes: string[];
        id: string;
        position: { height: number; width: number };
        window: {
            frame: boolean;
            positioned: boolean;
            resizable: boolean;
            title: string;
        };
    } = ...
    PARTS: { log: { scrollable: string[]; template: string } } = ...

    _posKey

    • get _posKey(): string

      Returns string

    _cancelHide

    • _cancelHide(): void

      Returns void

    _dismissTooltip

    • _dismissTooltip(): void

      Fully dismiss a pinned tooltip, cleaning up all state.

      Returns void

    _ensureTooltipEl

    • _ensureTooltipEl(): HTMLElement

      Lazily create or return the shared tooltip element.

      Returns HTMLElement

    _hideTooltip

    • _hideTooltip(): void

      Hide the tooltip (unpinned hover-out).

      Returns void

    _onClose

    • _onClose(options: any): void

      Parameters

      • options: any

      Returns void

    _onRender

    • _onRender(context: any, options: any): void

      Parameters

      • context: any
      • options: any

      Returns void

    _pinTooltip

    • _pinTooltip(entryEl: any): void

      Pin the tooltip for a given entry (click-locked).

      Parameters

      • entryEl: any

      Returns void

    _positionTooltip

    • _positionTooltip(entryEl: any, el: any): void

      Position the tooltip above (or below) the entry, clamped to viewport.

      Parameters

      • entryEl: any
      • el: any

      Returns void

    _prepareContext

    • _prepareContext(options: any): Promise<any>

      Parameters

      • options: any

      Returns Promise<any>

    _scheduleHide

    • _scheduleHide(): void

      Schedule a delayed hide (allows mouse to travel from entry to tooltip).

      Returns void

    _scheduleSave

    • _scheduleSave(): void

      Debounced world-setting save (1.5 s). Only the lead GM writes.

      Returns void

    _showTooltip

    • _showTooltip(entryEl: any): void

      Show the tooltip for a given entry element (hover, not pinned).

      Parameters

      • entryEl: any

      Returns void

    • Add an entry to the log.

      Parameters

      • entry: object

        Partial entry — missing fields filled from current game state.

      • Optionalopts: { remote?: boolean; skipSave?: boolean } = {}
        • Optionalremote?: boolean

          True when received via socket (skip re-emit).

        • OptionalskipSave?: boolean

          True when bulk-loading persisted entries on startup.

      Returns void

    • Clear all entries and persist the empty state.

      Returns void

    • Bulk-load persisted entries on startup without triggering socket/save/render per entry. A single render happens at the end.

      Parameters

      • entries: object[]

      Returns void

    Static_onClearLog

    • _onClearLog(event: any, target: any): Promise<void>

      Parameters

      • event: any
      • target: any

      Returns Promise<void>

    Static_onScrollToBottom

    • _onScrollToBottom(): void

      Returns void

    Static_onScrollToTop

    • _onScrollToTop(): void

      Returns void

    Static_onToggleFilter

    • _onToggleFilter(event: any, target: any): Promise<void>

      Parameters

      • event: any
      • target: any

      Returns Promise<void>

    Static_onToggleGrouping

    • _onToggleGrouping(event: any, target: any): Promise<void>

      Parameters

      • event: any
      • target: any

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods