@dcl/ecs 7.20.0 → 7.20.1-21915113771.commit-e132905

package/dist-cjs/components/generated/pb/decentraland/sdk/components/ui_transform.gen.d.ts

@@ -1,5 +1,6 @@
 import _m0 from "protobufjs/minimal";
 import { Color4 } from "../../common/colors.gen";
+import { Vector2 } from "../../common/vectors.gen";
 /**
  * @public
  */
@@ -93,6 +94,27 @@ export declare const enum PointerFilterMode {
     PFM_NONE = 0,
     PFM_BLOCK = 1
 }
+/**
+ * @public
+ */
+export declare const enum ShowScrollBar {
+    SSB_BOTH = 0,
+    SSB_ONLY_VERTICAL = 1,
+    SSB_ONLY_HORIZONTAL = 2,
+    SSB_HIDDEN = 3
+}
+/**
+ * @public
+ */
+export interface ScrollPositionValue {
+    value?: {
+        $case: "position";
+        position: Vector2;
+    } | {
+        $case: "reference";
+        reference: string;
+    } | undefined;
+}
 /**
  * @public
  */
@@ -210,9 +232,22 @@ export interface PBUiTransform {
     borderRightColor?: Color4 | undefined;
     /** default: 1 */
     opacity?: number | undefined;
+    /** reference for scroll_position. default empty */
+    elementId?: string | undefined;
+    /** default position=(0,0) */
+    scrollPosition?: ScrollPositionValue | undefined;
+    /** default ShowScrollBar.SSB_BOTH */
+    scrollVisible?: ShowScrollBar | undefined;
     /** default: 0 — controls render stacking order. Higher values appear in front of lower values. */
     zIndex?: number | undefined;
 }
+/**
+ * @public
+ */
+export declare namespace ScrollPositionValue {
+    function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
+    function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
+}
 /**
  * @public
  */

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

@@ -3,10 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PBUiTransform = exports.PointerFilterMode = exports.YGEdge = exports.YGDisplay = exports.YGOverflow = exports.YGJustify = exports.YGWrap = exports.YGFlexDirection = exports.YGUnit = exports.YGAlign = exports.YGPositionType = void 0;
+exports.PBUiTransform = exports.ScrollPositionValue = exports.ShowScrollBar = exports.PointerFilterMode = exports.YGEdge = exports.YGDisplay = exports.YGOverflow = exports.YGJustify = exports.YGWrap = exports.YGFlexDirection = exports.YGUnit = exports.YGAlign = exports.YGPositionType = void 0;
 /* eslint-disable */
 const minimal_1 = __importDefault(require("protobufjs/minimal"));
 const colors_gen_1 = require("../../common/colors.gen");
+const vectors_gen_1 = require("../../common/vectors.gen");
 const protobufPackageSarasa = "decentraland.sdk.components";
 /**
  * @public
@@ -111,6 +112,65 @@ var PointerFilterMode;
     PointerFilterMode[PointerFilterMode["PFM_NONE"] = 0] = "PFM_NONE";
     PointerFilterMode[PointerFilterMode["PFM_BLOCK"] = 1] = "PFM_BLOCK";
 })(PointerFilterMode = exports.PointerFilterMode || (exports.PointerFilterMode = {}));
+/**
+ * @public
+ */
+var ShowScrollBar;
+(function (ShowScrollBar) {
+    ShowScrollBar[ShowScrollBar["SSB_BOTH"] = 0] = "SSB_BOTH";
+    ShowScrollBar[ShowScrollBar["SSB_ONLY_VERTICAL"] = 1] = "SSB_ONLY_VERTICAL";
+    ShowScrollBar[ShowScrollBar["SSB_ONLY_HORIZONTAL"] = 2] = "SSB_ONLY_HORIZONTAL";
+    ShowScrollBar[ShowScrollBar["SSB_HIDDEN"] = 3] = "SSB_HIDDEN";
+})(ShowScrollBar = exports.ShowScrollBar || (exports.ShowScrollBar = {}));
+function createBaseScrollPositionValue() {
+    return { value: undefined };
+}
+/**
+ * @public
+ */
+var ScrollPositionValue;
+(function (ScrollPositionValue) {
+    function encode(message, writer = minimal_1.default.Writer.create()) {
+        switch (message.value?.$case) {
+            case "position":
+                vectors_gen_1.Vector2.encode(message.value.position, writer.uint32(10).fork()).ldelim();
+                break;
+            case "reference":
+                writer.uint32(18).string(message.value.reference);
+                break;
+        }
+        return writer;
+    }
+    ScrollPositionValue.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 = createBaseScrollPositionValue();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.value = { $case: "position", position: vectors_gen_1.Vector2.decode(reader, reader.uint32()) };
+                    continue;
+                case 2:
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.value = { $case: "reference", reference: reader.string() };
+                    continue;
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    }
+    ScrollPositionValue.decode = decode;
+})(ScrollPositionValue = exports.ScrollPositionValue || (exports.ScrollPositionValue = {}));
 function createBasePBUiTransform() {
     return {
         parent: 0,
@@ -186,6 +246,9 @@ function createBasePBUiTransform() {
         borderLeftColor: undefined,
         borderRightColor: undefined,
         opacity: undefined,
+        elementId: undefined,
+        scrollPosition: undefined,
+        scrollVisible: undefined,
         zIndex: undefined,
     };
 }
@@ -414,6 +477,15 @@ var PBUiTransform;
         if (message.opacity !== undefined) {
             writer.uint32(589).float(message.opacity);
         }
+        if (message.elementId !== undefined) {
+            writer.uint32(594).string(message.elementId);
+        }
+        if (message.scrollPosition !== undefined) {
+            ScrollPositionValue.encode(message.scrollPosition, writer.uint32(602).fork()).ldelim();
+        }
+        if (message.scrollVisible !== undefined) {
+            writer.uint32(608).int32(message.scrollVisible);
+        }
         if (message.zIndex !== undefined) {
             writer.uint32(616).int32(message.zIndex);
         }
@@ -865,6 +937,24 @@ var PBUiTransform;
                     }
                     message.opacity = reader.float();
                     continue;
+                case 74:
+                    if (tag !== 594) {
+                        break;
+                    }
+                    message.elementId = reader.string();
+                    continue;
+                case 75:
+                    if (tag !== 602) {
+                        break;
+                    }
+                    message.scrollPosition = ScrollPositionValue.decode(reader, reader.uint32());
+                    continue;
+                case 76:
+                    if (tag !== 608) {
+                        break;
+                    }
+                    message.scrollVisible = reader.int32();
+                    continue;
                 case 77:
                     if (tag !== 616) {
                         break;

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

@@ -2,25 +2,27 @@ import { GrowOnlyValueSetComponentDefinition, LastWriteWinElementSetComponentDef
 import { IEngine } from '../engine/types';
 import { AnimatorComponentDefinitionExtended } from './extended/Animator';
 import { AudioSourceComponentDefinitionExtended } from './extended/AudioSource';
+import { AudioStreamComponentDefinitionExtended } from './extended/AudioStream';
+import { AvatarEquippedDataComponentDefinitionExtended } from './extended/AvatarEquippedData';
+import { AvatarShapeComponentDefinitionExtended } from './extended/AvatarShape';
+import { InputModifierComponentDefinitionExtended } from './extended/InputModifier';
 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 { VirtualCameraComponentDefinitionExtended } from './extended/VirtualCamera';
+import { GSetComponentGetter, LwwComponentGetter } from './generated/index.gen';
+import { MediaState } from './generated/pb/decentraland/sdk/components/common/media_state.gen';
 import { NameType } from './manual/Name';
-import { ISyncComponentsType } from './manual/SyncComponents';
 import { INetowrkEntityType } from './manual/NetworkEntity';
 import { INetowrkParentType } from './manual/NetworkParent';
+import { ISyncComponentsType } from './manual/SyncComponents';
 import { TransformComponentExtended } from './manual/Transform';
-import { AudioStreamComponentDefinitionExtended } from './extended/AudioStream';
-import { MediaState } from './generated/pb/decentraland/sdk/components/common/media_state.gen';
-import { VirtualCameraComponentDefinitionExtended } from './extended/VirtualCamera';
-import { InputModifierComponentDefinitionExtended } from './extended/InputModifier';
 import { LightSourceComponentDefinitionExtended } from './extended/LightSource';
 import { TriggerAreaComponentDefinitionExtended } from './extended/TriggerArea';
 import { TagsComponentDefinitionExtended } from './manual/Tags';
 export * from './generated/index.gen';
-export type { GrowOnlyValueSetComponentDefinition, LastWriteWinElementSetComponentDefinition, LwwComponentGetter, GSetComponentGetter };
+export type { GrowOnlyValueSetComponentDefinition, GSetComponentGetter, LastWriteWinElementSetComponentDefinition, LwwComponentGetter };
 export declare const Transform: LwwComponentGetter<TransformComponentExtended>;
 export declare const Material: LwwComponentGetter<MaterialComponentDefinitionExtended>;
 export declare const Animator: LwwComponentGetter<AnimatorComponentDefinitionExtended>;
@@ -29,6 +31,8 @@ export declare const AudioStream: (engine: Pick<IEngine, 'defineComponentFromSch
 export declare const MeshRenderer: LwwComponentGetter<MeshRendererComponentDefinitionExtended>;
 export declare const MeshCollider: LwwComponentGetter<MeshColliderComponentDefinitionExtended>;
 export declare const Tween: LwwComponentGetter<TweenComponentDefinitionExtended>;
+export declare const AvatarShape: LwwComponentGetter<AvatarShapeComponentDefinitionExtended>;
+export declare const AvatarEquippedData: LwwComponentGetter<AvatarEquippedDataComponentDefinitionExtended>;
 export declare const VirtualCamera: LwwComponentGetter<VirtualCameraComponentDefinitionExtended>;
 export declare const InputModifier: LwwComponentGetter<InputModifierComponentDefinitionExtended>;
 export declare const LightSource: LwwComponentGetter<LightSourceComponentDefinitionExtended>;

package/dist-cjs/components/index.js

@@ -17,23 +17,25 @@ 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.Tags = exports.Name = exports.TriggerArea = 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.TriggerArea = exports.LightSource = exports.InputModifier = exports.VirtualCamera = exports.AvatarEquippedData = exports.AvatarShape = 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 AudioStream_1 = require("./extended/AudioStream");
+const AvatarEquippedData_1 = require("./extended/AvatarEquippedData");
+const AvatarShape_1 = require("./extended/AvatarShape");
+const InputModifier_1 = require("./extended/InputModifier");
 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 VirtualCamera_1 = require("./extended/VirtualCamera");
+const media_state_gen_1 = require("./generated/pb/decentraland/sdk/components/common/media_state.gen");
+Object.defineProperty(exports, "MediaState", { enumerable: true, get: function () { return media_state_gen_1.MediaState; } });
 const Name_1 = __importDefault(require("./manual/Name"));
-const SyncComponents_1 = __importDefault(require("./manual/SyncComponents"));
 const NetworkEntity_1 = __importDefault(require("./manual/NetworkEntity"));
 const NetworkParent_1 = __importDefault(require("./manual/NetworkParent"));
+const SyncComponents_1 = __importDefault(require("./manual/SyncComponents"));
 const Transform_1 = require("./manual/Transform");
-const AudioStream_1 = require("./extended/AudioStream");
-const media_state_gen_1 = require("./generated/pb/decentraland/sdk/components/common/media_state.gen");
-Object.defineProperty(exports, "MediaState", { enumerable: true, get: function () { return media_state_gen_1.MediaState; } });
-const VirtualCamera_1 = require("./extended/VirtualCamera");
-const InputModifier_1 = require("./extended/InputModifier");
 const LightSource_1 = require("./extended/LightSource");
 const TriggerArea_1 = require("./extended/TriggerArea");
 const Tags_1 = __importDefault(require("./manual/Tags"));
@@ -63,6 +65,12 @@ exports.MeshCollider = MeshCollider;
 const Tween = (engine) => (0, Tween_1.defineTweenComponent)(engine);
 exports.Tween = Tween;
 /* @__PURE__ */
+const AvatarShape = (engine) => (0, AvatarShape_1.defineAvatarShapeComponent)(engine);
+exports.AvatarShape = AvatarShape;
+/* @__PURE__ */
+const AvatarEquippedData = (engine) => (0, AvatarEquippedData_1.defineAvatarEquippedDataComponent)(engine);
+exports.AvatarEquippedData = AvatarEquippedData;
+/* @__PURE__ */
 const VirtualCamera = (engine) => (0, VirtualCamera_1.defineVirtualCameraComponent)(engine);
 exports.VirtualCamera = VirtualCamera;
 /* @__PURE__*/

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

@@ -3,6 +3,8 @@ export type { AudioSourceComponentDefinitionExtended } from './extended/AudioSou
 export type { AudioStreamComponentDefinitionExtended } from './extended/AudioStream';
 export type { MeshRendererComponentDefinitionExtended } from './extended/MeshRenderer';
 export type { MeshColliderComponentDefinitionExtended } from './extended/MeshCollider';
+export type { AvatarEquippedDataComponentDefinitionExtended, AvatarEquippedDataType } from './extended/AvatarEquippedData';
+export type { AvatarShapeComponentDefinitionExtended, AvatarShapeType } from './extended/AvatarShape';
 export type { TextureHelper, MaterialComponentDefinitionExtended, FlatTexture, ReadonlyFlatMaterial, ReadonlyFlatTexture, FlatMaterial } from './extended/Material';
 export type { TweenHelper, TweenComponentDefinitionExtended } from './extended/Tween';
 export type { CameraTransitionHelper, VirtualCameraComponentDefinitionExtended } from './extended/VirtualCamera';

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

@@ -32,6 +32,12 @@ export type IInputSystem = {
      * @returns the input command info or undefined if there is no command in the last tick-update
      */
     getInputCommand: (inputAction: InputAction, pointerEventType: PointerEventType, entity?: Entity) => PBPointerEventsResult | null;
+    /**
+     * @public
+     * Get an ordered iterator over events received within the current frame.
+     * @returns the iterator
+     */
+    getInputCommands: () => Generator<PBPointerEventsResult>;
 };
 /**
  * @public

package/dist-cjs/engine/input.js

@@ -211,12 +211,18 @@ function createInputSystem(engine) {
     function isPressed(inputAction) {
         return globalState.buttonState.get(inputAction)?.state === 1 /* PointerEventType.PET_DOWN */;
     }
+    function* getInputCommands() {
+        for (let i = globalState.thisFrameCommands.length - 1; i >= 0; i--) {
+            yield globalState.thisFrameCommands[i];
+        }
+    }
     return {
         isPressed,
         getClick,
         getInputCommand,
         isClicked,
-        isTriggered
+        isTriggered,
+        getInputCommands
     };
 }
 exports.createInputSystem = createInputSystem;

package/dist-cjs/index.d.ts

@@ -3,6 +3,7 @@ export * from './schemas';
 export * from './runtime/initialization';
 export * from './runtime/types';
 export * from './runtime/helpers';
+export * from './runtime/globals';
 export { cyclicParentingChecker } from './systems/cyclicParentingChecker';
 export * from './systems/events';
 export * from './systems/raycast';

package/dist-cjs/index.js

@@ -33,6 +33,7 @@ __exportStar(require("./schemas"), exports);
 __exportStar(require("./runtime/initialization"), exports);
 __exportStar(require("./runtime/types"), exports);
 __exportStar(require("./runtime/helpers"), exports);
+__exportStar(require("./runtime/globals"), exports);
 var cyclicParentingChecker_1 = require("./systems/cyclicParentingChecker");
 Object.defineProperty(exports, "cyclicParentingChecker", { enumerable: true, get: function () { return cyclicParentingChecker_1.cyclicParentingChecker; } });
 __exportStar(require("./systems/events"), exports);

package/dist-cjs/runtime/globals.d.ts

@@ -1,4 +1,14 @@
 /**
- * Internal utilities for standardized globalThis access.
+ * Utilities for standardized globalThis access.
+ * @public
  */
-export {};
+/**
+ * Type-safe globalThis property access.
+ * @public
+ */
+export declare function getGlobal<T>(key: string): T | undefined;
+/**
+ * Sets a globalThis property as a polyfill (only if undefined/null).
+ * @public
+ */
+export declare function setGlobalPolyfill<T>(key: string, value: T): void;

package/dist-cjs/runtime/globals.js

@@ -1,12 +1,13 @@
 "use strict";
 /**
- * Internal utilities for standardized globalThis access.
+ * Utilities for standardized globalThis access.
+ * @public
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setGlobalPolyfill = exports.getGlobal = void 0;
 /**
  * Type-safe globalThis property access.
- * @internal
+ * @public
  */
 function getGlobal(key) {
     return globalThis[key];
@@ -14,7 +15,7 @@ function getGlobal(key) {
 exports.getGlobal = getGlobal;
 /**
  * Sets a globalThis property as a polyfill (only if undefined/null).
- * @internal
+ * @public
  */
 function setGlobalPolyfill(key, value) {
     ;

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

@@ -18,6 +18,12 @@ export type EventSystemOptions = {
     showHighlight?: boolean;
     maxPlayerDistance?: number;
 };
+/**
+ * @public
+ */
+export type EventSystemOptionsCallback = EventSystemOptions & {
+    cb: EventSystemCallback;
+};
 export declare const getDefaultOpts: (opts?: Partial<EventSystemOptions>) => EventSystemOptions;
 /**
  * @public
@@ -47,11 +53,37 @@ export interface PointerEventsSystem {
      * @param entity - Entity where the callback was attached
      */
     removeOnPointerHoverLeave(entity: Entity): void;
+    /**
+     * @public
+     * Remove the callback for onPointerDrag event
+     * @param entity - Entity where the callback was attached
+     */
+    removeOnPointerDrag(entity: Entity): void;
+    /**
+     * @public
+     * Remove the callback for onPointerDragLocked event
+     * @param entity - Entity where the callback was attached
+     */
+    removeOnPointerDragLocked(entity: Entity): void;
+    /**
+     * @public
+     * Remove the callback for onPointerDragEnd event
+     * @param entity - Entity where the callback was attached
+     */
+    removeOnPointerDragEnd(entity: Entity): void;
+    /**
+     * @public
+     * Execute callbacks when the user presses one of the InputButtons pointing at the entity
+     * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
+     */
+    onPointerDown(pointerData: {
+        entity: Entity;
+        optsList: EventSystemOptionsCallback[];
+    }): void;
     /**
      * @public
      * Execute callback when the user press the InputButton pointing at the entity
      * @param pointerData - Entity to attach the callback, Opts to trigger Feedback and Button
-     * @param cb - Function to execute when click fires
      */
     onPointerDown(pointerData: {
         entity: Entity;
@@ -64,6 +96,15 @@ export interface PointerEventsSystem {
      * @param opts - Opts to trigger Feedback and Button
      */
     onPointerDown(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions>): void;
+    /**
+     * @public
+     * Execute callbacks when the user releases one of the InputButtons pointing at the entity
+     * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
+     */
+    onPointerUp(pointerData: {
+        entity: Entity;
+        optsList: EventSystemOptionsCallback[];
+    }): void;
     /**
      * @public
      * Execute callback when the user releases the InputButton pointing at the entity
@@ -101,6 +142,64 @@ export interface PointerEventsSystem {
         entity: Entity;
         opts?: Partial<EventSystemOptions>;
     }, cb: EventSystemCallback): void;
+    /**
+     * @public
+     * Execute callbacks when the user drags the pointer from inside the entity
+     * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
+     */
+    onPointerDrag(pointerData: {
+        entity: Entity;
+        optsList: EventSystemOptionsCallback[];
+    }): void;
+    /**
+     * @public
+     * Execute callback when the user clicks and drags the pointer from inside the entity
+     * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
+     * @param cb - Function to execute when click fires
+     */
+    onPointerDrag(pointerData: {
+        entity: Entity;
+        opts?: Partial<EventSystemOptions>;
+    }, cb: EventSystemCallback): void;
+    /**
+     * @public
+     * Execute callbacks when the user drags the pointer from inside the entity, locking the cursor in place.
+     * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
+     */
+    onPointerDragLocked(pointerData: {
+        entity: Entity;
+        optsList: EventSystemOptionsCallback[];
+    }): void;
+    /**
+     * @public
+     * Execute callback when the user clicks and drags the pointer from inside the entity,
+     * locking the cursor in place
+     * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
+     * @param cb - Function to execute when click fires
+     */
+    onPointerDragLocked(pointerData: {
+        entity: Entity;
+        opts?: Partial<EventSystemOptions>;
+    }, cb: EventSystemCallback): void;
+    /**
+     * @public
+     * Execute callbacks when the user releases a button after a drag
+     * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
+     */
+    onPointerDragEnd(pointerData: {
+        entity: Entity;
+        optsList: EventSystemOptionsCallback[];
+    }): void;
+    /**
+     * @public
+     * Execute callback when the user releases the button after a drag
+     * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
+     * @param cb - Function to execute when click fires
+     */
+    onPointerDragEnd(pointerData: {
+        entity: Entity;
+        opts?: Partial<EventSystemOptions>;
+    }, cb: EventSystemCallback): void;
 }
 /**
  * @public