angry-pixel 2.0.1 → 2.0.3

package/lib/index.d.ts

@@ -538,9 +538,8 @@ declare class EntityManager {
     private disabledComponents;
     /**
      * Creates an entity without component
-     * @return the created Entity
+     * @return The created Entity
      * @public
-     * @category Core
      * @example
      * ```js
      * const entity = entityManager.createEntity();
@@ -549,9 +548,9 @@ declare class EntityManager {
     createEntity(): Entity;
     /**
      * Creates an Entity based on a collection of Component instances and ComponentTypes
-     * @param components A collection of Component instances and ComponentTypes
+     * @param components A collection of component instances and component classes
+     * @return The created Entity
      * @public
-     * @category Core
      * @example
      * ```js
      * const entity = entityManager.createEntity([
@@ -561,11 +560,31 @@ declare class EntityManager {
      * ```
      */
     createEntity(components: Array<ComponentType | Component>): Entity;
+    /**
+     * Creates multiple entities based on an array of component collections
+     * @param componentsList An array of collections of component instances and component classes
+     * @return An array with the created entities, in the same order of the collections of components
+     * @public
+     * @example
+     * ```js
+     * const parent =  [
+     *   new Transform({position: new Vector2(100, 100)}),
+     *   SpriteRenderer
+     * ];
+     *
+     * const child =  [
+     *   new Transform({parent: parent[0]}),
+     *   SpriteRenderer
+     * ];
+     *
+     * const entity = entityManager.createEntities([parent, child]);
+     * ```
+     */
+    createEntities(componentsList: Component[][]): Entity[];
     /**
      * Removes an Entity and all its Components
      * @param entity The entity to remove
      * @public
-     * @category Core
      * @example
      * ```js
      * entityManager.removeEntity(entity);
@@ -575,7 +594,6 @@ declare class EntityManager {
     /**
      * Removes all Entities and all their Components
      * @public
-     * @category Core
      * @example
      * ```js
      * entityManager.removeAllEntities();
@@ -587,7 +605,6 @@ declare class EntityManager {
      * @param entity The entity to verify
      * @returns boolean
      * @public
-     * @category Core
      * @example
      * ```js
      * const entityEnabled = entityManager.isEntityEnabled(entity);
@@ -598,7 +615,6 @@ declare class EntityManager {
      * Enables an Entity
      * @param entity The entity to be enabled
      * @public
-     * @category Core
      * @example
      * ```js
      * entityManager.enableEntity(entity);
@@ -609,7 +625,6 @@ declare class EntityManager {
      * Disables an Entity
      * @param entity The entity to be disabled
      * @public
-     * @category Core
      * @example
      * ```js
      * entityManager.disableEntity(entity);
@@ -620,7 +635,6 @@ declare class EntityManager {
      * Disable all Entities that have a component of the given type
      * @param componentType The class of the component
      * @public
-     * @category Core
      * @example
      * ```js
      * entityManager.disableEntitiesByComponent(SpriteRenderer);
@@ -631,7 +645,6 @@ declare class EntityManager {
      * Enable all Entities that have a component of the given type
      * @param componentType The class of the component
      * @public
-     * @category Core
      * @example
      * ```js
      * entityManager.enableEntitiesByComponent(SpriteRenderer);
@@ -644,7 +657,6 @@ declare class EntityManager {
      * @param componentType The class of the component
      * @returns The instance of the component
      * @public
-     * @category Core
      * @example
      * ```js
      * const spriteRenderer = entityManager.addComponent(entity, SpriteRenderer);
@@ -657,7 +669,6 @@ declare class EntityManager {
      * @param component The instance of the component
      * @returns The instance of the component
      * @public
-     * @category Core
      * @example
      * ```js
      * const spriteRenderer = new SpriteRenderer();
@@ -671,7 +682,6 @@ declare class EntityManager {
      * @param componentType The class of the component
      * @returns boolean
      * @public
-     * @category Core
      * @example
      * ```js
      * const hasSpriteRenderer = entityManager.hasComponent(entity, SpriteRenderer);
@@ -684,7 +694,6 @@ declare class EntityManager {
      * @param componentType The class of the component
      * @returns The instance of the component
      * @public
-     * @category Core
      * @example
      * ```js
      * const spriteRenderer = entityManager.getComponent(entity, SpriteRenderer);
@@ -696,7 +705,6 @@ declare class EntityManager {
      * @param entity The entity
      * @returns A collection of component instances
      * @public
-     * @category Core
      * @example
      * ```js
      * const components = entityManager.getComponents(entity);
@@ -708,7 +716,6 @@ declare class EntityManager {
      * @param component The component instance
      * @returns The found Entity
      * @public
-     * @category Core
      * @example
      * ```js
      * const entity = entityManager.getEntityForComponent(spriteRenderer);
@@ -719,7 +726,6 @@ declare class EntityManager {
      * Removes the component instance from its Entity
      * @param component The component instance
      * @public
-     * @category Core
      * @example
      * ```js
      * entityManager.removeComponent(spriteRenderer)
@@ -731,7 +737,6 @@ declare class EntityManager {
      * @param entity The target entity
      * @param componentType The component class
      * @public
-     * @category Core
      * @example
      * ```js
      * entityManager.removeComponent(entity, SriteRenderer)
@@ -743,7 +748,6 @@ declare class EntityManager {
      * @param component The component instance
      * @returns boolean
      * @public
-     * @category Core
      * @example
      * ```js
      * entityManager.isComponentEnabled(spriteRenderer)
@@ -756,7 +760,6 @@ declare class EntityManager {
      * @param componentType The component class
      * @returns boolean
      * @public
-     * @category Core
      * @example
      * ```js
      * entityManager.isComponentEnabled(entity, SpriteRenderer)
@@ -767,7 +770,6 @@ declare class EntityManager {
      * Disables a component instance
      * @param component The component instance
      * @public
-     * @category Core
      * @example
      * ```js
      * entityManager.disableComponent(spriteRenderer);
@@ -779,7 +781,6 @@ declare class EntityManager {
      * @param entity The target entity
      * @param componentType The component class
      * @public
-     * @category Core
      * @example
      * ```js
      * entityManager.disableComponent(entity, SpriteRenderer);
@@ -790,7 +791,6 @@ declare class EntityManager {
      * Enables a component instance
      * @param component The component instance
      * @public
-     * @category Core
      * @example
      * ```js
      * entityManager.enableComponent(spriteRenderer);
@@ -802,7 +802,6 @@ declare class EntityManager {
      * @param entity The target entity
      * @param componentType The component class
      * @public
-     * @category Core
      * @example
      * ```js
      * entityManager.enableComponent(entity, SpriteRenderer);
@@ -819,7 +818,6 @@ declare class EntityManager {
      * @param includeDisabled TRUE to incluide disabled entities and components, FALSE otherwise
      * @returns SearchResult
      * @public
-     * @category Core
      * @example
      * ```js
      * const searchResult = entityManager.search(SpriteRenderer);
@@ -843,7 +841,6 @@ declare class EntityManager {
      * @param componentTypes A collection of component classes
      * @returns A collection of entities
      * @public
-     * @category Core
      * @example
      * ```js
      * const entities = entityManager.searchEntitiesByComponents([Transform, SpriteRenderer, Animator]);
@@ -1115,7 +1112,7 @@ interface GameConfig {
     };
 }
 
-declare class SystemFactory {
+declare class CreateSystemService {
     private readonly container;
     private readonly systemManager;
     private lastSystemTypeId;
@@ -1264,7 +1261,7 @@ declare class SceneManager {
     private sceneNameToBeLoaded;
     private loadingScene;
     /** @internal */
-    constructor(systemManager: SystemManager, systemFactory: SystemFactory, entityManager: EntityManager, assetManager: AssetManager);
+    constructor(systemManager: SystemManager, systemFactory: CreateSystemService, entityManager: EntityManager, assetManager: AssetManager);
     addScene(sceneType: SceneType, name: string, openingScene?: boolean): void;
     loadScene(name: string): void;
     loadOpeningScene(): void;