@dcl/playground-assets 7.1.8 → 7.1.9-4789623295.commit-8cfb6bb

package/dist/playground/sdk/dcl-sdk.package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dcl/sdk",
   "description": "",
-  "version": "7.1.8",
+  "version": "7.1.9-4789623295.commit-8cfb6bb",
   "author": "Decentraland",
   "dependencies": {
     "@dcl/ecs": "file:../ecs",
@@ -30,5 +30,5 @@
   },
   "types": "./index.d.ts",
   "typings": "./index.d.ts",
-  "commit": "42042b569cac98bd9654f6c24e1774fad2e75551"
+  "commit": "8cfb6bba4f73ce95a482ebec015d20cf3b8e0b2c"
 }

package/dist/playground-assets.d.ts

@@ -1645,6 +1645,30 @@ export declare const enum Font {
     F_MONOSPACE = 2
 }
 
+/**
+ * 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>;
+
 /**
  * @public
  * @deprecated composite is not being supported so far, please do not use this feature
@@ -1726,11 +1750,6 @@ export declare 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
@@ -4994,6 +5013,14 @@ export declare interface Rect {
     height: number;
 }
 
+/**
+ * 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;
+
 export declare type RPCSendableMessage = {
     jsonrpc: '2.0';
     id: number;

package/etc/playground-assets.api.json

@@ -14688,6 +14688,126 @@
             }
           ]
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@dcl/playground-assets!getComponentEntityTree:function(1)",
+          "docComment": "/**\n * Get an iterator of entities that follow a tree structure for a component\n *\n * @param engine - the engine running the entities\n *\n * @param entity - the root entity of the tree\n *\n * @param component - the parenting component to filter by\n *\n * @returns An iterator of an array as [entity, entity2, ...]\n *\n * Example:\n * ```ts\n * const TreeComponent = engine.defineComponent('custom::TreeComponent', {\n *    label: Schemas.String,\n *    parent: Schemas.Entity\n * })\n *\n * for (const entity of getComponentEntityTree(engine, entity, TreeComponent)) {\n *    // entity in the tree\n * }\n * ```\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function getComponentEntityTree<T>(engine: "
+            },
+            {
+              "kind": "Reference",
+              "text": "IEngine",
+              "canonicalReference": "@dcl/playground-assets!IEngine:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", entity: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Entity",
+              "canonicalReference": "@dcl/playground-assets!Entity:type"
+            },
+            {
+              "kind": "Content",
+              "text": ", component: "
+            },
+            {
+              "kind": "Reference",
+              "text": "ComponentDefinition",
+              "canonicalReference": "@dcl/playground-assets!ComponentDefinition:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<T & {\n    parent?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Entity",
+              "canonicalReference": "@dcl/playground-assets!Entity:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n}>"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "Generator",
+              "canonicalReference": "!Generator:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Entity",
+              "canonicalReference": "@dcl/playground-assets!Entity:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../ecs/dist/runtime/helpers/tree.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 10,
+            "endIndex": 14
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "engine",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "entity",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "component",
+              "parameterTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 9
+              },
+              "isOptional": false
+            }
+          ],
+          "typeParameters": [
+            {
+              "typeParameterName": "T",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "getComponentEntityTree"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@dcl/playground-assets!getCompositeRootComponent:function(1)",
@@ -16279,52 +16399,6 @@
               ],
               "name": "removeEntity"
             },
-            {
-              "kind": "MethodSignature",
-              "canonicalReference": "@dcl/playground-assets!IEngine#removeEntityWithChildren:member(1)",
-              "docComment": "/**\n * Remove all components of each entity in the tree made with Transform parenting\n *\n * @param firstEntity - the root entity of the tree\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "removeEntityWithChildren(firstEntity: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Entity",
-                  "canonicalReference": "@dcl/playground-assets!Entity:type"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "void"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isOptional": false,
-              "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
-              },
-              "releaseTag": "Public",
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "firstEntity",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                }
-              ],
-              "name": "removeEntityWithChildren"
-            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@dcl/playground-assets!IEngine#removeSystem:member(1)",
@@ -43904,6 +43978,69 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@dcl/playground-assets!removeEntityWithChildren:function(1)",
+          "docComment": "/**\n * Remove all components of each entity in the tree made with Transform parenting\n *\n * @param engine - the engine running the entities\n *\n * @param firstEntity - the root entity of the tree\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function removeEntityWithChildren(engine: "
+            },
+            {
+              "kind": "Reference",
+              "text": "IEngine",
+              "canonicalReference": "@dcl/playground-assets!IEngine:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", entity: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Entity",
+              "canonicalReference": "@dcl/playground-assets!Entity:type"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "void"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../ecs/dist/runtime/helpers/tree.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 6
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "engine",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "entity",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "removeEntityWithChildren"
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@dcl/playground-assets!RPCSendableMessage:type",

package/etc/playground-assets.api.md

@@ -849,6 +849,11 @@ export const enum Font {
     F_SERIF = 1
 }
 
+// @public
+export function getComponentEntityTree<T>(engine: IEngine, entity: Entity, component: ComponentDefinition<T & {
+    parent?: Entity;
+}>): Generator<Entity>;
+
 // @public @deprecated (undocumented)
 export function getCompositeRootComponent(engine: IEngine): LastWriteWinElementSetComponentDefinition<CompositeRootType>;
 
@@ -939,7 +944,6 @@ export interface IEngine {
     readonly PlayerEntity: Entity;
     registerComponentDefinition<T>(componentName: string, componentDefinition: ComponentDefinition<T>): ComponentDefinition<T>;
     removeEntity(entity: Entity): void;
-    removeEntityWithChildren(firstEntity: Entity): void;
     removeSystem(selector: string | SystemFn): boolean;
     readonly RootEntity: Entity;
     seal(): void;
@@ -2609,6 +2613,9 @@ export interface Rect {
     y: number;
 }
 
+// @public
+export function removeEntityWithChildren(engine: IEngine, entity: Entity): void;
+
 // Warning: (ae-missing-release-tag) "RPCSendableMessage" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dcl/playground-assets",
   "description": "",
-  "version": "7.1.8",
+  "version": "7.1.9-4789623295.commit-8cfb6bb",
   "author": "Decentraland",
   "dependencies": {
-    "@dcl/js-runtime": "7.1.8",
-    "@dcl/sdk": "7.1.8"
+    "@dcl/js-runtime": "7.1.9-4789623295.commit-8cfb6bb",
+    "@dcl/sdk": "7.1.9-4789623295.commit-8cfb6bb"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.33.8"
@@ -28,5 +28,5 @@
   },
   "types": "./dist/index.d.ts",
   "typings": "./dist/index.d.ts",
-  "commit": "42042b569cac98bd9654f6c24e1774fad2e75551"
+  "commit": "8cfb6bba4f73ce95a482ebec015d20cf3b8e0b2c"
 }