Interface Surfaced

Public shape provided by SurfacedMixin.

interface Surfaced {
    canRest(item: Stuff & Containable): boolean;
    getResting(): readonly (Stuff & Containable)[];
    getUserFacingDetail(): string | undefined;
    setUserFacingDetail(v: string | undefined): void;
}

Index

Methods

canRest getResting getUserFacingDetail setUserFacingDetail

Methods

canRest

canRest(item: Stuff & Containable): boolean
Per-host gate. Defaults to true; authors override to reject specific items (a fragile shelf rejects heavy items; a sloped surface rejects round items; a wax tabletop rejects hot items).
Parameters
- item: Stuff & Containable
Returns boolean
- Defined in packages/server/src/mud/lib/spatial/Surfaced.ts:62

getResting

getResting(): readonly (Stuff & Containable)[]
Items currently resting on this surface. Computed lazily by walking the surface's environment and filtering by Containable.getRestingOn() === this. Returned readonly; mutate via ContainmentApi.placeOn / ContainmentApi.move.

Returns readonly (Stuff & Containable)[]
- Defined in packages/server/src/mud/lib/spatial/Surfaced.ts:46

getUserFacingDetail

getUserFacingDetail(): string | undefined
MQL keyword bridge. If set, put X on <keyword> resolves the keyword against the host's Detailed map and lands on this surface. Mirrors SlotSpec.userFacingDetail (see slot.md § Detail-targeted resolution).

Returns string | undefined
- Defined in packages/server/src/mud/lib/spatial/Surfaced.ts:54

setUserFacingDetail

setUserFacingDetail(v: string | undefined): void
Parameters
- v: string | undefined
Returns void
- Defined in packages/server/src/mud/lib/spatial/Surfaced.ts:55