Interface Engagement

Base shape of an engagement. Both DurativeActivity (timed) and SustainedEngagement (untimed) satisfy this.

interface Engagement {
    actor: Stuff & Engaged;
    cancelable: boolean;
    emissions?: readonly ScheduledEmission[];
    engagementId: string;
    interruptibleBy: ReadonlySet<keyof AbortReasonRegistry>;
    slots: ReadonlySet<EngagementSlot>;
    startedAt: number;
    type: string;
    getHost?(): Stuff | null;
    onAbort(reason: keyof AbortReasonRegistry): void;
    onStart(): void;
}

Hierarchy (View Summary)

Engagement
- DurativeActivity

Index

Properties

actor cancelable emissions? engagementId interruptibleBy slots startedAt type

Methods

getHost? onAbort onStart

Properties

`Readonly`actor

actor: Stuff & Engaged

`Readonly`cancelable

cancelable: boolean

`Optional` `Readonly`emissions

emissions?: readonly ScheduledEmission[]

engagementId

engagementId: string

`Readonly`interruptibleBy

interruptibleBy: ReadonlySet<keyof AbortReasonRegistry>

`Readonly`slots

slots: ReadonlySet<EngagementSlot>

`Readonly`startedAt

startedAt: number

`Readonly`type

type: string

Methods

`Optional`getHost

getHost?(): Stuff | null
Returns Stuff | null
- Defined in packages/server/src/mud/api/scheduler.ts:73

onAbort

onAbort(reason: keyof AbortReasonRegistry): void
Parameters
- reason: keyof AbortReasonRegistry
Returns void
- Defined in packages/server/src/mud/api/scheduler.ts:72

onStart

onStart(): void
Returns void
- Defined in packages/server/src/mud/api/scheduler.ts:71