@dcl/ecs 7.12.2 → 7.12.3-19242573384.commit-09d14b4

package/dist/systems/triggerArea.js

@@ -1,113 +0,0 @@
-import * as components from '../components';
-import { EntityState } from '../engine/entity';
-/**
- * @internal
- */
-export 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) === 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
-    };
-}

package/dist-cjs/components/extended/TriggerArea.d.ts

@@ -1,22 +0,0 @@
-import { Entity, IEngine, LastWriteWinElementSetComponentDefinition } from '../../engine';
-import { ColliderLayer, PBTriggerArea } from '../generated/index.gen';
-/**
- * @public
- */
-export interface TriggerAreaComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBTriggerArea> {
-    /**
-     * @public
-     * Set a box in the MeshCollider component
-     * @param entity - entity to create or replace the TriggerArea component
-     * @param collisionMask - the collision layers mask for the trigger to react, default: Player
-     */
-    setBox(entity: Entity, collisionMask?: ColliderLayer | ColliderLayer[]): void;
-    /**
-     * @public
-     * Set a sphere in the MeshCollider component
-     * @param entity - entity to create or replace the TriggerArea component
-     * @param collisionMask - the collision layers mask for the trigger to react, default: Player
-     */
-    setSphere(entity: Entity, collisionMask?: ColliderLayer | ColliderLayer[]): void;
-}
-export declare function defineTriggerAreaComponent(engine: Pick<IEngine, 'defineComponentFromSchema'>): TriggerAreaComponentDefinitionExtended;

package/dist-cjs/components/extended/TriggerArea.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defineTriggerAreaComponent = void 0;
-const index_gen_1 = require("../generated/index.gen");
-function defineTriggerAreaComponent(engine) {
-    const theComponent = (0, index_gen_1.TriggerArea)(engine);
-    function getCollisionMask(layers) {
-        if (Array.isArray(layers)) {
-            return layers.map((item) => item).reduce((prev, item) => prev | item, 0);
-        }
-        else if (layers) {
-            return layers;
-        }
-    }
-    return {
-        ...theComponent,
-        setBox(entity, collisionMask) {
-            theComponent.createOrReplace(entity, {
-                mesh: 0 /* TriggerAreaMeshType.TAMT_BOX */,
-                collisionMask: getCollisionMask(collisionMask)
-            });
-        },
-        setSphere(entity, collisionMask) {
-            theComponent.createOrReplace(entity, {
-                mesh: 1 /* TriggerAreaMeshType.TAMT_SPHERE */,
-                collisionMask: getCollisionMask(collisionMask)
-            });
-        }
-    };
-}
-exports.defineTriggerAreaComponent = defineTriggerAreaComponent;

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

@@ -1,34 +0,0 @@
-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

@@ -1,39 +0,0 @@
-"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/systems/triggerArea.d.ts

@@ -1,50 +0,0 @@
-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

@@ -1,140 +0,0 @@
-"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;