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

    Variable BMS_AI_HELPERSConst

    BMS_AI_HELPERS: {
        _resolve(nameOrId: string): any;
        actor(actorOrId: any): object;
        actors(): object[];
        combat(): string | object;
        effects(actorOrId: any): object[];
        items(actorOrId: any): object;
    } = ...

    BMS AI Helpers — game.bms.ai

    A thin query layer designed for use from Simulacrum's run_javascript tool. Provides simplified, serializable summaries of common game state without requiring knowledge of deep schema paths.

    Usage (in run_javascript): game.bms.ai.actor("Name or ID") → vitals, resources, attributes game.bms.ai.combat() → tracker state (non-empty downs) game.bms.ai.actors() → all actors, brief game.bms.ai.items(actor) → actor's items by type

    Type Declaration

    • _resolve: function
      • Find an actor by name or ID.

        Parameters

        • nameOrId: string

        Returns any

    • actor: function
      • Summarise an actor's vitals, resources, and attributes.

        Parameters

        • actorOrId: any

        Returns object

    • actors: function
      • Brief list of all world actors.

        Returns object[]

    • combat: function
      • Summarise the active combat tracker. Returns only downs that have at least one action or effect.

        Returns string | object

    • effects: function
      • List all active effects on an actor.

        Parameters

        • actorOrId: any

        Returns object[]

    • items: function
      • Summarise an actor's items grouped by type.

        Parameters

        • actorOrId: any

        Returns object