@dcl/ecs 7.1.8 → 7.1.9-4767602514.commit-64fd553

package/dist/engine/index.js

@@ -148,24 +148,7 @@ function preEngine() {
         const componentId = typeof componentIdOrName === 'number' ? componentIdOrName : componentNumberFromName(componentIdOrName);
         componentsDefinition.delete(componentId);
     }
-    const Transform = components.Transform({ defineComponentFromSchema });
-    function* getTreeEntityArray(firstEntity, proccesedEntities) {
-        // This avoid infinite loop when there is a cyclic parenting
-        if (proccesedEntities.find((value) => firstEntity === value))
-            return;
-        proccesedEntities.push(firstEntity);
-        for (const [entity, value] of getEntitiesWith(Transform)) {
-            if (value.parent === firstEntity) {
-                yield* getTreeEntityArray(entity, proccesedEntities);
-            }
-        }
-        yield firstEntity;
-    }
-    function removeEntityWithChildren(firstEntity) {
-        for (const entity of getTreeEntityArray(firstEntity, [])) {
-            removeEntity(entity);
-        }
-    }
+    components.Transform({ defineComponentFromSchema });
     function seal() {
         if (!sealed) {
             sealed = true;
@@ -184,7 +167,6 @@ function preEngine() {
         getComponent,
         getComponentOrNull,
         removeComponentDefinition,
-        removeEntityWithChildren,
         registerComponentDefinition,
         entityContainer,
         componentsIter,
@@ -212,7 +194,6 @@ export function Engine(options) {
     return {
         addEntity: partialEngine.addEntity,
         removeEntity: partialEngine.removeEntity,
-        removeEntityWithChildren: partialEngine.removeEntityWithChildren,
         addSystem: partialEngine.addSystem,
         removeSystem: partialEngine.removeSystem,
         defineComponent: partialEngine.defineComponent,

package/dist/engine/types.d.ts

@@ -56,11 +56,6 @@ export interface IEngine {
      * @param entity - entity
      */
     removeEntity(entity: Entity): void;
-    /**
-     * Remove all components of each entity in the tree made with Transform parenting
-     * @param firstEntity - the root entity of the tree
-     */
-    removeEntityWithChildren(firstEntity: Entity): void;
     /**
      *
      * @public

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export * from './engine';
 export * from './schemas';
 export * from './runtime/initialization';
 export * from './runtime/types';
+export * from './runtime/helpers';
 export { cyclicParentingChecker } from './systems/cyclicParentingChecker';
 export * from './systems/events';
 export * from './systems/raycast';

package/dist/index.js

@@ -3,6 +3,7 @@ export * from './engine';
 export * from './schemas';
 export * from './runtime/initialization';
 export * from './runtime/types';
+export * from './runtime/helpers';
 export { cyclicParentingChecker } from './systems/cyclicParentingChecker';
 export * from './systems/events';
 export * from './systems/raycast';

package/dist/runtime/helpers/index.d.ts

@@ -0,0 +1 @@
+export * from './tree';

package/dist/runtime/helpers/index.js

@@ -0,0 +1 @@
+export * from './tree';

package/dist/runtime/helpers/tree.d.ts

@@ -0,0 +1,32 @@
+import { Entity } from '../../engine/entity';
+import { ComponentDefinition, IEngine } from '../../engine';
+/**
+ * Get an iterator of entities that follow a tree structure for a component
+ * @public
+ * @param engine - the engine running the entities
+ * @param entity - the root entity of the tree
+ * @param component - the parenting component to filter by
+ * @returns An iterator of an array as [entity, entity2, ...]
+ *
+ * Example:
+ * ```ts
+ * const TreeComponent = engine.defineComponent('custom::TreeComponent', {
+ *    label: Schemas.String,
+ *    parent: Schemas.Entity
+ * })
+ *
+ * for (const entity of getComponentEntityTree(engine, entity, TreeComponent)) {
+ *    // entity in the tree
+ * }
+ * ```
+ */
+export declare function getComponentEntityTree<T>(engine: IEngine, entity: Entity, component: ComponentDefinition<T & {
+    parent?: Entity;
+}>): Generator<Entity>;
+/**
+ * Remove all components of each entity in the tree made with Transform parenting
+ * @param engine - the engine running the entities
+ * @param firstEntity - the root entity of the tree
+ * @public
+ */
+export declare function removeEntityWithChildren(engine: IEngine, entity: Entity): void;

package/dist/runtime/helpers/tree.js

@@ -0,0 +1,49 @@
+import * as components from '../../components';
+function* genEntityTree(entity, entities) {
+    // This avoid infinite loop when there is a cyclic parenting
+    if (!entities.has(entity))
+        return;
+    entities.delete(entity);
+    for (const [_entity, value] of entities) {
+        if (value.parent === entity) {
+            yield* genEntityTree(_entity, entities);
+        }
+    }
+    yield entity;
+}
+/**
+ * Get an iterator of entities that follow a tree structure for a component
+ * @public
+ * @param engine - the engine running the entities
+ * @param entity - the root entity of the tree
+ * @param component - the parenting component to filter by
+ * @returns An iterator of an array as [entity, entity2, ...]
+ *
+ * Example:
+ * ```ts
+ * const TreeComponent = engine.defineComponent('custom::TreeComponent', {
+ *    label: Schemas.String,
+ *    parent: Schemas.Entity
+ * })
+ *
+ * for (const entity of getComponentEntityTree(engine, entity, TreeComponent)) {
+ *    // entity in the tree
+ * }
+ * ```
+ */
+export function getComponentEntityTree(engine, entity, component) {
+    const entities = new Map(engine.getEntitiesWith(component));
+    return genEntityTree(entity, entities);
+}
+/**
+ * Remove all components of each entity in the tree made with Transform parenting
+ * @param engine - the engine running the entities
+ * @param firstEntity - the root entity of the tree
+ * @public
+ */
+export function removeEntityWithChildren(engine, entity) {
+    const Transform = components.Transform(engine);
+    for (const _entity of getComponentEntityTree(engine, entity, Transform)) {
+        engine.removeEntity(_entity);
+    }
+}

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dcl/ecs",
   "description": "Decentraland ECS",
-  "version": "7.1.8",
+  "version": "7.1.9-4767602514.commit-64fd553",
   "author": "DCL",
   "bugs": "https://github.com/decentraland/ecs/issues",
   "dependencies": {
-    "@dcl/js-runtime": "7.1.8"
+    "@dcl/js-runtime": "7.1.9-4767602514.commit-64fd553"
   },
   "devDependencies": {
     "ts-proto": "^1.122.0"
@@ -34,5 +34,5 @@
   },
   "types": "./dist/index.d.ts",
   "typings": "./dist/index.d.ts",
-  "commit": "42042b569cac98bd9654f6c24e1774fad2e75551"
+  "commit": "64fd55305b172e36b5f88f59fddcd69835b0bd1a"
 }