Class: RemoveFromWorldLifecycleSystem
Defined in: lifecycle/systems/remove-from-world-lifecycle-system.ts:10
System that removes entities from the world when they have expired. This system handles only the RemoveFromWorldStrategy - it queries for entities with both LifetimeComponent and RemoveFromWorldStrategyComponent.
Extends
Constructors
Constructor
new RemoveFromWorldLifecycleSystem(
world):RemoveFromWorldLifecycleSystem
Defined in: lifecycle/systems/remove-from-world-lifecycle-system.ts:17
Creates an instance of RemoveFromWorldLifecycleSystem.
Parameters
world
The World instance.
Returns
RemoveFromWorldLifecycleSystem
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/remove-from-world-lifecycle-system.ts:29
Removes the entity from the world if it has expired.
Parameters
entity
The entity to check and potentially remove.
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