Skip to main content

Class: PhysicsSystem

Defined in: physics/systems/physics.system.ts:7

Represents a system in the Entity-Component-System (ECS) architecture. A system operates on entities that contain specific components. Systems are responsible for updating the state of entities.

Extends

Constructors

Constructor

new PhysicsSystem(time, engine): PhysicsSystem

Defined in: physics/systems/physics.system.ts:11

Parameters

time

Time

engine

Engine

Returns

PhysicsSystem

Overrides

System.constructor

Properties

isEnabled

isEnabled: boolean = true

Defined in: ecs/types/System.ts:24

Indicates whether the system is enabled.

Inherited from

System.isEnabled


name

name: string

Defined in: ecs/types/System.ts:14

The name of the system.

Inherited from

System.name


query

query: Query

Defined in: ecs/types/System.ts:19

The components that this system operates on.

Inherited from

System.query

Methods

beforeAll()

beforeAll(entities): Entity[]

Defined in: physics/systems/physics.system.ts:22

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.

Overrides

System.beforeAll


run()

run(entity): void

Defined in: physics/systems/physics.system.ts:28

Abstract method to run the system on a single entity. Must be implemented by subclasses.

Parameters

entity

Entity

The entity to run the system on.

Returns

void

void | boolean - Returns void or a boolean indicating whether to exit early.

Overrides

System.run


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

System.runSystem


stop()

stop(): void

Defined in: ecs/types/System.ts:77

Stops the system. This method can be overridden by subclasses.

Returns

void

Inherited from

System.stop