@dcl/ecs 7.3.20 → 7.3.21-6483018672.commit-3538b47

package/dist-cjs/components/generated/pb/decentraland/sdk/components/tween_state.gen.js

@@ -0,0 +1,65 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PBTweenState = exports.TweenStateStatus = void 0;
+/* eslint-disable */
+const minimal_1 = __importDefault(require("protobufjs/minimal"));
+const protobufPackageSarasa = "decentraland.sdk.components";
+/**
+ * @public
+ */
+var TweenStateStatus;
+(function (TweenStateStatus) {
+    TweenStateStatus[TweenStateStatus["TS_ACTIVE"] = 0] = "TS_ACTIVE";
+    TweenStateStatus[TweenStateStatus["TS_COMPLETED"] = 1] = "TS_COMPLETED";
+    TweenStateStatus[TweenStateStatus["TS_PAUSED"] = 2] = "TS_PAUSED";
+})(TweenStateStatus = exports.TweenStateStatus || (exports.TweenStateStatus = {}));
+function createBasePBTweenState() {
+    return { state: 0, currentTime: 0 };
+}
+/**
+ * @public
+ */
+var PBTweenState;
+(function (PBTweenState) {
+    function encode(message, writer = minimal_1.default.Writer.create()) {
+        if (message.state !== 0) {
+            writer.uint32(8).int32(message.state);
+        }
+        if (message.currentTime !== 0) {
+            writer.uint32(21).float(message.currentTime);
+        }
+        return writer;
+    }
+    PBTweenState.encode = encode;
+    function decode(input, length) {
+        const reader = input instanceof minimal_1.default.Reader ? input : minimal_1.default.Reader.create(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBasePBTweenState();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag !== 8) {
+                        break;
+                    }
+                    message.state = reader.int32();
+                    continue;
+                case 2:
+                    if (tag !== 21) {
+                        break;
+                    }
+                    message.currentTime = reader.float();
+                    continue;
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    }
+    PBTweenState.decode = decode;
+})(PBTweenState = exports.PBTweenState || (exports.PBTweenState = {}));

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

@@ -1,4 +1,4 @@
-export type { Position as PBPosition, Vector2 as PBVector2, Vector3 as PBVector3 } from './pb/decentraland/common/vectors.gen';
+export type { Position as PBPosition, Vector2 as PBVector2, Vector3 as PBVector3, Quaternion as PBQuaternion } from './pb/decentraland/common/vectors.gen';
 export type { Color3 as PBColor3, Color4 as PBColor4 } from './pb/decentraland/common/colors.gen';
 export * from './pb/decentraland/sdk/components/common/camera_type.gen';
 export * from './pb/decentraland/sdk/components/common/input_action.gen';

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

@@ -4,6 +4,7 @@ import { AnimatorComponentDefinitionExtended } from './extended/Animator';
 import { MaterialComponentDefinitionExtended } from './extended/Material';
 import { MeshColliderComponentDefinitionExtended } from './extended/MeshCollider';
 import { MeshRendererComponentDefinitionExtended } from './extended/MeshRenderer';
+import { TweenComponentDefinitionExtended } from './extended/Tween';
 import { LwwComponentGetter, GSetComponentGetter } from './generated/index.gen';
 import { NameType } from './manual/Name';
 import { ISyncComponentsType } from './manual/SyncComponents';
@@ -15,6 +16,7 @@ export declare const Material: LwwComponentGetter<MaterialComponentDefinitionExt
 export declare const Animator: LwwComponentGetter<AnimatorComponentDefinitionExtended>;
 export declare const MeshRenderer: LwwComponentGetter<MeshRendererComponentDefinitionExtended>;
 export declare const MeshCollider: LwwComponentGetter<MeshColliderComponentDefinitionExtended>;
+export declare const Tween: LwwComponentGetter<TweenComponentDefinitionExtended>;
 /**
  * @alpha
  */

package/dist-cjs/components/index.js

@@ -17,11 +17,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SyncComponents = exports.Name = exports.MeshCollider = exports.MeshRenderer = exports.Animator = exports.Material = exports.Transform = void 0;
+exports.SyncComponents = exports.Name = exports.Tween = exports.MeshCollider = exports.MeshRenderer = exports.Animator = exports.Material = exports.Transform = void 0;
 const Animator_1 = require("./extended/Animator");
 const Material_1 = require("./extended/Material");
 const MeshCollider_1 = require("./extended/MeshCollider");
 const MeshRenderer_1 = require("./extended/MeshRenderer");
+const Tween_1 = require("./extended/Tween");
 const Name_1 = __importDefault(require("./manual/Name"));
 const SyncComponents_1 = __importDefault(require("./manual/SyncComponents"));
 const Transform_1 = require("./manual/Transform");
@@ -41,6 +42,9 @@ exports.MeshRenderer = MeshRenderer;
 /* @__PURE__ */
 const MeshCollider = (engine) => (0, MeshCollider_1.defineMeshColliderComponent)(engine);
 exports.MeshCollider = MeshCollider;
+/* @__PURE__ */
+const Tween = (engine) => (0, Tween_1.defineTweenComponent)(engine);
+exports.Tween = Tween;
 /**
  * @alpha
  */

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

@@ -2,6 +2,7 @@ export type { AnimatorComponentDefinitionExtended } from './extended/Animator';
 export type { MeshRendererComponentDefinitionExtended } from './extended/MeshRenderer';
 export type { MeshColliderComponentDefinitionExtended } from './extended/MeshCollider';
 export type { TextureHelper, MaterialComponentDefinitionExtended } from './extended/Material';
+export type { TweenHelper, TweenComponentDefinitionExtended } from './extended/Tween';
 export type { TransformComponentExtended, TransformTypeWithOptionals } from './manual/Transform';
 export type { NameComponent, NameType } from './manual/Name';
 export type { ISyncComponents, ISyncComponentsType } from './manual/SyncComponents';

package/dist-cjs/index.d.ts

@@ -10,7 +10,7 @@ export * from './systems/videoEvents';
 export * from './systems/async-task';
 export * from './engine/entity';
 export * from './components/types';
-import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, ISyncComponents } from './components/types';
+import { MaterialComponentDefinitionExtended, MeshColliderComponentDefinitionExtended, MeshRendererComponentDefinitionExtended, TransformComponentExtended, AnimatorComponentDefinitionExtended, ISyncComponents, TweenComponentDefinitionExtended } from './components/types';
 import { NameComponent } from './components/manual/Name';
 export declare const Transform: TransformComponentExtended;
 export declare const Animator: AnimatorComponentDefinitionExtended;
@@ -18,6 +18,7 @@ export declare const Material: MaterialComponentDefinitionExtended;
 export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
 export declare const MeshCollider: MeshColliderComponentDefinitionExtended;
 export declare const Name: NameComponent;
+export declare const Tween: TweenComponentDefinitionExtended;
 /**
  * @alpha
  * This is going to be used for sync components through a server.

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.SyncComponents = exports.Name = exports.MeshCollider = exports.MeshRenderer = exports.Material = exports.Animator = exports.Transform = exports.components = exports.cyclicParentingChecker = void 0;
+exports.SyncComponents = exports.Tween = exports.Name = exports.MeshCollider = exports.MeshRenderer = exports.Material = 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);
@@ -52,6 +52,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.Tween = components.Tween(initialization_1.engine);
 /**
  * @alpha
  * This is going to be used for sync components through a server.

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

@@ -8,6 +8,7 @@ import { PointerEventsSystem } from '../../systems/events';
 import { IInputSystem } from './../../engine/input';
 import { RaycastSystem } from '../../systems/raycast';
 import { VideoEventsSystem } from '../../systems/videoEvents';
+import { TweenSystem } from '../../systems/tween';
 /**
  * @public
  * The engine is the part of the scene that sits in the middle and manages all of the other parts.
@@ -44,12 +45,17 @@ export { PointerEventsSystem };
 export declare const raycastSystem: RaycastSystem;
 export { RaycastSystem };
 /**
- * @alpha
  * @public
  * Register callback functions to a particular entity on video events.
  */
 export declare const videoEventsSystem: VideoEventsSystem;
 export { VideoEventsSystem };
+/**
+ * @public
+ * Register callback functions to a particular entity on video events.
+ */
+export declare const tweenSystem: TweenSystem;
+export { TweenSystem };
 /**
  * @public
  * Runs an async function

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

@@ -4,13 +4,14 @@
  * init and it'll be changing.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.executeTask = exports.videoEventsSystem = exports.raycastSystem = exports.pointerEventsSystem = exports.inputSystem = exports.engine = void 0;
+exports.executeTask = 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");
 const input_1 = require("./../../engine/input");
 const raycast_1 = require("../../systems/raycast");
 const videoEvents_1 = require("../../systems/videoEvents");
+const tween_1 = require("../../systems/tween");
 /**
  * @public
  * The engine is the part of the scene that sits in the middle and manages all of the other parts.
@@ -44,11 +45,15 @@ exports.pointerEventsSystem = (0, events_1.createPointerEventsSystem)(exports.en
  */
 exports.raycastSystem = (0, raycast_1.createRaycastSystem)(exports.engine);
 /**
- * @alpha
  * @public
  * Register callback functions to a particular entity on video events.
  */
 exports.videoEventsSystem = (0, videoEvents_1.createVideoEventsSystem)(exports.engine);
+/**
+ * @public
+ * Register callback functions to a particular entity on video events.
+ */
+exports.tweenSystem = (0, tween_1.createTweenSystem)(exports.engine);
 /**
  * @public
  * Runs an async function

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

@@ -0,0 +1,4 @@
+import { Entity } from '../engine';
+export type TweenSystem = {
+    tweenCompleted(entity: Entity): boolean;
+};

package/dist-cjs/systems/tween.js

@@ -0,0 +1,143 @@
+"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.createTweenSystem = void 0;
+const components = __importStar(require("../components"));
+const ByteBuffer_1 = require("../serialization/ByteBuffer");
+const utils_1 = require("./crdt/utils");
+/**
+ * @internal
+ * @returns tween helper to be used on the scene
+ */
+function createTweenSystem(engine) {
+    const Tween = components.Tween(engine);
+    const TweenState = components.TweenState(engine);
+    const TweenSequence = components.TweenSequence(engine);
+    const cache = new Map();
+    function isCompleted(entity) {
+        const tweenState = TweenState.getOrNull(entity);
+        const tween = Tween.getOrNull(entity);
+        const tweenCache = cache.get(entity);
+        if (!tweenState || !tween)
+            return false;
+        /* istanbul ignore next */
+        if (
+        // Renderer notified that the tween is completed
+        (tweenChanged(entity) || tweenState.state === 1 /* TweenStateStatus.TS_COMPLETED */) &&
+            // Avoid sending isCompleted multiple times
+            !tweenCache?.completed &&
+            // Amount of frames needed to consider a tween completed
+            (tweenCache?.frames ?? 0) > 2) {
+            return true;
+        }
+        return false;
+    }
+    function tweenChanged(entity) {
+        const currentTween = Tween.getOrNull(entity);
+        const prevTween = cache.get(entity)?.tween;
+        /* istanbul ignore next */
+        if ((currentTween && !prevTween) || (!currentTween && prevTween)) {
+            return true;
+        }
+        const currentBuff = new ByteBuffer_1.ReadWriteByteBuffer();
+        Tween.schema.serialize(currentTween, currentBuff);
+        const equal = (0, utils_1.dataCompare)(currentBuff.toBinary(), prevTween);
+        return equal;
+    }
+    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);
+            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 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 } } };
+        }
+        /* istanbul ignore next */
+        throw new Error('Invalid tween');
+    }
+    return {
+        // This event is fired only once per tween
+        tweenCompleted: isCompleted
+    };
+}
+exports.createTweenSystem = createTweenSystem;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dcl/ecs",
   "description": "Decentraland ECS",
-  "version": "7.3.20",
+  "version": "7.3.21-6483018672.commit-3538b47",
   "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": "658c448fba75b237f5b565d6d04cc85f579ba0fd"
+  "commit": "3538b47686f539bfb09756a15d11c06a90c770ed"
 }