Entity | super-ecs

The entity is the container of components.

Hierarchy

Entity

Index

Constructors

constructor

Properties

id

Accessors

Methods

Constructors

constructor

new Entity(): Entity

- Defined in entity.ts:19
Returns Entity

Properties

Readonly id

id: number

unique id of entity

Accessors

componentAdded$

get componentAdded$(): Observable<Component>

- Defined in entity.ts:72
Stream triggered when a component is added Note: make sure to unsubscribe. If needed, use DisposeBag util

Returns Observable<Component>

componentRemoved$

get componentRemoved$(): Observable<Component>

- Defined in entity.ts:80
Stream triggered when a component is removed Note: make sure to unsubscribe. If needed, use DisposeBag util

Returns Observable<Component>

Methods

addComponent

addComponent(component: Component): Entity

- Defined in entity.ts:49
Add a component to this entity.

Parameters
- component: Component
Returns Entity

getComponent

getComponent<T>(componentName: symbol): undefined | T

- Defined in entity.ts:37
Get a component of this entity by name.

Type parameters
- T: Component
Parameters
- componentName: symbol
Returns undefined | T

hasComponent

hasComponent(componentName: symbol): boolean

- Defined in entity.ts:29
Check if this entity has a component by name.

Parameters
- componentName: symbol
Returns boolean

removeComponent

removeComponent(componentName: symbol): Entity

- Defined in entity.ts:59
Remove a component from this entity by name.

Parameters
- componentName: symbol
Returns Entity

Generated using TypeDoc