Interface Comms

interface Comms {
    getLastInboundCohort(): readonly Stuff[] | null;
    getLastOutboundCohort(): readonly Stuff[] | null;
    recordInboundCohort(cohort: readonly Stuff[]): void;
    tell(
        target: Stuff | readonly Stuff[],
        text: string,
        opts?: { channelId?: string },
    ): void;
}

Index

Methods

getLastInboundCohort getLastOutboundCohort recordInboundCohort tell

Methods

getLastInboundCohort

getLastInboundCohort(): readonly Stuff[] | null
Most-recent cohort that addressed this update's operator. For a 1:1 inbound this is [sender]; for a multi-party DM it's [sender, ...siblings] so a reply-all has every party. Read by reply.

Returns readonly Stuff[] | null
- Defined in packages/server/src/mud/lib/comms/Comms.ts:67

getLastOutboundCohort

getLastOutboundCohort(): readonly Stuff[] | null
Most-recent cohort this update's operator addressed. Read by the dm . pronoun verb. null until the operator has sent.

Returns readonly Stuff[] | null
- Defined in packages/server/src/mud/lib/comms/Comms.ts:59

recordInboundCohort

recordInboundCohort(cohort: readonly Stuff[]): void
Stamp this update's inbound cohort. Called by the sending comms update on each recipient's comms update after tell composes the frames.
Parameters
- cohort: readonly Stuff[]
Returns void
- Defined in packages/server/src/mud/lib/comms/Comms.ts:74

tell

tell(
    target: Stuff | readonly Stuff[],
    text: string,
    opts?: { channelId?: string },
): void
Send a private message to one or more targets over the Aether, on behalf of this update's host (the operator). Single-target produces the classic tell rendering; multi-target stamps the full cohort + optional meta.channelId and adds a "(also to: …)" hint to per-recipient frames.
Parameters
- target: Stuff | readonly Stuff[]
- text: string
- Optionalopts: { channelId?: string }
Returns void
- Defined in packages/server/src/mud/lib/comms/Comms.ts:49