Class SchedulerApi

Index

Methods

_clearAllForTesting _unregisterActivityForTesting cancel cancelAll cancelByPredicate cancelByType getActivityClass getEngagementById getEngagementBySlot getEngagements registerActivity reloadActivity start

Methods

`Static`_clearAllForTesting

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

`Static`_unregisterActivityForTesting

_unregisterActivityForTesting(type: string): void
Parameters
- type: string
Returns void
- Defined in packages/server/src/mud/api/scheduler.ts:209

`Static`cancel

cancel(engagement: Engagement, reason: keyof AbortReasonRegistry): void
Parameters
- engagement: Engagement
- reason: keyof AbortReasonRegistry
Returns void
- Defined in packages/server/src/mud/api/scheduler.ts:164

`Static`cancelAll

cancelAll(actor: Stuff & Engaged): void
Parameters
- actor: Stuff & Engaged
Returns void
- Defined in packages/server/src/mud/api/scheduler.ts:168

`Static`cancelByPredicate

cancelByPredicate(
actor: Stuff & Engaged,
pred: (e: Engagement) => boolean,
): void
Parameters
- actor: Stuff & Engaged
- pred: (e: Engagement) => boolean
Returns void
- Defined in packages/server/src/mud/api/scheduler.ts:176

`Static`cancelByType

cancelByType(actor: Stuff & Engaged, type: string): void
Parameters
- actor: Stuff & Engaged
- type: string
Returns void
- Defined in packages/server/src/mud/api/scheduler.ts:172

`Static`getActivityClass

getActivityClass(type: string): ActivityClass | undefined
Parameters
- type: string
Returns ActivityClass | undefined
- Defined in packages/server/src/mud/api/scheduler.ts:148

`Static`getEngagementById

getEngagementById(id: string): Engagement | undefined
Parameters
- id: string
Returns Engagement | undefined
- Defined in packages/server/src/mud/api/scheduler.ts:198

`Static`getEngagementBySlot

getEngagementBySlot(
actor: Stuff & Engaged,
slot: EngagementSlot,
): Engagement | undefined
Parameters
- actor: Stuff & Engaged
- slot: EngagementSlot
Returns Engagement | undefined
- Defined in packages/server/src/mud/api/scheduler.ts:191

`Static`getEngagements

getEngagements(actor: Stuff & Engaged): readonly Engagement[]
Parameters
- actor: Stuff & Engaged
Returns readonly Engagement[]
- Defined in packages/server/src/mud/api/scheduler.ts:185

`Static`registerActivity

registerActivity(type: string, cls: ActivityClass): void
Parameters
- type: string
- cls: ActivityClass
Returns void
- Defined in packages/server/src/mud/api/scheduler.ts:144

`Static`reloadActivity

reloadActivity(type: string): Promise<void>
Parameters
- type: string
Returns Promise<void>
- Defined in packages/server/src/mud/api/scheduler.ts:152

`Static`start

start(engagement: Engagement): StartResult
Parameters
- engagement: Engagement
Returns StartResult
- Defined in packages/server/src/mud/api/scheduler.ts:158