Class SpawnDirector

Index

Methods

create defineRule removeRule hasRule notifySpawned notifyDespawned tryAttempt tick setContext setGlobalBudget getSpawnedTotal getActiveCount getZoneCount ruleCount ruleIds clear dispose

Methods

`Static`create

create(opts?: SpawnDirectorOptions): SpawnDirector
Parameters
- opts: SpawnDirectorOptions = {}
Returns SpawnDirector
- Defined in runtime/spawn-director.ts:99

defineRule

defineRule(rule: SpawnRule): boolean
Parameters
- rule: SpawnRule
Returns boolean
- Defined in runtime/spawn-director.ts:103

removeRule

removeRule(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/spawn-director.ts:130

hasRule

hasRule(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/spawn-director.ts:135

notifySpawned

notifySpawned(ruleId: string): boolean
Parameters
- ruleId: string
Returns boolean
- Defined in runtime/spawn-director.ts:142

notifyDespawned

notifyDespawned(ruleId: string): boolean
Parameters
- ruleId: string
Returns boolean
- Defined in runtime/spawn-director.ts:153

tryAttempt

tryAttempt(ruleId: string): SpawnRejectReason | "spawned"
Parameters
- ruleId: string
Returns SpawnRejectReason | "spawned"
- Defined in runtime/spawn-director.ts:167

tick

tick(dtMs: number): void
Parameters
- dtMs: number
Returns void
- Defined in runtime/spawn-director.ts:175

setContext

setContext(ctx: Record<string, unknown>): void
Parameters
- ctx: Record<string, unknown>
Returns void
- Defined in runtime/spawn-director.ts:192

setGlobalBudget

setGlobalBudget(budget: number): void
Parameters
- budget: number
Returns void
- Defined in runtime/spawn-director.ts:197

getSpawnedTotal

getSpawnedTotal(): number
Returns number
- Defined in runtime/spawn-director.ts:203

getActiveCount

getActiveCount(ruleId: string): number
Parameters
- ruleId: string
Returns number
- Defined in runtime/spawn-director.ts:204

getZoneCount

getZoneCount(zone: string, ruleId: string): number
Parameters
- zone: string
- ruleId: string
Returns number
- Defined in runtime/spawn-director.ts:208

ruleCount

ruleCount(): number
Returns number
- Defined in runtime/spawn-director.ts:212

ruleIds

ruleIds(): string[]
Returns string[]
- Defined in runtime/spawn-director.ts:214

clear

clear(): void
Returns void
- Defined in runtime/spawn-director.ts:225

dispose

dispose(): void
Returns void
- Defined in runtime/spawn-director.ts:232