@dcl/ecs 7.10.2 → 7.10.3-17918694201.commit-b983b3b

package/dist/components/index.d.ts

@@ -17,6 +17,7 @@ import { MediaState } from './generated/pb/decentraland/sdk/components/common/me
 import { VirtualCameraComponentDefinitionExtended } from './extended/VirtualCamera';
 import { InputModifierComponentDefinitionExtended } from './extended/InputModifier';
 import { LightSourceComponentDefinitionExtended } from './extended/LightSource';
+import { TagsComponentDefinitionExtended } from './manual/Tags';
 export * from './generated/index.gen';
 export type { GrowOnlyValueSetComponentDefinition, LastWriteWinElementSetComponentDefinition, LwwComponentGetter, GSetComponentGetter };
 export declare const Transform: LwwComponentGetter<TransformComponentExtended>;
@@ -34,6 +35,7 @@ export declare const LightSource: LwwComponentGetter<LightSourceComponentDefinit
  * @alpha
  */
 export declare const Name: (engine: Pick<IEngine, 'defineComponent'>) => LastWriteWinElementSetComponentDefinition<NameType>;
+export declare const Tags: (engine: Pick<IEngine, 'defineComponent'>) => TagsComponentDefinitionExtended;
 /**
  * @alpha
  */

package/dist/components/index.js

@@ -14,6 +14,7 @@ import { MediaState } from './generated/pb/decentraland/sdk/components/common/me
 import { defineVirtualCameraComponent } from './extended/VirtualCamera';
 import { defineInputModifierComponent } from './extended/InputModifier';
 import { defineLightSourceComponent } from './extended/LightSource';
+import defineTagsComponent from './manual/Tags';
 export * from './generated/index.gen';
 /* @__PURE__ */
 export const Transform = (engine) => defineTransformComponent(engine);
@@ -42,6 +43,8 @@ export const LightSource = (engine) => defineLightSourceComponent(engine);
  */
 /* @__PURE__ */
 export const Name = (engine) => defineNameComponent(engine);
+/* @__PURE__ */
+export const Tags = (engine) => defineTagsComponent(engine);
 /**
  * @alpha
  */

package/dist/components/manual/Tags.d.ts

@@ -0,0 +1,34 @@
+import { IEngine, LastWriteWinElementSetComponentDefinition } from '../../engine/types';
+import { Entity } from '../../engine';
+export interface TagsType {
+    tags: string[];
+}
+export interface TagsComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<TagsType> {
+    /**
+     * @public
+     *
+     * Add a tag to the entity's Tags component or create the component if it doesn't exist and add the tag
+     * @param entity - entity to add the tag to
+     * @param tagName - the tag name to add
+     * @returns true
+     */
+    add(entity: Entity, tagName: string): boolean;
+    /**
+     * @public
+     *
+     * Remove a tag from the entity's Tags component
+     * @param entity - entity to remove the tag from
+     * @param tagName - the tag name to remove
+     * @returns true if successful, false if the entity doesn't have a Tags component or the tag doesn't exist
+     */
+    remove(entity: Entity, tagName: string): boolean;
+}
+/**
+ * @public
+ *
+ * Define the Tags component
+ * @param engine - the engine to define the component on
+ * @returns the Tags component definition
+ */
+declare function defineTagsComponent(engine: Pick<IEngine, 'defineComponent'>): TagsComponentDefinitionExtended;
+export default defineTagsComponent;

package/dist/components/manual/Tags.js

@@ -0,0 +1,37 @@
+import { Schemas } from '../../schemas';
+/**
+ * @public
+ *
+ * Define the Tags component
+ * @param engine - the engine to define the component on
+ * @returns the Tags component definition
+ */
+function defineTagsComponent(engine) {
+    const Tags = engine.defineComponent('core-schema::Tags', {
+        tags: Schemas.Array(Schemas.String)
+    });
+    return {
+        ...Tags,
+        add(entity, tagName) {
+            const tagsComponent = Tags.getMutableOrNull(entity);
+            if (tagsComponent) {
+                tagsComponent.tags.push(tagName);
+            }
+            else {
+                Tags.createOrReplace(entity, { tags: [tagName] });
+            }
+            return true;
+        },
+        remove(entity, tagName) {
+            const tagsComponent = Tags.getMutableOrNull(entity);
+            if (!tagsComponent || !tagsComponent.tags)
+                return false;
+            const newTags = tagsComponent.tags.filter((tag) => tag !== tagName);
+            if (newTags.length === tagsComponent.tags.length)
+                return false;
+            tagsComponent.tags = newTags;
+            return true;
+        }
+    };
+}
+export default defineTagsComponent;

package/dist/components/types.d.ts

@@ -8,6 +8,7 @@ export type { TweenHelper, TweenComponentDefinitionExtended } from './extended/T
 export type { CameraTransitionHelper, VirtualCameraComponentDefinitionExtended } from './extended/VirtualCamera';
 export type { TransformComponentExtended, TransformTypeWithOptionals } from './manual/Transform';
 export type { NameComponent, NameType } from './manual/Name';
+export type { TagsComponentDefinitionExtended, TagsType } from './manual/Tags';
 export type { ISyncComponents, ISyncComponentsType } from './manual/SyncComponents';
 export type { INetowrkEntity, INetowrkEntityType } from './manual/NetworkEntity';
 export type { INetowrkParent, INetowrkParentType } from './manual/NetworkParent';

package/dist/engine/index.js

@@ -143,6 +143,14 @@ function preEngine(options) {
         const entity = getEntityOrNullByName(value);
         return entity;
     }
+    function* getEntitiesByTag(tagName) {
+        const TagComponent = components.Tags({ defineComponent });
+        for (const [entity, component] of getEntitiesWith(TagComponent)) {
+            if (entity !== 0 && component.tags?.some((tag) => tag === tagName)) {
+                yield entity;
+            }
+        }
+    }
     function* getComponentDefGroup(...args) {
         const [firstComponentDef, ...componentDefinitions] = args;
         for (const [entity] of firstComponentDef.iterator()) {
@@ -191,6 +199,7 @@ function preEngine(options) {
         getComponentOrNull: getComponentOrNull,
         getEntityOrNullByName,
         getEntityByName,
+        getEntitiesByTag,
         removeComponentDefinition,
         registerComponentDefinition,
         entityContainer,
@@ -246,6 +255,7 @@ export function Engine(options) {
         seal: partialEngine.seal,
         getEntityOrNullByName: partialEngine.getEntityOrNullByName,
         getEntityByName: partialEngine.getEntityByName,
+        getEntitiesByTag: partialEngine.getEntitiesByTag,
         update,
         RootEntity: 0,
         PlayerEntity: 1,

package/dist/engine/types.d.ts

@@ -196,6 +196,13 @@ export interface IEngine {
      * @typeParam T - The type of the entity name value
      */
     getEntityByName<T = never, K = T>(value: K & (T extends never ? never : string)): Entity;
+    /**
+     * @public
+     * Get all entities that have a specific tag in their Tag component
+     * @param tag - Tag to search
+     * @returns Iterator of entities that have the given tag
+     */
+    getEntitiesByTag(tagName: string): Iterable<Entity>;
     /**
      * @public
      * @param deltaTime - deltaTime in seconds

package/dist/index.d.ts

@@ -13,6 +13,7 @@ export * from './engine/entity';
 export * from './components/types';
 import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, AudioSourceComponentDefinitionExtended, AudioStreamComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended, INetowrkEntity, INetowrkParent, VirtualCameraComponentDefinitionExtended, InputModifierComponentDefinitionExtended, LightSourceComponentDefinitionExtended } from './components/types';
 import { NameComponent } from './components/manual/Name';
+import { TagsComponentDefinitionExtended } from './components/manual/Tags';
 export declare const Transform: TransformComponentExtended;
 export declare const Animator: AnimatorComponentDefinitionExtended;
 export declare const AudioSource: AudioSourceComponentDefinitionExtended;
@@ -21,6 +22,7 @@ export declare const Material: MaterialComponentDefinitionExtended;
 export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
 export declare const MeshCollider: MeshColliderComponentDefinitionExtended;
 export declare const Name: NameComponent;
+export declare const Tags: TagsComponentDefinitionExtended;
 export declare const Tween: TweenComponentDefinitionExtended;
 export declare const VirtualCamera: VirtualCameraComponentDefinitionExtended;
 export declare const InputModifier: InputModifierComponentDefinitionExtended;

package/dist/index.js

@@ -26,6 +26,7 @@ export const Material = /* @__PURE__*/ components.Material(engine);
 export const MeshRenderer = /* @__PURE__*/ components.MeshRenderer(engine);
 export const MeshCollider = /* @__PURE__*/ components.MeshCollider(engine);
 export const Name = components.Name(engine);
+export const Tags = components.Tags(engine);
 export const Tween = /* @__PURE__*/ components.Tween(engine);
 export const VirtualCamera = /* @__PURE__*/ components.VirtualCamera(engine);
 export const InputModifier = /* @__PURE__*/ components.InputModifier(engine);

package/dist-cjs/components/index.d.ts

@@ -17,6 +17,7 @@ import { MediaState } from './generated/pb/decentraland/sdk/components/common/me
 import { VirtualCameraComponentDefinitionExtended } from './extended/VirtualCamera';
 import { InputModifierComponentDefinitionExtended } from './extended/InputModifier';
 import { LightSourceComponentDefinitionExtended } from './extended/LightSource';
+import { TagsComponentDefinitionExtended } from './manual/Tags';
 export * from './generated/index.gen';
 export type { GrowOnlyValueSetComponentDefinition, LastWriteWinElementSetComponentDefinition, LwwComponentGetter, GSetComponentGetter };
 export declare const Transform: LwwComponentGetter<TransformComponentExtended>;
@@ -34,6 +35,7 @@ export declare const LightSource: LwwComponentGetter<LightSourceComponentDefinit
  * @alpha
  */
 export declare const Name: (engine: Pick<IEngine, 'defineComponent'>) => LastWriteWinElementSetComponentDefinition<NameType>;
+export declare const Tags: (engine: Pick<IEngine, 'defineComponent'>) => TagsComponentDefinitionExtended;
 /**
  * @alpha
  */

package/dist-cjs/components/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MediaState = exports.NetworkParent = exports.NetworkEntity = exports.SyncComponents = exports.Name = exports.LightSource = exports.InputModifier = exports.VirtualCamera = exports.Tween = exports.MeshCollider = exports.MeshRenderer = exports.AudioStream = exports.AudioSource = exports.Animator = exports.Material = exports.Transform = void 0;
+exports.MediaState = exports.NetworkParent = exports.NetworkEntity = exports.SyncComponents = exports.Tags = exports.Name = exports.LightSource = exports.InputModifier = exports.VirtualCamera = exports.Tween = exports.MeshCollider = exports.MeshRenderer = exports.AudioStream = exports.AudioSource = exports.Animator = exports.Material = exports.Transform = void 0;
 const Animator_1 = require("./extended/Animator");
 const AudioSource_1 = require("./extended/AudioSource");
 const Material_1 = require("./extended/Material");
@@ -35,6 +35,7 @@ Object.defineProperty(exports, "MediaState", { enumerable: true, get: function (
 const VirtualCamera_1 = require("./extended/VirtualCamera");
 const InputModifier_1 = require("./extended/InputModifier");
 const LightSource_1 = require("./extended/LightSource");
+const Tags_1 = __importDefault(require("./manual/Tags"));
 __exportStar(require("./generated/index.gen"), exports);
 /* @__PURE__ */
 const Transform = (engine) => (0, Transform_1.defineTransformComponent)(engine);
@@ -75,6 +76,9 @@ exports.LightSource = LightSource;
 /* @__PURE__ */
 const Name = (engine) => (0, Name_1.default)(engine);
 exports.Name = Name;
+/* @__PURE__ */
+const Tags = (engine) => (0, Tags_1.default)(engine);
+exports.Tags = Tags;
 /**
  * @alpha
  */

package/dist-cjs/components/manual/Tags.d.ts

@@ -0,0 +1,34 @@
+import { IEngine, LastWriteWinElementSetComponentDefinition } from '../../engine/types';
+import { Entity } from '../../engine';
+export interface TagsType {
+    tags: string[];
+}
+export interface TagsComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<TagsType> {
+    /**
+     * @public
+     *
+     * Add a tag to the entity's Tags component or create the component if it doesn't exist and add the tag
+     * @param entity - entity to add the tag to
+     * @param tagName - the tag name to add
+     * @returns true
+     */
+    add(entity: Entity, tagName: string): boolean;
+    /**
+     * @public
+     *
+     * Remove a tag from the entity's Tags component
+     * @param entity - entity to remove the tag from
+     * @param tagName - the tag name to remove
+     * @returns true if successful, false if the entity doesn't have a Tags component or the tag doesn't exist
+     */
+    remove(entity: Entity, tagName: string): boolean;
+}
+/**
+ * @public
+ *
+ * Define the Tags component
+ * @param engine - the engine to define the component on
+ * @returns the Tags component definition
+ */
+declare function defineTagsComponent(engine: Pick<IEngine, 'defineComponent'>): TagsComponentDefinitionExtended;
+export default defineTagsComponent;

package/dist-cjs/components/manual/Tags.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const schemas_1 = require("../../schemas");
+/**
+ * @public
+ *
+ * Define the Tags component
+ * @param engine - the engine to define the component on
+ * @returns the Tags component definition
+ */
+function defineTagsComponent(engine) {
+    const Tags = engine.defineComponent('core-schema::Tags', {
+        tags: schemas_1.Schemas.Array(schemas_1.Schemas.String)
+    });
+    return {
+        ...Tags,
+        add(entity, tagName) {
+            const tagsComponent = Tags.getMutableOrNull(entity);
+            if (tagsComponent) {
+                tagsComponent.tags.push(tagName);
+            }
+            else {
+                Tags.createOrReplace(entity, { tags: [tagName] });
+            }
+            return true;
+        },
+        remove(entity, tagName) {
+            const tagsComponent = Tags.getMutableOrNull(entity);
+            if (!tagsComponent || !tagsComponent.tags)
+                return false;
+            const newTags = tagsComponent.tags.filter((tag) => tag !== tagName);
+            if (newTags.length === tagsComponent.tags.length)
+                return false;
+            tagsComponent.tags = newTags;
+            return true;
+        }
+    };
+}
+exports.default = defineTagsComponent;

package/dist-cjs/components/types.d.ts

@@ -8,6 +8,7 @@ export type { TweenHelper, TweenComponentDefinitionExtended } from './extended/T
 export type { CameraTransitionHelper, VirtualCameraComponentDefinitionExtended } from './extended/VirtualCamera';
 export type { TransformComponentExtended, TransformTypeWithOptionals } from './manual/Transform';
 export type { NameComponent, NameType } from './manual/Name';
+export type { TagsComponentDefinitionExtended, TagsType } from './manual/Tags';
 export type { ISyncComponents, ISyncComponentsType } from './manual/SyncComponents';
 export type { INetowrkEntity, INetowrkEntityType } from './manual/NetworkEntity';
 export type { INetowrkParent, INetowrkParentType } from './manual/NetworkParent';

package/dist-cjs/engine/index.js

@@ -172,6 +172,14 @@ function preEngine(options) {
         const entity = getEntityOrNullByName(value);
         return entity;
     }
+    function* getEntitiesByTag(tagName) {
+        const TagComponent = components.Tags({ defineComponent });
+        for (const [entity, component] of getEntitiesWith(TagComponent)) {
+            if (entity !== 0 && component.tags?.some((tag) => tag === tagName)) {
+                yield entity;
+            }
+        }
+    }
     function* getComponentDefGroup(...args) {
         const [firstComponentDef, ...componentDefinitions] = args;
         for (const [entity] of firstComponentDef.iterator()) {
@@ -220,6 +228,7 @@ function preEngine(options) {
         getComponentOrNull: getComponentOrNull,
         getEntityOrNullByName,
         getEntityByName,
+        getEntitiesByTag,
         removeComponentDefinition,
         registerComponentDefinition,
         entityContainer,
@@ -275,6 +284,7 @@ function Engine(options) {
         seal: partialEngine.seal,
         getEntityOrNullByName: partialEngine.getEntityOrNullByName,
         getEntityByName: partialEngine.getEntityByName,
+        getEntitiesByTag: partialEngine.getEntitiesByTag,
         update,
         RootEntity: 0,
         PlayerEntity: 1,

package/dist-cjs/engine/types.d.ts

@@ -196,6 +196,13 @@ export interface IEngine {
      * @typeParam T - The type of the entity name value
      */
     getEntityByName<T = never, K = T>(value: K & (T extends never ? never : string)): Entity;
+    /**
+     * @public
+     * Get all entities that have a specific tag in their Tag component
+     * @param tag - Tag to search
+     * @returns Iterator of entities that have the given tag
+     */
+    getEntitiesByTag(tagName: string): Iterable<Entity>;
     /**
      * @public
      * @param deltaTime - deltaTime in seconds

package/dist-cjs/index.d.ts

@@ -13,6 +13,7 @@ export * from './engine/entity';
 export * from './components/types';
 import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, AudioSourceComponentDefinitionExtended, AudioStreamComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended, INetowrkEntity, INetowrkParent, VirtualCameraComponentDefinitionExtended, InputModifierComponentDefinitionExtended, LightSourceComponentDefinitionExtended } from './components/types';
 import { NameComponent } from './components/manual/Name';
+import { TagsComponentDefinitionExtended } from './components/manual/Tags';
 export declare const Transform: TransformComponentExtended;
 export declare const Animator: AnimatorComponentDefinitionExtended;
 export declare const AudioSource: AudioSourceComponentDefinitionExtended;
@@ -21,6 +22,7 @@ export declare const Material: MaterialComponentDefinitionExtended;
 export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
 export declare const MeshCollider: MeshColliderComponentDefinitionExtended;
 export declare const Name: NameComponent;
+export declare const Tags: TagsComponentDefinitionExtended;
 export declare const Tween: TweenComponentDefinitionExtended;
 export declare const VirtualCamera: VirtualCameraComponentDefinitionExtended;
 export declare const InputModifier: InputModifierComponentDefinitionExtended;

package/dist-cjs/index.js

@@ -26,7 +26,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NetworkParent = exports.NetworkEntity = exports.SyncComponents = exports.LightSource = exports.InputModifier = exports.VirtualCamera = exports.Tween = exports.Name = exports.MeshCollider = exports.MeshRenderer = exports.Material = exports.AudioStream = exports.AudioSource = exports.Animator = exports.Transform = exports.components = exports.cyclicParentingChecker = void 0;
+exports.NetworkParent = exports.NetworkEntity = exports.SyncComponents = exports.LightSource = exports.InputModifier = exports.VirtualCamera = exports.Tween = exports.Tags = exports.Name = exports.MeshCollider = exports.MeshRenderer = exports.Material = exports.AudioStream = exports.AudioSource = exports.Animator = exports.Transform = exports.components = exports.cyclicParentingChecker = void 0;
 // The order of the following imports matters. Please do not auto-sort
 __exportStar(require("./engine"), exports);
 __exportStar(require("./schemas"), exports);
@@ -55,6 +55,7 @@ exports.Material = components.Material(initialization_1.engine);
 exports.MeshRenderer = components.MeshRenderer(initialization_1.engine);
 exports.MeshCollider = components.MeshCollider(initialization_1.engine);
 exports.Name = components.Name(initialization_1.engine);
+exports.Tags = components.Tags(initialization_1.engine);
 exports.Tween = components.Tween(initialization_1.engine);
 exports.VirtualCamera = components.VirtualCamera(initialization_1.engine);
 exports.InputModifier = components.InputModifier(initialization_1.engine);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dcl/ecs",
   "description": "Decentraland ECS",
-  "version": "7.10.2",
+  "version": "7.10.3-17918694201.commit-b983b3b",
   "author": "DCL",
   "bugs": "https://github.com/decentraland/ecs/issues",
   "files": [
@@ -33,5 +33,5 @@
   },
   "types": "./dist/index.d.ts",
   "typings": "./dist/index.d.ts",
-  "commit": "931de89979b7eca676af3d4e3ccbaa5dcf8ef300"
+  "commit": "b983b3b74a44f323355ad4aed6a0e25504d20eb1"
 }