ecsjs/src/ecs.ts

An entity component system library for JavaScript

/*
 ecsjs is an entity component system library for JavaScript
 Copyright (C) 2014 Peter Flannery

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as
 published by the Free Software Foundation, either version 3 of the
 License, or (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * An entity component system library for JavaScript
 * @showCategories
 * @module ecsjs
 */
import { EntityMap } from './entity-map.js'
export { ComponentClassesMap, ComponentMap } from './component-map.js'
export { EntityMap } from './entity-map.js'
export type { ComponentNotRegistered, ComponentTypeKeyMissing } from './errors.js'
export { ComponentIterator } from './iterators.js'
export type { ComponentClass, IComponentIterator } from './types.js'

/**
 * Global instance of an {@link EntityMap}
 * 
 * See the [cheat sheet](https://gitlab.com/ecsjs/ecs/-/blob/master/docs/cheat-sheet.md) for more examples
 * @category Constants
 * @example
 * 
 * // register component(s)
 * ecs.register(Player, Position)
 * 
 * // create an entity
 * const [player, position] = ecs.set(ecs.getNextId(), new Player(), new Position(10, 40))
 */
export const ecs = new EntityMap()

if (typeof window !== 'undefined') {
  // @ts-ignore: exports to window
  window.ecs = ecs
} else if (typeof module !== 'undefined' && module !== null) {
  // exports to nodejs
  module.exports = { ecs };
}