@dcl/ecs 7.13.0 → 7.13.1-19516109426.commit-e1e79aa

package/dist-cjs/systems/events.js

@@ -45,6 +45,9 @@ function createPointerEventsSystem(engine, inputSystem) {
         EventType[EventType["Up"] = 2] = "Up";
         EventType[EventType["HoverEnter"] = 3] = "HoverEnter";
         EventType[EventType["HoverLeave"] = 4] = "HoverLeave";
+        EventType[EventType["Drag"] = 5] = "Drag";
+        EventType[EventType["DragLocked"] = 6] = "DragLocked";
+        EventType[EventType["DragEnd"] = 7] = "DragEnd";
     })(EventType || (EventType = {}));
     const eventsMap = new Map();
     function getEvent(entity) {
@@ -79,77 +82,148 @@ function createPointerEventsSystem(engine, inputSystem) {
         else if (eventType === EventType.HoverEnter) {
             return 2 /* PointerEventType.PET_HOVER_ENTER */;
         }
+        else if (eventType === EventType.Drag) {
+            return 5 /* PointerEventType.PET_DRAG */;
+        }
+        else if (eventType === EventType.DragLocked) {
+            return 4 /* PointerEventType.PET_DRAG_LOCKED */;
+        }
+        else if (eventType === EventType.DragEnd) {
+            return 6 /* PointerEventType.PET_DRAG_END */;
+        }
         return 1 /* PointerEventType.PET_DOWN */;
     }
+    function getEventType(pet) {
+        if (pet === 0 /* PointerEventType.PET_UP */) {
+            return EventType.Up;
+        }
+        else if (pet === 2 /* PointerEventType.PET_HOVER_ENTER */) {
+            return EventType.HoverEnter;
+        }
+        else if (pet === 3 /* PointerEventType.PET_HOVER_LEAVE */) {
+            return EventType.HoverLeave;
+        }
+        else if (pet === 5 /* PointerEventType.PET_DRAG */) {
+            return EventType.Drag;
+        }
+        else if (pet === 4 /* PointerEventType.PET_DRAG_LOCKED */) {
+            return EventType.DragLocked;
+        }
+        else if (pet === 6 /* PointerEventType.PET_DRAG_END */) {
+            return EventType.DragEnd;
+        }
+        else {
+            return EventType.Down;
+        }
+    }
     function removeEvent(entity, type) {
         const event = getEvent(entity);
-        const pointerEvent = event.get(type);
-        if (pointerEvent?.opts.hoverText) {
-            removePointerEvent(entity, getPointerEvent(type), pointerEvent.opts.button);
+        const pointerEventList = event.get(type);
+        if (pointerEventList === undefined) {
+            return;
+        }
+        for (const button of pointerEventList.keys()) {
+            removePointerEvent(entity, getPointerEvent(type), button);
         }
         event.delete(type);
     }
     engine.addSystem(function EventSystem() {
-        for (const [entity, event] of eventsMap) {
+        if (eventsMap.size === 0) {
+            return;
+        }
+        for (const entity of eventsMap.keys()) {
             if (engine.getEntityState(entity) === entity_1.EntityState.Removed) {
                 eventsMap.delete(entity);
+            }
+        }
+        for (const command of inputSystem.getInputCommands()) {
+            const entity = command.hit?.entityId;
+            if (entity === undefined) {
+                continue;
+            }
+            const entityMap = eventsMap.get(entity);
+            if (entityMap === undefined) {
                 continue;
             }
-            for (const [eventType, { cb, opts }] of event) {
-                if (eventType === EventType.Click) {
-                    const command = inputSystem.getClick(opts.button, entity);
-                    if (command)
-                        (0, invariant_1.checkNotThenable)(cb(command.up), 'Click event returned a thenable. Only synchronous functions are allowed');
+            const typeMap = entityMap.get(getEventType(command.state));
+            if (typeMap) {
+                const data = typeMap.get(command.button);
+                if (data) {
+                    (0, invariant_1.checkNotThenable)(data.cb(command), 'Event handler returned a thenable. Only synchronous functions are allowed');
                 }
-                if (eventType === EventType.Down ||
-                    eventType === EventType.Up ||
-                    eventType === EventType.HoverEnter ||
-                    eventType === EventType.HoverLeave) {
-                    const command = inputSystem.getInputCommand(opts.button, getPointerEvent(eventType), entity);
-                    if (command) {
-                        (0, invariant_1.checkNotThenable)(cb(command), 'Event handler returned a thenable. Only synchronous functions are allowed');
+                const anyData = typeMap.get(3 /* InputAction.IA_ANY */);
+                if (anyData) {
+                    (0, invariant_1.checkNotThenable)(anyData.cb(command), 'Event handler returned a thenable. Only synchronous functions are allowed');
+                }
+            }
+            // check clicks separately
+            if (command.state === 0 /* PointerEventType.PET_UP */) {
+                const clickMap = entityMap.get(EventType.Click);
+                if (clickMap) {
+                    const data = clickMap.get(command.button);
+                    if (data && inputSystem.getClick(command.button, entity)) {
+                        (0, invariant_1.checkNotThenable)(data.cb(command), 'Click event returned a thenable. Only synchronous functions are allowed');
+                    }
+                    const anyData = clickMap.get(3 /* InputAction.IA_ANY */);
+                    if (anyData && inputSystem.getClick(command.button, entity)) {
+                        (0, invariant_1.checkNotThenable)(anyData.cb(command), 'Event handler returned a thenable. Only synchronous functions are allowed');
                     }
                 }
             }
         }
     });
-    const onPointerDown = (...args) => {
-        const [data, cb, maybeOpts] = args;
-        if (typeof data === 'number') {
-            return onPointerDown({ entity: data, opts: maybeOpts ?? {} }, cb);
-        }
-        const { entity, opts } = data;
-        const options = (0, exports.getDefaultOpts)(opts);
-        removeEvent(entity, EventType.Down);
-        getEvent(entity).set(EventType.Down, { cb, opts: options });
-        setPointerEvent(entity, 1 /* PointerEventType.PET_DOWN */, options);
-    };
-    const onPointerUp = (...args) => {
-        const [data, cb, maybeOpts] = args;
-        if (typeof data === 'number') {
-            return onPointerUp({ entity: data, opts: maybeOpts ?? {} }, cb);
-        }
-        const { entity, opts } = data;
-        const options = (0, exports.getDefaultOpts)(opts);
-        removeEvent(entity, EventType.Up);
-        getEvent(entity).set(EventType.Up, { cb, opts: options });
-        setPointerEvent(entity, 0 /* PointerEventType.PET_UP */, options);
-    };
-    const onPointerHoverEnter = (...args) => {
-        const [data, cb] = args;
-        const { entity, opts } = data;
-        const options = (0, exports.getDefaultOpts)(opts);
-        removeEvent(entity, EventType.HoverEnter);
-        getEvent(entity).set(EventType.HoverEnter, { cb, opts: options });
-        setPointerEvent(entity, 2 /* PointerEventType.PET_HOVER_ENTER */, options);
-    };
-    const onPointerHoverLeave = (...args) => {
-        const [data, cb] = args;
-        const { entity, opts } = data;
-        const options = (0, exports.getDefaultOpts)(opts);
-        removeEvent(entity, EventType.HoverLeave);
-        getEvent(entity).set(EventType.HoverLeave, { cb, opts: options });
-        setPointerEvent(entity, 3 /* PointerEventType.PET_HOVER_LEAVE */, options);
+    // return a function with the correct event type.
+    // we use onPointerDown as the "archetype" for the returned function, but it fits with
+    // all the onPointer* declarations
+    const onPointerFunction = (ty) => {
+        return (arg0, arg1, arg2) => {
+            let entity;
+            let optsList;
+            if (typeof arg0 === 'number') {
+                // called as onPointerDown(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions>): void
+                entity = arg0;
+                const cb = arg1;
+                const opts = arg2;
+                optsList = [{ cb, ...(0, exports.getDefaultOpts)(opts) }];
+            }
+            else if (typeof arg1 === 'function') {
+                // called as onPointerDown(pointerData: { entity: Entity; opts?: Partial<EventSystemOptions> }, cb: EventSystemCallback): void
+                const { entity: e, opts } = arg0;
+                const cb = arg1;
+                entity = e;
+                optsList = [{ cb, ...(0, exports.getDefaultOpts)(opts) }];
+            }
+            else {
+                // called as onPointerDown(pointerData: { entity: Entity; optsList: EventSystemOptionsCallback[] }): void
+                const { entity: e, optsList: o } = arg0;
+                entity = e;
+                optsList = o;
+            }
+            const previous = getEvent(entity).get(ty) ?? new Map();
+            const callbacks = new Map();
+            for (const opts of optsList) {
+                const prevOpts = previous.get(opts.button);
+                if (prevOpts !== undefined) {
+                    if (prevOpts.hoverText !== opts.hoverText ||
+                        prevOpts.maxDistance !== opts.maxDistance ||
+                        prevOpts.showFeedback !== opts.showFeedback ||
+                        prevOpts.showHighlight !== opts.showHighlight) {
+                        removePointerEvent(entity, getPointerEvent(ty), opts.button);
+                        setPointerEvent(entity, getPointerEvent(ty), opts);
+                    }
+                }
+                else {
+                    setPointerEvent(entity, getPointerEvent(ty), opts);
+                }
+                callbacks.set(opts.button, opts);
+            }
+            for (const button of previous.keys()) {
+                if (!callbacks.has(button)) {
+                    removePointerEvent(entity, getPointerEvent(ty), button);
+                }
+            }
+            getEvent(entity).set(ty, callbacks);
+        };
     };
     return {
         removeOnClick(entity) {
@@ -167,19 +241,23 @@ function createPointerEventsSystem(engine, inputSystem) {
         removeOnPointerHoverLeave(entity) {
             removeEvent(entity, EventType.HoverLeave);
         },
-        onClick(value, cb) {
-            const { entity } = value;
-            const options = (0, exports.getDefaultOpts)(value.opts);
-            // Clear previous event with over feedback included
-            removeEvent(entity, EventType.Click);
-            // Set new event
-            getEvent(entity).set(EventType.Click, { cb, opts: options });
-            setPointerEvent(entity, 1 /* PointerEventType.PET_DOWN */, options);
+        removeOnPointerDrag(entity) {
+            removeEvent(entity, EventType.Drag);
+        },
+        removeOnPointerDragLocked(entity) {
+            removeEvent(entity, EventType.DragLocked);
+        },
+        removeOnPointerDragEnd(entity) {
+            removeEvent(entity, EventType.DragEnd);
         },
-        onPointerDown,
-        onPointerUp,
-        onPointerHoverEnter,
-        onPointerHoverLeave
+        onClick: onPointerFunction(EventType.Click),
+        onPointerDown: onPointerFunction(EventType.Down),
+        onPointerUp: onPointerFunction(EventType.Up),
+        onPointerHoverEnter: onPointerFunction(EventType.HoverEnter),
+        onPointerHoverLeave: onPointerFunction(EventType.HoverLeave),
+        onPointerDrag: onPointerFunction(EventType.Drag),
+        onPointerDragLocked: onPointerFunction(EventType.DragLocked),
+        onPointerDragEnd: onPointerFunction(EventType.DragEnd)
     };
 }
 exports.createPointerEventsSystem = createPointerEventsSystem;

package/dist-cjs/systems/tween.js

@@ -47,16 +47,16 @@ function createTweenSystem(engine) {
         const tweenState = TweenState.getOrNull(entity);
         const tween = Tween.getOrNull(entity);
         const tweenCache = cache.get(entity);
-        if (!tweenState || !tween || !tweenCache)
+        if (!tweenState || !tween)
             return false;
         /* istanbul ignore next */
         if (
         // Renderer notified that the tween is completed
-        // Only consider it completed if the tween hasn't changed this frame (to avoid false positives after YOYO/sequence processing)
-        ((tweenState.state === 1 /* TweenStateStatus.TS_COMPLETED */ && !tweenCache.changed) ||
-            (tweenChanged(entity) && !tweenCache.changed)) &&
+        (tweenChanged(entity) || tweenState.state === 1 /* TweenStateStatus.TS_COMPLETED */) &&
             // Avoid sending isCompleted multiple times
-            !tweenCache.completed) {
+            !tweenCache?.completed &&
+            // Amount of frames needed to consider a tween completed
+            (tweenCache?.frames ?? 0) > 2) {
             return true;
         }
         return false;
@@ -68,111 +68,86 @@ function createTweenSystem(engine) {
         if ((currentTween && !prevTween) || (!currentTween && prevTween)) {
             return true;
         }
-        if (!currentTween || !prevTween)
-            return false;
         const currentBuff = new ByteBuffer_1.ReadWriteByteBuffer();
         Tween.schema.serialize(currentTween, currentBuff);
-        const compareResult = (0, utils_1.dataCompare)(currentBuff.toBinary(), prevTween);
-        return compareResult !== 0;
+        const equal = (0, utils_1.dataCompare)(currentBuff.toBinary(), prevTween);
+        return equal;
     }
-    // System to manage cache (needed for tweenSystem.tweenCompleted() to work)
+    const restartTweens = [];
+    // Logic for sequence tweens
     engine.addSystem(() => {
+        for (const restart of restartTweens) {
+            restart();
+        }
+        restartTweens.length = 0;
         for (const [entity, tween] of engine.getEntitiesWith(Tween)) {
             if (tweenChanged(entity)) {
                 const buffer = new ByteBuffer_1.ReadWriteByteBuffer();
                 Tween.schema.serialize(tween, buffer);
                 cache.set(entity, {
                     tween: buffer.toBinary(),
+                    frames: 0,
                     completed: false,
                     changed: true
                 });
                 continue;
             }
             const tweenCache = cache.get(entity);
-            if (tweenCache) {
-                tweenCache.changed = false;
-                if (isCompleted(entity)) {
-                    // set the tween completed to avoid calling this again for the same tween
-                    tweenCache.completed = true;
+            tweenCache.frames += 1;
+            tweenCache.changed = false;
+            if (isCompleted(entity)) {
+                // Reset tween frames.
+                tweenCache.frames = 0;
+                // set the tween completed to avoid calling this again for the same tween
+                tweenCache.completed = true;
+                const tweenSequence = TweenSequence.getOrNull(entity);
+                if (!tweenSequence)
+                    continue;
+                const { sequence } = tweenSequence;
+                if (sequence && sequence.length) {
+                    const [nextTweenSequence, ...otherTweens] = sequence;
+                    Tween.createOrReplace(entity, nextTweenSequence);
+                    const mutableTweenHelper = TweenSequence.getMutable(entity);
+                    mutableTweenHelper.sequence = otherTweens;
+                    if (tweenSequence.loop === 0 /* TweenLoop.TL_RESTART */) {
+                        mutableTweenHelper.sequence.push(tween);
+                    }
+                }
+                else if (tweenSequence.loop === 1 /* TweenLoop.TL_YOYO */) {
+                    Tween.createOrReplace(entity, backwardsTween(tween));
+                }
+                else if (tweenSequence.loop === 0 /* TweenLoop.TL_RESTART */) {
+                    Tween.deleteFrom(entity);
+                    cache.delete(entity);
+                    restartTweens.push(() => {
+                        Tween.createOrReplace(entity, tween);
+                    });
                 }
             }
         }
     }, Number.NEGATIVE_INFINITY);
-    function initializeTweenSequenceSystem() {
-        const restartTweens = [];
-        function backwardsTween(tween) {
-            if (tween.mode?.$case === 'move' && tween.mode.move) {
-                return { ...tween, mode: { ...tween.mode, move: { start: tween.mode.move.end, end: tween.mode.move.start } } };
-            }
-            if (tween.mode?.$case === 'rotate' && tween.mode.rotate) {
-                return {
-                    ...tween,
-                    mode: { ...tween.mode, rotate: { start: tween.mode.rotate.end, end: tween.mode.rotate.start } }
-                };
-            }
-            if (tween.mode?.$case === 'scale' && tween.mode.scale) {
-                return { ...tween, mode: { ...tween.mode, scale: { start: tween.mode.scale.end, end: tween.mode.scale.start } } };
-            }
-            if (tween.mode?.$case === 'textureMove' && tween.mode.textureMove) {
-                return {
-                    ...tween,
-                    mode: { ...tween.mode, textureMove: { start: tween.mode.textureMove.end, end: tween.mode.textureMove.start } }
-                };
-            }
-            /* istanbul ignore next */
-            throw new Error('Invalid tween');
+    function backwardsTween(tween) {
+        if (tween.mode?.$case === 'move' && tween.mode.move) {
+            return { ...tween, mode: { ...tween.mode, move: { start: tween.mode.move.end, end: tween.mode.move.start } } };
         }
-        // Logic for sequence tweens
-        engine.addSystem(() => {
-            for (const restart of restartTweens) {
-                restart();
-            }
-            restartTweens.length = 0;
-            for (const [entity, tween] of engine.getEntitiesWith(Tween)) {
-                const tweenCache = cache.get(entity);
-                if (!tweenCache)
-                    continue;
-                // Only process tween sequences if the tween is completed
-                if (tweenCache.completed) {
-                    const tweenSequence = TweenSequence.getOrNull(entity);
-                    if (!tweenSequence)
-                        continue;
-                    const { sequence } = tweenSequence;
-                    if (sequence && sequence.length) {
-                        const [nextTweenSequence, ...otherTweens] = sequence;
-                        Tween.createOrReplace(entity, nextTweenSequence);
-                        const mutableTweenHelper = TweenSequence.getMutable(entity);
-                        mutableTweenHelper.sequence = otherTweens;
-                        if (tweenSequence.loop === 0 /* TweenLoop.TL_RESTART */) {
-                            mutableTweenHelper.sequence.push(tween);
-                        }
-                        // Reset completed flag for the next tween in sequence
-                        // Mark as changed so the cache system will detect the change and reset the cache properly
-                        tweenCache.completed = false;
-                        tweenCache.changed = true;
-                    }
-                    else if (tweenSequence.loop === 1 /* TweenLoop.TL_YOYO */) {
-                        Tween.createOrReplace(entity, backwardsTween(tween));
-                        // Reset completed flag for the backwards tween
-                        // Mark as changed so the cache system will detect the change and reset the cache properly
-                        tweenCache.completed = false;
-                        tweenCache.changed = true;
-                    }
-                    else if (tweenSequence.loop === 0 /* TweenLoop.TL_RESTART */) {
-                        Tween.deleteFrom(entity);
-                        cache.delete(entity);
-                        restartTweens.push(() => {
-                            Tween.createOrReplace(entity, tween);
-                        });
-                    }
-                }
-            }
-        }, Number.NEGATIVE_INFINITY);
+        if (tween.mode?.$case === 'rotate' && tween.mode.rotate) {
+            return {
+                ...tween,
+                mode: { ...tween.mode, rotate: { start: tween.mode.rotate.end, end: tween.mode.rotate.start } }
+            };
+        }
+        if (tween.mode?.$case === 'scale' && tween.mode.scale) {
+            return { ...tween, mode: { ...tween.mode, scale: { start: tween.mode.scale.end, end: tween.mode.scale.start } } };
+        }
+        if (tween.mode?.$case === 'textureMove' && tween.mode.textureMove) {
+            return {
+                ...tween,
+                mode: { ...tween.mode, textureMove: { start: tween.mode.textureMove.end, end: tween.mode.textureMove.start } }
+            };
+        }
+        /* istanbul ignore next */
+        throw new Error('Invalid tween');
     }
-    // Some Explorers may not inject the flag and TweenSequence logic must be enabled in that case
-    const enableTweenSequenceLogic = globalThis.ENABLE_SDK_TWEEN_SEQUENCE;
-    if (enableTweenSequenceLogic !== false)
-        initializeTweenSequenceSystem();
     const tweenSystem = {
         // This event is fired only once per tween
         tweenCompleted: isCompleted

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dcl/ecs",
   "description": "Decentraland ECS",
-  "version": "7.13.0",
+  "version": "7.13.1-19516109426.commit-e1e79aa",
   "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": "7df9c3029b7e9d824a41fdecdd9f63024b16e25b"
+  "commit": "e1e79aa4c353b3698cf182659d0110ef3eb2e68f"
 }