Class MessageApi

constructor

• new MessageApi(): MessageApi

  Returns MessageApi

Static ReadonlyTags

StaticgetSensors

• getSensors(container: Stuff & Container): SensorStuff[]

  Get all sensors (objects with SensorMixin) inside a container.

  Parameters

  • container: Stuff & Container

  Returns SensorStuff[]

StaticisCommunicative

• isCommunicative(topic: string): boolean

  Whether topic is a communication act (say/whisper/shout/emote/ chat — the topic's data-driven communicative flag; NOT dm / narration / system). Consulted by the renown reception gate on the receive path so non-comm frames never hit the bus. false before the TopicCatalogue is warmed.

  Parameters

  • topic: string

  Returns boolean

StaticmessageContainer

• messageContainer(
      source: Stuff & Containable,
      frame: MessageFrame,
      opts?: MessageBroadcastOptions,
  ): void

  Send a message to all sensors in source's environment.

  Convenience wrapper for the "speaker is Containable, broadcast to peers in the same location" case. Drops the message with a warning if source has no environment.

  Parameters

  • source: Stuff & Containable
  • frame: MessageFrame
  • opts: MessageBroadcastOptions = {}

  Returns void

StaticmessageContents

• messageContents(
      container: Stuff & Container,
      frame: MessageFrame,
      opts?: MessageBroadcastOptions,
  ): void

  Send a message to every sensor inside a container.

  Low-level primitive — caller has already chosen the container. Useful when the speaker IS the container (haunted room speaking to occupants).

  Parameters

  • container: Stuff & Container
  • frame: MessageFrame
  • opts: MessageBroadcastOptions = {}

  Returns void

StaticrefOf

• refOf(stuff: Stuff): StuffRef

  Wrap a Stuff in a wire-safe reference. Display name is resolved server-side at compose time so the wire payload doesn't depend on a re-resolution step on the client.

  Parameters

  • stuff: Stuff

  Returns StuffRef

Staticscene

• scene(actor: Stuff): Scene

  Begin composing a Scene. Actor identity is required; per-method compositional requirements (Sensor for toSelf/toTarget; Containable for toPeers; Container for toContents) are enforced by the Scene builder.

  Parameters

  • actor: Stuff

  Returns Scene

StaticsendEnvelope

• sendEnvelope(recipient: SensorStuff, template: EnvelopeTemplate): void

  Envelope delivery chokepoint, parallel to sendMessage. The envelope template carries no frameId — stamping happens per-Interactive at the wire-delivery layer in Application.sendEnvelopeToInteractive. Avatar's handleEnvelope is what fans the template out to connected Interactives; NPCs' default no-op handleEnvelope means an NPC envelope is server-side observable (shadows, audit) but never reaches a wire.

  Parameters

  • recipient: SensorStuff
  • template: EnvelopeTemplate

  Returns void

StaticsendMessage

• sendMessage(recipient: SensorStuff, frame: MessageFrame): void

  Lone delivery chokepoint — every routing helper here, every Scene.send dispatch, and every MudlogApi emit goes through this function. Non-MessageApi code MUST NOT call sensor.onMessage directly: the chokepoint is where future cross-cutting concerns (audit trail, debug logging, bus-level taps per §10.5, wire- level filters, etc.) hook in exactly once.

  Parameters

  • recipient: SensorStuff
  • frame: MessageFrame

  Returns void