Interface ICreatureManagerEvents

Hierarchy

Events<default<default>>
- ICreatureManagerEvents

Index

Methods

canSpawn remove shouldSpawnCreatureFromGroup spawn

Methods

canSpawn

canSpawn(type: CreatureType, tile: default, aberrant: boolean): undefined | boolean
Called when a creature is about to be spawned

Returns
False if the creature cannot spawn, or undefined to use the default logic
Parameters
- type: CreatureType
  
  The type of creature
- tile: default
  
  The tile where the creature will be spawned
- aberrant: boolean
  
  True if the creature is an aberrant
Returns undefined | boolean
- Defined in src/game/game/entity/creature/CreatureManager.ts:58

remove

remove(entity: default): any
Parameters
- entity: default
Returns any
Inherited from Events.remove
- Defined in src/game/game/entity/EntityManager.ts:24

shouldSpawnCreatureFromGroup

shouldSpawnCreatureFromGroup(creatureGroup: SpawnGroup, creaturePool: CreatureType[], tile: default): undefined | boolean
Called when a creature is spawned from a creature group

Returns
False to cancel spawning the creature or undefined to use the default logic
Parameters
- creatureGroup: SpawnGroup
  
  The creature group
- creaturePool: CreatureType[]
  
  The pool of creatures that can be spawned
- tile: default
  
  The tile where the creature will be spawned
Returns undefined | boolean
- Defined in src/game/game/entity/creature/CreatureManager.ts:67

spawn

spawn(entity: default): any
Parameters
- entity: default
Returns any
Inherited from Events.spawn
- Defined in src/game/game/entity/EntityManager.ts:23

Generated using TypeDoc