Class EntityComponentDb

This is the purely id-based kernel of state management / indexing

Hierarchy

EntityComponentDb

Constructors

constructor

new EntityComponentDb(componentTypes: ShortTypeId[], classRegistry: ClassRegistry<Serializable>): EntityComponentDb

- Defined in base-engine/dist/entity-component-db.d.ts:36
Parameters
- componentTypes: ShortTypeId[]
- classRegistry: ClassRegistry<Serializable>
Returns EntityComponentDb

Properties

Private classRegistry

classRegistry: any

Private componentTypeIdToComponents

componentTypeIdToComponents: any

Private componentTypes

componentTypes: any

Private deletedTagTypeInfo

deletedTagTypeInfo: any

Private entityIdGenerator

entityIdGenerator: any

Private entityIdToComponents

entityIdToComponents: any

Methods

createEntity

createEntity(): EntityId

- Defined in base-engine/dist/entity-component-db.d.ts:38
Returns EntityId

deleteComponent

deleteComponent(componentId: ComponentId): void

- Defined in base-engine/dist/entity-component-db.d.ts:61
Marks a component as deleted, the component is still in the db until it is "released"

Parameters
- componentId: ComponentId
Returns void

deleteEntity

deleteEntity(entityId: EntityId): void

- Defined in base-engine/dist/entity-component-db.d.ts:44
Marks an entity and all its components as deleted, they are still in the db until they are "released"

Parameters
- entityId: EntityId
Returns void

getAllComponents

getAllComponents(): Iterable<GenericComponent>

- Defined in base-engine/dist/entity-component-db.d.ts:54
Returns Iterable<GenericComponent>

getAllComponentsOfEntity

getAllComponentsOfEntity(ownerId: EntityId): Iterable<GenericComponent>

- Defined in base-engine/dist/entity-component-db.d.ts:56
Parameters
- ownerId: EntityId
Returns Iterable<GenericComponent>

getAllComponentsOfType

getAllComponentsOfType(componentTypeId: ShortTypeId): Iterable<GenericComponent>

- Defined in base-engine/dist/entity-component-db.d.ts:55
Parameters
- componentTypeId: ShortTypeId
Returns Iterable<GenericComponent>

getAllEntities

getAllEntities(): Iterable<EntityId>

- Defined in base-engine/dist/entity-component-db.d.ts:40
Returns Iterable<EntityId>

getComponent

getComponent(componentId: ComponentId): undefined | GenericComponent

- Defined in base-engine/dist/entity-component-db.d.ts:52
Parameters
- componentId: ComponentId
Returns undefined | GenericComponent

getNumComponentsOfType

getNumComponentsOfType(componentTypeId: ShortTypeId): number

- Defined in base-engine/dist/entity-component-db.d.ts:57
Parameters
- componentTypeId: ShortTypeId
Returns number

hasComponent

hasComponent(componentId: ComponentId): boolean

- Defined in base-engine/dist/entity-component-db.d.ts:51
Parameters
- componentId: ComponentId
Returns boolean

hasEntity

hasEntity(entityId: EntityId): boolean

- Defined in base-engine/dist/entity-component-db.d.ts:39
Parameters
- entityId: EntityId
Returns boolean

releaseComponent

releaseComponent(componentId: ComponentId): void

- Defined in base-engine/dist/entity-component-db.d.ts:66
Release is "final" and releases references, whereas deletion is just a marker.

Parameters
- componentId: ComponentId
  
  The entity to release
Returns void

releaseDeletedState

releaseDeletedState(): void

- Defined in base-engine/dist/entity-component-db.d.ts:67
Returns void

releaseEntity

releaseEntity(entityId: EntityId): void

- Defined in base-engine/dist/entity-component-db.d.ts:50
Release is "final" and releases references, whereas deletion is just a marker. Releases the entity and all of its components

Parameters
- entityId: EntityId
  
  The entity to release
Returns void

serialize

serialize(stream: SerializationStream): void

- Defined in base-engine/dist/entity-component-db.d.ts:68
Parameters
- stream: SerializationStream
Returns void

setComponent

setComponent(componentId: ComponentId, data: Serializable): GenericComponent

- Defined in base-engine/dist/entity-component-db.d.ts:53
Parameters
- componentId: ComponentId
- data: Serializable
Returns GenericComponent

Generated using TypeDoc