Interface Perceptible

Public shape provided by PerceptibleMixin.

interface Perceptible {
    addKeyword(keyword: string): void;
    getKeywords(): string[];
    getPrimaryKeyword(): string | undefined;
    hasKeyword(keyword: string): boolean;
    removeKeyword(keyword: string): boolean;
    setKeywords(keywords: string[]): void;
    setPrimaryKeyword(value: string | undefined): void;
}

Methods

addKeyword(keyword: string): void
Parameters
- keyword: string
Returns void
- Defined in packages/server/src/mud/lib/description/Perceptible.ts:58

getPrimaryKeyword(): string | undefined
The authored / derived "first" keyword used by client renderers for canonical click-to-look affordances. Defaults to the first derived-pool entry; an author can pin a specific keyword via setPrimaryKeyword, but the setter fail-soft-validates against the live pool (an unrecognized value is ignored with a warning).

Returns string | undefined
- Defined in packages/server/src/mud/lib/description/Perceptible.ts:69

hasKeyword(keyword: string): boolean
Parameters
- keyword: string
Returns boolean
- Defined in packages/server/src/mud/lib/description/Perceptible.ts:60

removeKeyword(keyword: string): boolean
Parameters
- keyword: string
Returns boolean
- Defined in packages/server/src/mud/lib/description/Perceptible.ts:59

setKeywords(keywords: string[]): void
Parameters
- keywords: string[]
Returns void
- Defined in packages/server/src/mud/lib/description/Perceptible.ts:61

setPrimaryKeyword(value: string | undefined): void
Parameters
- value: string | undefined
Returns void
- Defined in packages/server/src/mud/lib/description/Perceptible.ts:70