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

package/dist/alpha.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/dist/beta.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
@@ -4990,6 +5009,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/dist/index.bundled.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
@@ -4990,6 +5009,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;