EntityComponentStateImpl

Wraps an EntityComponentDb to provide a statically-typed, more ORM-like interface. If you want raw access to the dynamically-typed component data, grab the EntityComponentDb

Hierarchy

EntityComponentStateImpl

Implements

EntityComponentState

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

- Defined in base-engine/dist/state.d.ts:84
Parameters
- componentTypes: ShortTypeId[]
- classRegistry: ClassRegistry<Serializable>
Returns EntityComponentStateImpl

Properties

Private classRegistry

classRegistry: any

Private componentTypes

componentTypes: any

Private deletionHidingFacade

deletionHidingFacade: any

Private entityComponentDb

entityComponentDb: any

Methods

createEntity

createEntity(): Entity

Implementation of EntityComponentState.createEntity
- Defined in base-engine/dist/state.d.ts:86
Returns Entity

deleteComponent

deleteComponent<T>(componentType: new () => T, ownerId: EntityId): void

Implementation of EntityComponentState.deleteComponent
- Defined in base-engine/dist/state.d.ts:91
Marks the component as deleted.

Type parameters
- T: Serializable
Parameters
- componentType: new () => T
  - - new (): T
    - Returns T
- ownerId: EntityId
Returns void

deleteEntity

deleteEntity(entityId: EntityId): void

Implementation of EntityComponentState.deleteEntity
- Defined in base-engine/dist/state.d.ts:88
Parameters
- entityId: EntityId
Returns void

getAspect

getAspect<T, U>(componentTypeT: new () => T, componentTypeU: new () => U): Iterable<[Component<T>, Component<U>]>
getAspect<T, U, V>(componentTypeT: new () => T, componentTypeU: new () => U, componentTypeV: new () => V): Iterable<[Component<T>, Component<U>, Component<V>]>

Implementation of EntityComponentState.getAspect
- Defined in base-engine/dist/state.d.ts:93
Gets a tuple of components for each entity that has all the provided component types

Type parameters
- T: Serializable
- U: Serializable
Parameters
- componentTypeT: new () => T
  - - new (): T
    - Returns T
- componentTypeU: new () => U
  - - new (): U
    - Returns U
Returns Iterable<[Component<T>, Component<U>]>
Implementation of EntityComponentState.getAspect
- Defined in base-engine/dist/state.d.ts:94
Type parameters
- T: Serializable
- U: Serializable
- V: Serializable
Parameters
- componentTypeT: new () => T
  - - new (): T
    - Returns T
- componentTypeU: new () => U
  - - new (): U
    - Returns U
- componentTypeV: new () => V
  - - new (): V
    - Returns V
Returns Iterable<[Component<T>, Component<U>, Component<V>]>

getAspectGeneric

getAspectGeneric(componentTypes: (new () => Serializable)[]): Iterable<Component<Serializable>[]>

- Defined in base-engine/dist/state.d.ts:95
Parameters
- componentTypes: (new () => Serializable)[]
Returns Iterable<Component<Serializable>[]>

getComponent

getComponent<T>(componentType: new () => T, ownerId: EntityId): undefined | Component<T>

Implementation of EntityComponentState.getComponent
- Defined in base-engine/dist/state.d.ts:89
Returns a Component of the supplied type if the given entity owns one

Type parameters
- T: Serializable
Parameters
- componentType: new () => T
  - - new (): T
    - Returns T
- ownerId: EntityId
Returns undefined | Component<T>

getComponents

getComponents<T>(componentType: new () => T): Iterable<Component<T>>

Implementation of EntityComponentState.getComponents
- Defined in base-engine/dist/state.d.ts:92
Gets all the components of the given type

Type parameters
- T: Serializable
Parameters
- componentType: new () => T
  - - new (): T
    - Returns T
Returns Iterable<Component<T>>

getEntity

getEntity(entityId: EntityId): undefined | Entity

Implementation of EntityComponentState.getEntity
- Defined in base-engine/dist/state.d.ts:87
Parameters
- entityId: EntityId
Returns undefined | Entity

getEntityComponentDb

getEntityComponentDb(): EntityComponentDb

Implementation of EntityComponentState.getEntityComponentDb
- Defined in base-engine/dist/state.d.ts:100
Return the underlying dynamically-typed state. NB this object will never hide deleted state.

Returns EntityComponentDb

releaseDeletedState

releaseDeletedState(): void

Implementation of EntityComponentState.releaseDeletedState
- Defined in base-engine/dist/state.d.ts:98
Drops all components and entities marked as deleted from the data

Returns void

serialize

serialize(stream: SerializationStream): void

Implementation of EntityComponentState.serialize
- Defined in base-engine/dist/state.d.ts:99
Parameters
- stream: SerializationStream
Returns void

setComponent

setComponent<T>(ownerId: EntityId, data: T): undefined | Component<T>

Implementation of EntityComponentState.setComponent
- Defined in base-engine/dist/state.d.ts:90
Sets the component data of the given owner. If entity already has component of this type, it overwrites existing component If entity does not exist, it will return undefined.

Type parameters
- T: Serializable
Parameters
- ownerId: EntityId
- data: T
Returns undefined | Component<T>

withDeletedStateHidden

withDeletedStateHidden(): EntityComponentState

Implementation of EntityComponentState.withDeletedStateHidden
- Defined in base-engine/dist/state.d.ts:97
Returns this same state, but all getters will filter out deleted entities and components.

Returns EntityComponentState

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

componentTypes: ShortTypeId[]

classRegistry: ClassRegistry<Serializable>

Returns EntityComponentStateImpl

Properties

Private classRegistry

Private componentTypes

Private deletionHidingFacade

Private entityComponentDb

Methods

createEntity

Returns Entity

deleteComponent

Type parameters

T: Serializable

Parameters

componentType: new () => T

Returns T

ownerId: EntityId

Returns void

deleteEntity

Parameters

entityId: EntityId

Returns void

getAspect

Type parameters

T: Serializable

U: Serializable

Parameters

componentTypeT: new () => T

Returns T

componentTypeU: new () => U

Returns U

Returns Iterable<[Component<T>, Component<U>]>

Type parameters

T: Serializable

U: Serializable

V: Serializable

Parameters

componentTypeT: new () => T

Returns T

componentTypeU: new () => U

Returns U

componentTypeV: new () => V

Returns V

Returns Iterable<[Component<T>, Component<U>, Component<V>]>

getAspectGeneric

Parameters

componentTypes: (new () => Serializable)[]

Returns Iterable<Component<Serializable>[]>

getComponent

Type parameters

T: Serializable

Parameters

componentType: new () => T

Returns T

ownerId: EntityId

Returns undefined | Component<T>

getComponents

Type parameters

T: Serializable

Parameters

componentType: new () => T

Returns T

Returns Iterable<Component<T>>

getEntity

Parameters

entityId: EntityId

Returns undefined | Entity

getEntityComponentDb

Returns EntityComponentDb

releaseDeletedState