Class AComponent<K, VALUES, GET, SET>

Type parameters

K: string
VALUES
GET
SET

Hierarchy

AComponent
- MemMappedComponent
- ObjectComponent

Implements

IComponent<K, VALUES, GET, SET>
INotify

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AComponent<K, VALUES, GET, SET>(id: K, sparse: UIntArray, dense: UIntArray, vals: VALUES): AComponent<K, VALUES, GET, SET>

- Defined in ecs/src/components/acomponent.ts:27
Type parameters
- K: string
- VALUES
- GET
- SET
Parameters
- id: K
- sparse: UIntArray
- dense: UIntArray
- vals: VALUES
Returns AComponent<K, VALUES, GET, SET>

Properties

Optional default

default: ComponentDefaultValue<SET>

dense

dense: UIntArray

Readonly id

id: K

n

n: number

Optional owner

owner: IID<string>

Readonly Abstract size

size: number

sparse

sparse: UIntArray

Readonly Abstract stride

stride: number

vals

vals: VALUES

Methods

add

add(id: number, val?: SET): boolean

- Defined in ecs/src/components/acomponent.ts:87
Parameters
- id: number
- Optional val: SET
Returns boolean

addListener

addListener(id: string, fn: Listener, scope?: any): boolean

Implementation of IComponent.addListener
- Defined in ecs/src/components/acomponent.ts:123
Parameters
- id: string
- fn: Listener
- Optional scope: any
Returns boolean

delete

delete(id: number): boolean

Implementation of IComponent.delete
- Defined in ecs/src/components/acomponent.ts:104
Parameters
- id: number
Returns boolean

Abstract get

get(id: number): undefined | GET

Implementation of IComponent.get
- Defined in ecs/src/components/acomponent.ts:54
Parameters
- id: number
Returns undefined | GET

Abstract getIndex

getIndex(i: number): undefined | GET

Implementation of IComponent.getIndex
- Defined in ecs/src/components/acomponent.ts:56
Parameters
- i: number
Returns undefined | GET

has

has(id: number): boolean

Implementation of IComponent.has
- Defined in ecs/src/components/acomponent.ts:49
Parameters
- id: number
Returns boolean

keys

keys(): Uint8Array | Uint8ClampedArray | Uint16Array | Uint32Array

Implementation of IComponent.keys
- Defined in ecs/src/components/acomponent.ts:37
Returns Uint8Array | Uint8ClampedArray | Uint16Array | Uint32Array

Protected Abstract moveIndex

moveIndex(src: number, dest: number): void

- Defined in ecs/src/components/acomponent.ts:139
Parameters
- src: number
- dest: number
Returns void

notify

notify(event: Event): void

Implementation of IComponent.notify
- Defined in ecs/src/components/acomponent.ts:131
{@inheritDoc @thi.ng/api#INotify.notify}
Parameters
- event: Event
Returns void

notifyChange

notifyChange(id: number): void

- Defined in ecs/src/components/acomponent.ts:133
Parameters
- id: number
Returns void

removeListener

removeListener(id: string, fn: Listener, scope?: any): boolean

Implementation of IComponent.removeListener
- Defined in ecs/src/components/acomponent.ts:127
{@inheritDoc @thi.ng/api#INotify.removeListener}
Parameters
- id: string
- fn: Listener
- Optional scope: any
Returns boolean

Abstract resize

resize(pool: IMemPoolArray, newCap: number): void

Implementation of IComponent.resize
- Defined in ecs/src/components/acomponent.ts:47
Parameters
- pool: IMemPoolArray
- newCap: number
Returns void

set

set(id: number, val: SET): boolean

- Defined in ecs/src/components/acomponent.ts:67
Parameters
- id: number
- val: SET
Returns boolean

setIndex

setIndex(i: number, val: SET): boolean

- Defined in ecs/src/components/acomponent.ts:76
Parameters
- i: number
- val: SET
Returns boolean

Abstract setIndexUnsafe

setIndexUnsafe(i: number, val: SET, notify?: boolean): void

- Defined in ecs/src/components/acomponent.ts:85
Parameters
- i: number
- val: SET
- Optional notify: boolean
Returns void

Abstract swapIndices

swapIndices(src: number, dest: number): boolean

Implementation of IComponent.swapIndices
- Defined in ecs/src/components/acomponent.ts:137
Swaps slots of src & dest indices. The given args are NOT entity IDs, but indices in the dense array. The corresponding sparse & value slots are swapped too. Returns true if swap happened (false, if src and dest are equal)
Parameters
- src: number
- dest: number
Returns boolean

valueIndexForID

valueIndexForID(id: number): number

- Defined in ecs/src/components/acomponent.ts:58
Parameters
- id: number
Returns number

valueIndexForIDUnsafe

valueIndexForIDUnsafe(id: number): number

- Defined in ecs/src/components/acomponent.ts:63
Parameters
- id: number
Returns number

values

values(): Generator<NonNullable<GET>, void, unknown>

Implementation of IComponent.values
- Defined in ecs/src/components/acomponent.ts:41
Returns Generator<NonNullable<GET>, void, unknown>

Generated using TypeDoc