Interface Contacts

interface Contacts {
    addContact(entry: ContactEntry): boolean;
    allContacts(): readonly ContactEntry[];
    clearContactLabel(label: string): number;
    contactLabels(): string[];
    contactsByLabel(label: string): readonly ContactEntry[];
    removeContact(kind: "avatar" | "npc", ref: string, label: string): boolean;
    renameContactLabel(oldLabel: string, newLabel: string): number;
}

Index

Methods

addContact allContacts clearContactLabel contactLabels contactsByLabel removeContact renameContactLabel

Methods

addContact

addContact(entry: ContactEntry): boolean
Append a contact entry. Duplicates (same kind+ref+label) are no-ops.
Parameters
- entry: ContactEntry
Returns boolean
- Defined in packages/server/src/mud/lib/social/Contacts.ts:67

allContacts

allContacts(): readonly ContactEntry[]
All stored entries (read-only snapshot).

Returns readonly ContactEntry[]
- Defined in packages/server/src/mud/lib/social/Contacts.ts:86

clearContactLabel

clearContactLabel(label: string): number
Bulk-remove every entry of the given label. Returns count removed.
Parameters
- label: string
Returns number
- Defined in packages/server/src/mud/lib/social/Contacts.ts:79

contactLabels

contactLabels(): string[]
Distinct labels used by the owner. Sorted.

Returns string[]
- Defined in packages/server/src/mud/lib/social/Contacts.ts:77

contactsByLabel

contactsByLabel(label: string): readonly ContactEntry[]
Read entries filtered by label. Empty array when label has no entries.
Parameters
- label: string
Returns readonly ContactEntry[]
- Defined in packages/server/src/mud/lib/social/Contacts.ts:75

removeContact

removeContact(kind: "avatar" | "npc", ref: string, label: string): boolean
Remove a contact entry by ref+label. Returns true if anything was removed. For avatar entries, ref = playerId; for npc entries, ref = templatePath.
Parameters
- kind: "avatar" | "npc"
- ref: string
- label: string
Returns boolean
- Defined in packages/server/src/mud/lib/social/Contacts.ts:73

renameContactLabel

renameContactLabel(oldLabel: string, newLabel: string): number
Rename every entry of oldLabel to newLabel. Returns count relabeled. No-op if no entries have oldLabel.
Parameters
- oldLabel: string
- newLabel: string
Returns number
- Defined in packages/server/src/mud/lib/social/Contacts.ts:84