Interface Soul

interface Soul {
    emote(emote: Emote, opts?: EmoteOptions): void;
    emoteFree(text: string, target?: Stuff, inReactionTo?: string): void;
    introduceSelf(): boolean;
    renderEmote(emote: Emote, opts?: EmoteOptions): EmoteBodies;
    renderFreeForm(text: string, target?: Stuff): EmoteBodies;
}

Index

Methods

emote emoteFree introduceSelf renderEmote renderFreeForm

Methods

emote

emote(emote: Emote, opts?: EmoteOptions): void
In-room catalog emote: render + compose Scene + send.
Parameters
- emote: Emote
- Optionalopts: EmoteOptions
Returns void
- Defined in packages/server/src/mud/lib/social/Soul.ts:65

emoteFree

emoteFree(text: string, target?: Stuff, inReactionTo?: string): void
In-room free-form emote: render + compose Scene + send.
Parameters
- text: string
- Optionaltarget: Stuff
- OptionalinReactionTo: string
Returns void
- Defined in packages/server/src/mud/lib/social/Soul.ts:67

introduceSelf

introduceSelf(): boolean
Introduce yourself to everyone in range — a modality-neutral social act (the shared core behind the introduce verb, the NPC introduces brain, and the player auto-introduce hook). Emits the introduction scene and writes each in-range perceiver's recognition of you (learnIdentity). Returns false (no-op) if you have no proper name to give.

Returns boolean
- Defined in packages/server/src/mud/lib/social/Soul.ts:76

renderEmote

renderEmote(emote: Emote, opts?: EmoteOptions): EmoteBodies
Per-audience prose for a catalog emote.
Parameters
- emote: Emote
- Optionalopts: EmoteOptions
Returns EmoteBodies
- Defined in packages/server/src/mud/lib/social/Soul.ts:61

renderFreeForm

renderFreeForm(text: string, target?: Stuff): EmoteBodies
Per-audience prose for a free-form emote body.
Parameters
- text: string
- Optionaltarget: Stuff
Returns EmoteBodies
- Defined in packages/server/src/mud/lib/social/Soul.ts:63