Saxonberg Server API
    Preparing search index...

    Compose multi-audience messages with one .send() call. Built via MessageApi.scene(actor); private constructor — no other entry.

    Index

    Methods

    • Stamp additional meta fields on every composed frame. Used for cross-cutting non-modality meta like acousticDb (sound source amplitude, drives propagation reach) and channelId (channel attribution for chat / multi-party DM frames). Merges with whatever the framework otherwise stamps (timestamp, commandId, causingCommandId, modality). Successive calls accumulate.

      Parameters

      • partial: Partial<MessageFrame["meta"]>

      Returns this

    • Stamp the perception-modality attribution on every composed frame's meta.modality. Used by sensory producers (VocalMixin.say'hearing', AetherMixin.tell'verbal-esp') so reception-side gating at SensorMixin.filterMessage can drop frames whose modality isn't in the recipient's sensorium. System / log / narrative frames omit this call and deliver unconditionally.

      Parameters

      • name: string

      Returns this

    • Frame for everyone inside the actor's contents (excluding the actor itself). Requires the actor to be a Container — used when the actor IS the place (haunted location, ambient narrator).

      Parameters

      • body: Body
      • Optionalpayload: unknown

      Returns this

    • Frame for everyone in the actor's environment except the actor and any explicit target. Requires the actor to be Containable.

      Parameters

      • body: Body
      • Optionalpayload: unknown

      Returns this

    • Frame for the actor. Requires the actor to be a Sensor (else throws — composition error, not user-input error).

      Parameters

      • body: Body
      • Optionalpayload: unknown

      Returns this