Interface Spawner

Public shape provided by SpawnerMixin.

interface Spawner {
    getSpawned(): ReadonlySet<Stuff & Spawned>;
    hasSpawned(spawned: Stuff & Spawned): boolean;
    trackSpawn(spawned: Stuff & Spawned): void;
    untrackSpawn(spawned: Stuff & Spawned): boolean;
}

Index

Methods

getSpawned hasSpawned trackSpawn untrackSpawn

Methods

getSpawned

getSpawned(): ReadonlySet<Stuff & Spawned>
Read-only snapshot of the current spawn set.

Returns ReadonlySet<Stuff & Spawned>
- Defined in packages/server/src/mud/lib/stuff/Spawner.ts:61

hasSpawned

hasSpawned(spawned: Stuff & Spawned): boolean
Membership predicate.
Parameters
- spawned: Stuff & Spawned
Returns boolean
- Defined in packages/server/src/mud/lib/stuff/Spawner.ts:64

trackSpawn

trackSpawn(spawned: Stuff & Spawned): void
Record spawned as a runtime child of this Spawner. Idempotent.
Parameters
- spawned: Stuff & Spawned
Returns void
- Defined in packages/server/src/mud/lib/stuff/Spawner.ts:50

untrackSpawn

untrackSpawn(spawned: Stuff & Spawned): boolean
Drop spawned from this Spawner's runtime collection. Returns true if it was present. Used by Spawned.cleanupOnDestruct for R2.4 symmetric cleanup; also callable by content code that wants to transfer ownership of a spawn elsewhere.
Parameters
- spawned: Stuff & Spawned
Returns boolean
- Defined in packages/server/src/mud/lib/stuff/Spawner.ts:58