@dcl/ecs 7.10.2 → 7.10.3-18106625709.commit-1bcaa4a

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.TriggerArea = 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);
@@ -40,6 +40,7 @@ __exportStar(require("./systems/raycast"), exports);
 __exportStar(require("./systems/videoEvents"), exports);
 __exportStar(require("./systems/async-task"), exports);
 __exportStar(require("./systems/tween"), exports);
+__exportStar(require("./systems/triggerArea"), exports);
 __exportStar(require("./engine/entity"), exports);
 __exportStar(require("./components/types"), exports);
 // @internal
@@ -55,10 +56,12 @@ 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);
 exports.LightSource = components.LightSource(initialization_1.engine);
+exports.TriggerArea = components.TriggerArea(initialization_1.engine);
 /**
  * @alpha
  * This is going to be used for sync components through a server.

package/dist-cjs/runtime/initialization/index.d.ts

@@ -9,6 +9,7 @@ import { IInputSystem } from './../../engine/input';
 import { RaycastSystem } from '../../systems/raycast';
 import { VideoEventsSystem } from '../../systems/videoEvents';
 import { TweenSystem } from '../../systems/tween';
+import { TriggerAreaEventsSystem } from '../../systems/triggerArea';
 /**
  * @public
  * The engine is the part of the scene that sits in the middle and manages all of the other parts.
@@ -56,6 +57,12 @@ export { VideoEventsSystem };
  */
 export declare const tweenSystem: TweenSystem;
 export { TweenSystem };
+/**
+ * @public
+ * Register callback functions for trigger area results.
+ */
+export declare const triggerAreaEventsSystem: TriggerAreaEventsSystem;
+export { TriggerAreaEventsSystem };
 /**
  * @public
  * Runs an async function

package/dist-cjs/runtime/initialization/index.js

@@ -4,7 +4,7 @@
  * init and it'll be changing.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.executeTask = exports.tweenSystem = exports.videoEventsSystem = exports.raycastSystem = exports.pointerEventsSystem = exports.inputSystem = exports.engine = void 0;
+exports.executeTask = exports.triggerAreaEventsSystem = exports.tweenSystem = exports.videoEventsSystem = exports.raycastSystem = exports.pointerEventsSystem = exports.inputSystem = exports.engine = void 0;
 const engine_1 = require("../../engine");
 const async_task_1 = require("../../systems/async-task");
 const events_1 = require("../../systems/events");
@@ -13,6 +13,7 @@ const raycast_1 = require("../../systems/raycast");
 const videoEvents_1 = require("../../systems/videoEvents");
 const tween_1 = require("../../systems/tween");
 const pointer_event_collider_checker_1 = require("../../systems/pointer-event-collider-checker");
+const triggerArea_1 = require("../../systems/triggerArea");
 /**
  * @public
  * The engine is the part of the scene that sits in the middle and manages all of the other parts.
@@ -55,6 +56,11 @@ exports.videoEventsSystem = (0, videoEvents_1.createVideoEventsSystem)(exports.e
  * Register callback functions to a particular entity on video events.
  */
 exports.tweenSystem = (0, tween_1.createTweenSystem)(exports.engine);
+/**
+ * @public
+ * Register callback functions for trigger area results.
+ */
+exports.triggerAreaEventsSystem = (0, triggerArea_1.createTriggerAreaEventsSystem)(exports.engine);
 /**
  * Adds pointer event collider system only in DEV env
  */

package/dist-cjs/systems/triggerArea.d.ts

@@ -0,0 +1,50 @@
+import { DeepReadonlyObject, Entity } from '../engine';
+import { PBTriggerAreaResult } from '../components';
+/**
+ * @public
+ */
+export type TriggerAreaEventSystemCallback = (result: DeepReadonlyObject<PBTriggerAreaResult>) => void;
+/**
+ * @public
+ */
+export interface TriggerAreaEventsSystem {
+    /**
+     * @public
+     * Execute callback when an entity enters the Trigger Area
+     * @param entity - The entity that already has the TriggerArea component
+     * @param cb - Function to execute the 'Enter' type of result is detected
+     */
+    onTriggerEnter(entity: Entity, cb: TriggerAreaEventSystemCallback): void;
+    /**
+     * @public
+     * Remove the callback for Trigger Area 'Enter' type of result
+     * @param entity - Entity where the Trigger Area was attached
+     */
+    removeOnTriggerEnter(entity: Entity): void;
+    /**
+     * @public
+     * Execute callback when an entity stays in the Trigger Area
+     * @param entity - The entity that already has the TriggerArea component
+     * @param cb - Function to execute the 'Stay' type of result is detected
+     */
+    onTriggerStay(entity: Entity, cb: TriggerAreaEventSystemCallback): void;
+    /**
+     * @public
+     * Remove the callback for Trigger Area 'Stay' type of result
+     * @param entity - Entity where the Trigger Area was attached
+     */
+    removeOnTriggerStay(entity: Entity): void;
+    /**
+     * @public
+     * Execute callback when an entity exits the Trigger Area
+     * @param entity - The entity that already has the TriggerArea component
+     * @param cb - Function to execute the 'Exit' type of result is detected
+     */
+    onTriggerExit(entity: Entity, cb: TriggerAreaEventSystemCallback): void;
+    /**
+     * @public
+     * Remove the callback for Trigger Area 'Exit' type of result
+     * @param entity - Entity where the Trigger Area was attached
+     */
+    removeOnTriggerExit(entity: Entity): void;
+}

package/dist-cjs/systems/triggerArea.js

@@ -0,0 +1,140 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTriggerAreaEventsSystem = void 0;
+const components = __importStar(require("../components"));
+const entity_1 = require("../engine/entity");
+/**
+ * @internal
+ */
+function createTriggerAreaEventsSystem(engine) {
+    const triggerAreaResultComponent = components.TriggerAreaResult(engine);
+    const entitiesMap = new Map();
+    function hasCallbacksMap(entity) {
+        return entitiesMap.has(entity) && entitiesMap.get(entity) !== undefined;
+    }
+    function addEntityCallback(entity, triggerType, callback) {
+        if (hasCallbacksMap(entity)) {
+            entitiesMap.get(entity).triggerCallbackMap.set(triggerType, callback);
+        }
+        else {
+            entitiesMap.set(entity, {
+                triggerCallbackMap: new Map([[triggerType, callback]]),
+                lastConsumedTimestamp: -1
+            });
+        }
+    }
+    function removeEntityCallback(entity, triggerType) {
+        if (!entitiesMap.has(entity) || !entitiesMap.get(entity).triggerCallbackMap.has(triggerType))
+            return;
+        const triggerCallbackMap = entitiesMap.get(entity).triggerCallbackMap;
+        triggerCallbackMap.delete(triggerType);
+        // Remove entity if no more trigger callbacks are registered
+        if (triggerCallbackMap.size === 0)
+            entitiesMap.delete(entity);
+    }
+    function onTriggerEnter(entity, cb) {
+        addEntityCallback(entity, 0 /* TriggerAreaEventType.TAET_ENTER */, cb);
+    }
+    function removeOnTriggerEnter(entity) {
+        removeEntityCallback(entity, 0 /* TriggerAreaEventType.TAET_ENTER */);
+    }
+    function onTriggerStay(entity, cb) {
+        addEntityCallback(entity, 1 /* TriggerAreaEventType.TAET_STAY */, cb);
+    }
+    function removeOnTriggerStay(entity) {
+        removeEntityCallback(entity, 1 /* TriggerAreaEventType.TAET_STAY */);
+    }
+    function onTriggerExit(entity, cb) {
+        addEntityCallback(entity, 2 /* TriggerAreaEventType.TAET_EXIT */, cb);
+    }
+    function removeOnTriggerExit(entity) {
+        removeEntityCallback(entity, 2 /* TriggerAreaEventType.TAET_EXIT */);
+    }
+    engine.addSystem(function TriggerAreaResultSystem() {
+        const garbageEntries = [];
+        for (const [entity, data] of entitiesMap) {
+            if (engine.getEntityState(entity) === entity_1.EntityState.Removed) {
+                garbageEntries.push(entity);
+                continue;
+            }
+            const result = triggerAreaResultComponent.get(entity);
+            // The Explorer may be taking time before the result component is put
+            if (result.size === 0)
+                continue;
+            const values = Array.from(result.values());
+            // determine starting index for new values (more than one could be added between System updates)
+            // search backwards to find the anchor at lastConsumedTimestamp
+            let startIndex = 0;
+            if (data.lastConsumedTimestamp >= 0) {
+                const newestTimestamp = values[values.length - 1].timestamp;
+                // if nothing new, skip processing
+                if (newestTimestamp <= data.lastConsumedTimestamp) {
+                    continue;
+                }
+                // Find index of value with the lastConsumedTimestamp
+                let i = values.length - 2;
+                while (i >= 0 && values[i].timestamp > data.lastConsumedTimestamp)
+                    i--;
+                // Mark the following value index as the starting point to trigger all the new value callbacks
+                startIndex = i + 1;
+            }
+            if (startIndex >= values.length)
+                continue;
+            // Trigger callbacks for all the new values
+            for (let i = startIndex; i < values.length; i++) {
+                switch (values[i].eventType) {
+                    case 0 /* TriggerAreaEventType.TAET_ENTER */:
+                        if (!data.triggerCallbackMap.has(0 /* TriggerAreaEventType.TAET_ENTER */))
+                            continue;
+                        data.triggerCallbackMap.get(0 /* TriggerAreaEventType.TAET_ENTER */)(values[i]);
+                        break;
+                    case 1 /* TriggerAreaEventType.TAET_STAY */:
+                        if (!data.triggerCallbackMap.has(1 /* TriggerAreaEventType.TAET_STAY */))
+                            continue;
+                        data.triggerCallbackMap.get(1 /* TriggerAreaEventType.TAET_STAY */)(values[i]);
+                        break;
+                    case 2 /* TriggerAreaEventType.TAET_EXIT */:
+                        if (!data.triggerCallbackMap.has(2 /* TriggerAreaEventType.TAET_EXIT */))
+                            continue;
+                        data.triggerCallbackMap.get(2 /* TriggerAreaEventType.TAET_EXIT */)(values[i]);
+                        break;
+                }
+            }
+            data.lastConsumedTimestamp = values[values.length - 1].timestamp;
+        }
+        // Clean up garbage entries
+        garbageEntries.forEach((garbageEntity) => entitiesMap.delete(garbageEntity));
+    });
+    return {
+        onTriggerEnter,
+        removeOnTriggerEnter,
+        onTriggerStay,
+        removeOnTriggerStay,
+        onTriggerExit,
+        removeOnTriggerExit
+    };
+}
+exports.createTriggerAreaEventsSystem = createTriggerAreaEventsSystem;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dcl/ecs",
   "description": "Decentraland ECS",
-  "version": "7.10.2",
+  "version": "7.10.3-18106625709.commit-1bcaa4a",
   "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": "1bcaa4aa66245ab02561c033a0a0651eed1260f3"
 }