Interface IComponent<K, VALUES, GET, SET>

interface IComponent<K, VALUES, GET, SET> {
    dense: UIntArray;
    id: K;
    owner?: IID<string>;
    size: number;
    sparse: UIntArray;
    stride: number;
    vals: VALUES;
    add(id, val?): boolean;
    addListener(id, fn, scope?): boolean;
    delete(id): boolean;
    get(id): undefined | GET;
    getIndex(i): undefined | GET;
    has(id): boolean;
    keys(): ArrayLikeIterable<number>;
    notify(event): boolean;
    removeListener(id, fn, scope?): boolean;
    resize(pool, cap): void;
    set(i, val): boolean;
    setIndex(i, val): boolean;
    setIndexUnsafe(i, val, notify?): void;
    swapIndices(src, dest): boolean;
    values(): IterableIterator<GET>;
}

Type Parameters

  • K extends string
  • VALUES
  • GET
  • SET

Hierarchy

  • IID<K>
  • INotify
    • IComponent

Implemented by

Properties

dense id owner? size sparse stride vals

Methods

add addListener delete get getIndex has keys notify removeListener resize set setIndex setIndexUnsafe swapIndices values

Properties

dense

dense: UIntArray

Readonly id

id: K

Optional owner

owner?: IID<string>

Readonly size

size: number

sparse

sparse: UIntArray

Readonly stride

stride: number

vals

vals: VALUES

Methods

add

  • add(id, val?): boolean

  • Parameters

    • id: number
    • Optional val: SET

    Returns boolean

addListener

  • addListener(id, fn, scope?): boolean

  • Parameters

    • id: string
    • fn: Listener<string>
    • Optional scope: any

    Returns boolean

delete

get

getIndex

has

keys

  • keys(): ArrayLikeIterable<number>

  • Returns ArrayLikeIterable<number>

notify

  • notify(event): boolean

  • Broadcasts all registered listeners for given event type (in order registration) and returns true if any of them have been successfully notified.

    Parameters

    • event: Event<string>

    Returns boolean

    Remarks

    If a listener canceled the event (by setting Event.canceled), the function will stop notifying other listeners and return false. If no listeners are registered for the event, the function will also return false.

removeListener

  • removeListener(id, fn, scope?): boolean

  • Parameters

    • id: string
    • fn: Listener<string>
    • Optional scope: any

    Returns boolean

resize

  • resize(pool, cap): void

  • Parameters

    • pool: IMemPoolArray
    • cap: number

    Returns void

set

setIndex

setIndexUnsafe

  • setIndexUnsafe(i, val, notify?): void

  • Parameters

    • i: number
    • val: SET
    • Optional notify: boolean

    Returns void

swapIndices

  • swapIndices(src, dest): boolean

  • 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

values

Settings

Member Visibility

Theme

On This Page

denseidownersizesparsestridevalsaddaddListenerdeletegetgetIndexhaskeysnotifyremoveListenerresizesetsetIndexsetIndexUnsafeswapIndicesvalues

Generated using TypeDoc