Class: ReturnToPoolLifecycleSystem
Defined in: lifecycle/systems/return-to-pool-lifecycle-system.ts:10
System that returns entities to their pool when they have expired. This system handles only the ReturnToPoolStrategy - it queries for entities with both LifetimeComponent and ReturnToPoolStrategyComponent.
Extends
Constructors
Constructor
new ReturnToPoolLifecycleSystem():
ReturnToPoolLifecycleSystem
Defined in: lifecycle/systems/return-to-pool-lifecycle-system.ts:14
Creates an instance of ReturnToPoolLifecycleSystem.
Returns
ReturnToPoolLifecycleSystem
Overrides
Properties
isEnabled
isEnabled:
boolean=true
Defined in: ecs/types/System.ts:24
Indicates whether the system is enabled.
Inherited from
name
name:
string
Defined in: ecs/types/System.ts:14
The name of the system.
Inherited from
query
query:
Query
Defined in: ecs/types/System.ts:19
The components that this system operates on.
Inherited from
Methods
beforeAll()
beforeAll(
entities):Entity[]
Defined in: ecs/types/System.ts:70
Hook method that is called before running the system on all entities. Can be overridden by subclasses to modify the entities before processing.
Parameters
entities
Entity[]
The entities to be processed.
Returns
Entity[]
The modified entities.
Inherited from
run()
run(
entity):void
Defined in: lifecycle/systems/return-to-pool-lifecycle-system.ts:25
Returns the entity to its pool and removes it from the world if it has expired.
Parameters
entity
The entity to check and potentially return to pool.
Returns
void
Overrides
runSystem()
runSystem(
entities):void
Defined in: ecs/types/System.ts:40
Runs the system on the provided entities.
Parameters
entities
Entity[]
The entities to run the system on.
Returns
void
Inherited from
stop()
stop():
void
Defined in: ecs/types/System.ts:77
Stops the system. This method can be overridden by subclasses.
Returns
void