EntityComponentState

Represents all the entities' and components' states at a single point in time. Mutable to support in-place update by Systems.

Hierarchy

Serializable
- EntityComponentState

Implemented by

Index

Methods

createEntity

createEntity(): Entity

- Defined in base-engine/src/state.ts:18
Returns Entity

deleteComponent

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

- Defined in base-engine/src/state.ts:40
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

- Defined in base-engine/src/state.ts:20
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>]>

- Defined in base-engine/src/state.ts:53
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>]>
- Defined in base-engine/src/state.ts:57
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>]>

getComponent

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

- Defined in base-engine/src/state.ts:24
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>>

- Defined in base-engine/src/state.ts:47
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

- Defined in base-engine/src/state.ts:19
Parameters
- entityId: EntityId
Returns undefined | Entity

getEntityComponentDb

getEntityComponentDb(): EntityComponentDb

- Defined in base-engine/src/state.ts:78
Return the underlying dynamically-typed state. NB this object will never hide deleted state.

Returns EntityComponentDb

releaseDeletedState

releaseDeletedState(): void

- Defined in base-engine/src/state.ts:73
Drops all components and entities marked as deleted from the data

Returns void

serialize

serialize(stream: SerializationStream): void

Inherited from Serializable.serialize
- Defined in utils/dist/serialization.d.ts:3
Parameters
- stream: SerializationStream
Returns void

setComponent

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

- Defined in base-engine/src/state.ts:33
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

- Defined in base-engine/src/state.ts:69
Returns this same state, but all getters will filter out deleted entities and components.

Returns EntityComponentState

Hierarchy

Implemented by

Index

Methods

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>]>

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

Returns void

serialize

Parameters

stream: SerializationStream

Returns void

setComponent

Type parameters

T: Serializable

Parameters

ownerId: EntityId

data: T

Returns undefined | Component<T>

withDeletedStateHidden

Returns EntityComponentState