Class ECS<SPEC>

constructor

• new ECS<SPEC>(opts?): ECS<SPEC>

• Type Parameters

  • SPEC

  Parameters

  • Optional opts: Partial<ECSOpts>

  Returns ECS<SPEC>

components

groups

idgen

pool

addListener

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

• Parameters

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

  Returns boolean

componentsForID

• componentsForID(id): IterableIterator<IComponent<ComponentID<SPEC>, any, any, any>>

• Parameters

  • id: number

  Returns IterableIterator<IComponent<ComponentID<SPEC>, any, any, any>>

defComponent

• defComponent<K>(opts): undefined | MemMappedComponent<K>

• Type Parameters

  • K extends string

  Parameters

  • opts: MemMappedComponentOpts<K>

  Returns undefined | MemMappedComponent<K>

• defComponent<K>(opts): undefined | ObjectComponent<K, SPEC[K]>

• Type Parameters

  • K extends string

  Parameters

  • opts: ObjectComponentOpts<K, SPEC[K]>

  Returns undefined | ObjectComponent<K, SPEC[K]>

defEntity

• defEntity<K>(comps?): number

• Type Parameters

  • K extends string

  Parameters

  • Optional comps: Partial<Pick<SPEC, K>> | K[] | IComponent<K, any, any, any>[]

  Returns number

defGroup

• defGroup<K>(comps, owned?, opts?): Group<SPEC, K>

• Type Parameters

  • K extends string

  Parameters

  • comps: IComponent<K, any, any, any>[]
  • owned: IComponent<K, any, any, any>[] = comps
  • opts: Partial<GroupOpts> = {}

  Returns Group<SPEC, K>

deleteID

• deleteID(id): boolean

• Parameters

  • id: number

  Returns boolean

groupsForID

• groupsForID(id): IterableIterator<Group<SPEC, any>>

• Parameters

  • id: number

  Returns IterableIterator<Group<SPEC, any>>

hasID

• hasID(id): void

• Parameters

  • id: number

  Returns void

notify

• notify(event): boolean

• Parameters

  • event: Event<ECSEventType>

  Returns boolean

removeListener

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

• Parameters

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

  Returns boolean

setCapacity

• setCapacity(newCap): void

• Parameters

  • newCap: number

  Returns void