Interface Engaged

Public method surface for EngagedMixin. Read methods are open; the _setEngagement / _clearEngagement mutators reject every caller outside SchedulerApi at runtime (call-security ApiOnly).

interface Engaged {
    _clearEngagement(slot: EngagementSlot): void;
    _setEngagement(slot: EngagementSlot, engagement: Engagement): void;
    getEngagementBySlot(slot: EngagementSlot): Engagement | undefined;
    getEngagementByType(type: string): Engagement | undefined;
    getEngagements(): readonly Engagement[];
    hasEngagement(slot: EngagementSlot): boolean;
}

Index

Methods

_clearEngagement _setEngagement getEngagementBySlot getEngagementByType getEngagements hasEngagement

Methods

_clearEngagement

_clearEngagement(slot: EngagementSlot): void
Privileged mutator — same gating as _setEngagement.
Parameters
- slot: EngagementSlot
Returns void
- Defined in packages/server/src/mud/lib/activity/Engaged.ts:84

_setEngagement

_setEngagement(slot: EngagementSlot, engagement: Engagement): void
Privileged mutator — only SchedulerApi may call. Runtime-rejected outside api/ by the call-security gate.
Parameters
- slot: EngagementSlot
- engagement: Engagement
Returns void
- Defined in packages/server/src/mud/lib/activity/Engaged.ts:82

getEngagementBySlot

getEngagementBySlot(slot: EngagementSlot): Engagement | undefined
Engagement currently occupying slot, or undefined.
Parameters
- slot: EngagementSlot
Returns Engagement | undefined
- Defined in packages/server/src/mud/lib/activity/Engaged.ts:72

getEngagementByType

getEngagementByType(type: string): Engagement | undefined
First engagement whose .type matches, or undefined.
Parameters
- type: string
Returns Engagement | undefined
- Defined in packages/server/src/mud/lib/activity/Engaged.ts:74

getEngagements

getEngagements(): readonly Engagement[]
Snapshot of distinct engagements occupying any slot on this actor.

Returns readonly Engagement[]
- Defined in packages/server/src/mud/lib/activity/Engaged.ts:70

hasEngagement

hasEngagement(slot: EngagementSlot): boolean
True iff slot has an engagement.
Parameters
- slot: EngagementSlot
Returns boolean
- Defined in packages/server/src/mud/lib/activity/Engaged.ts:76

Interface Engaged

Index

Methods

Methods

_clearEngagement

Parameters

Returns void

_setEngagement

Parameters

Returns void

getEngagementBySlot

Parameters

Returns Engagement | undefined

getEngagementByType

Parameters

Returns Engagement | undefined

getEngagements

Returns readonly Engagement[]

hasEngagement

Parameters

Returns boolean

Settings

On This Page