@dcl/playground-assets 7.6.4 → 7.6.5-11672040830.commit-680459b

package/dist/playground/sdk/dcl-sdk.package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dcl/sdk",
   "description": "",
-  "version": "7.6.4",
+  "version": "7.6.5-11672040830.commit-680459b",
   "author": "Decentraland",
   "dependencies": {
     "@dcl/ecs": "file:../ecs",
-    "@dcl/ecs-math": "2.0.2",
+    "@dcl/ecs-math": "2.1.0",
     "@dcl/explorer": "1.0.164509-20240802172549.commit-fb95b9b",
     "@dcl/js-runtime": "file:../js-runtime",
     "@dcl/react-ecs": "file:../react-ecs",
@@ -35,5 +35,5 @@
   },
   "types": "./index.d.ts",
   "typings": "./index.d.ts",
-  "commit": "48941ef221bcf9900694421bf7f0d037e74cd2ac"
+  "commit": "680459b70e094fd92c59c9f041546792d160056d"
 }

package/dist/playground-assets.d.ts

@@ -1957,6 +1957,7 @@ export declare type EventSystemOptions = {
     hoverText?: string;
     maxDistance?: number;
     showFeedback?: boolean;
+    showHighlight?: boolean;
 };
 
 /**
@@ -2025,6 +2026,8 @@ export declare function getComponentEntityTree<T>(engine: Pick<IEngine, 'getEnti
  */
 export declare function getCompositeRootComponent(engine: IEngine): LastWriteWinElementSetComponentDefinition<CompositeRootType>;
 
+export declare const getDefaultOpts: (opts?: Partial<EventSystemOptions>) => EventSystemOptions;
+
 export declare type GlobalDirectionRaycastOptions = RaycastSystemOptions & GlobalDirectionRaycastSystemOptions;
 
 export declare type GlobalDirectionRaycastSystemOptions = {
@@ -4925,8 +4928,10 @@ export declare interface PBPointerEvents_Info {
     hoverText?: string | undefined;
     /** range of interaction (default 10) */
     maxDistance?: number | undefined;
-    /** enable or disable hover text (default true) */
+    /** enable or disable hover text and highlight (default true) */
     showFeedback?: boolean | undefined;
+    /** enable or disable hover highlight (default true) */
+    showHighlight?: boolean | undefined;
 }
 
 /**
@@ -7408,6 +7413,93 @@ export declare type ValueSetOptions<T> = {
     maxElements: number;
 };
 
+/**
+ * @public
+ * Vector2 is a type and a namespace.
+ * - The namespace contains all types and functions to operates with Vector2
+ * - The type Vector2 is an alias to Vector2.ReadonlyVector2
+ * ```
+ *
+ * // Namespace usage example
+ * const next = Vector2.add(pointA, velocityA) // add function not implemented yet
+ *
+ * // Type usage example
+ * const readonlyPosition: Vector2 = Vector2.Zero()
+ * readonlyPosition.x = 0.1 // this FAILS
+ *
+ * // For mutable usage, use `Vector2.Mutable`
+ * const position: Vector2.Mutable = Vector2.One()
+ * position.x = 3.0 // this WORKS
+ * ```
+ */
+export declare type Vector2 = Vector2.ReadonlyVector2;
+
+/**
+ * @public
+ * Vector2 is a type and a namespace.
+ * ```
+ * // The namespace contains all types and functions to operates with Vector2
+ * const next = Vector2.add(pointA, velocityA) // add function not implemented yet
+ * // The type Vector2 is an alias to Vector2.ReadonlyVector2
+ * const readonlyPosition: Vector2 = Vector2.Zero()
+ * readonlyPosition.x = 0.1 // this FAILS
+ *
+ * // For mutable usage, use `Vector2.Mutable`
+ * const position: Vector2.Mutable = Vector2.One()
+ * position.x = 3.0 // this WORKS
+ * ```
+ */
+export declare namespace Vector2 {
+    /**
+     * @public
+     * For external use, type with `Vector2`, e.g. `const zeroPosition: Vector2 = Vector2.Zero()`.
+     * For mutable typing, use `Vector2.Mutable`, e.g. `const oneVector: Vector2.Mutable = Vector2.One()`.
+     */
+    export type ReadonlyVector2 = {
+        readonly x: number;
+        readonly y: number;
+    };
+    /**
+     * @public
+     * For external usage, type with `Vector2`, e.g. `const zeroPosition: Vector2 = Vector2.Zero()`.
+     * For mutable typing, use `Vector2.Mutable`, e.g. `const oneVector: Vector2.Mutable = Vector2.One()`.
+     */
+    export type MutableVector2 = {
+        x: number;
+        y: number;
+    };
+    /**
+     * @public
+     * Type with `Vector2` for readonly usage, e.g. `const zeroPosition: Vector2 = Vector2.Zero()`.
+     * For mutable, use `Vector2.Mutable`, e.g. `const oneVector: Vector2.Mutable = Vector2.One()`.
+     */
+    export type Mutable = MutableVector2;
+    /**
+     * Creates a new Vector2 object from the given x, y (floats) coordinates.
+     * @param x - defines the first coordinates (on X axis)
+     * @param y - defines the second coordinates (on Y axis)
+     */
+    export function create(
+    /**
+     * Defines the first coordinates (on X axis)
+     */
+    x?: number, 
+    /**
+     * Defines the second coordinates (on Y axis)
+     */
+    y?: number): MutableVector2;
+    /**
+     * Returns a new Vector2 set to (0.0, 0.0)
+     * @returns a new empty Vector2
+     */
+    export function Zero(): MutableVector2;
+    /**
+     * Returns a new Vector2 set to (1.0, 1.0)
+     * @returns a new unit Vector2
+     */
+    export function One(): MutableVector2;
+}
+
 /**
  * @public
  * Vector3 is a type and a namespace.
@@ -7503,21 +7595,24 @@ export declare namespace Vector3 {
      */
     export function add(vector1: ReadonlyVector3, vector2: ReadonlyVector3): MutableVector3;
     /**
-     * Add component by component the vector2 into dest
-     * @param dest - the first vector and destination of addition
-     * @param vector2 - the second vector
+     * Performs addition between vectorA and vectorB and stores the result into result
+     * @param vectorA - the first vector for the addition operation
+     * @param vectorB - the second vector for the addition operation
+     * @param result - the vector where the result of the addition is stored
      */
-    export function addToRef(vector1: ReadonlyVector3, vector2: ReadonlyVector3, result: MutableVector3): void;
+    export function addToRef(vectorA: ReadonlyVector3, vectorB: ReadonlyVector3, result: MutableVector3): void;
     /**
      * Returns a new Vector3 as the result of the substraction of the two given vectors.
      * @returns the resulting vector
      */
     export function subtract(vector1: ReadonlyVector3, vector2: ReadonlyVector3): MutableVector3;
     /**
-     * Returns a new Vector3 as the result of the substraction of the two given vectors.
-     * @returns the resulting vector
+     * Performs substraction between vectorA and vectorB and stores the result into result
+     * @param vectorA - the first vector for the substraction operation
+     * @param vectorB - the second vector for the substraction operation
+     * @param result - the vector where the result of the substraction is stored
      */
-    export function subtractToRef(vector1: ReadonlyVector3, vector2: ReadonlyVector3, result: MutableVector3): void;
+    export function subtractToRef(vectorA: ReadonlyVector3, vectorB: ReadonlyVector3, result: MutableVector3): void;
     /**
      * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
      * @param x - defines the x coordinate of the operand

package/etc/playground-assets.api.json

@@ -18961,7 +18961,7 @@
             },
             {
               "kind": "Content",
-              "text": ";\n    hoverText?: string;\n    maxDistance?: number;\n    showFeedback?: boolean;\n}"
+              "text": ";\n    hoverText?: string;\n    maxDistance?: number;\n    showFeedback?: boolean;\n    showHighlight?: boolean;\n}"
             },
             {
               "kind": "Content",
@@ -19412,6 +19412,62 @@
           ],
           "name": "getCompositeRootComponent"
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@dcl/playground-assets!getDefaultOpts:function(1)",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "getDefaultOpts: (opts?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Partial",
+              "canonicalReference": "!Partial:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "EventSystemOptions",
+              "canonicalReference": "@dcl/playground-assets!EventSystemOptions:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": ") => "
+            },
+            {
+              "kind": "Reference",
+              "text": "EventSystemOptions",
+              "canonicalReference": "@dcl/playground-assets!EventSystemOptions:type"
+            }
+          ],
+          "fileUrlPath": "../ecs/dist/systems/events.d.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 6,
+            "endIndex": 7
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "opts",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              },
+              "isOptional": true
+            }
+          ],
+          "name": "getDefaultOpts"
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@dcl/playground-assets!GlobalDirectionRaycastOptions:type",
@@ -45576,7 +45632,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "@dcl/playground-assets!PBPointerEvents_Info#showFeedback:member",
-              "docComment": "/**\n * enable or disable hover text (default true)\n */\n",
+              "docComment": "/**\n * enable or disable hover text and highlight (default true)\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -45599,6 +45655,33 @@
                 "startIndex": 1,
                 "endIndex": 2
               }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@dcl/playground-assets!PBPointerEvents_Info#showHighlight:member",
+              "docComment": "/**\n * enable or disable hover highlight (default true)\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "showHighlight?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "showHighlight",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
             }
           ],
           "extendsTokenRanges": []
@@ -70760,6 +70843,243 @@
             "endIndex": 4
           }
         },
+        {
+          "kind": "Namespace",
+          "canonicalReference": "@dcl/playground-assets!Vector2:namespace",
+          "docComment": "/**\n * Vector2 is a type and a namespace.\n * ```\n * // The namespace contains all types and functions to operates with Vector2\n * const next = Vector2.add(pointA, velocityA) // add function not implemented yet\n * // The type Vector2 is an alias to Vector2.ReadonlyVector2\n * const readonlyPosition: Vector2 = Vector2.Zero()\n * readonlyPosition.x = 0.1 // this FAILS\n *\n * // For mutable usage, use `Vector2.Mutable`\n * const position: Vector2.Mutable = Vector2.One()\n * position.x = 3.0 // this WORKS\n * ```\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare namespace Vector2 "
+            }
+          ],
+          "fileUrlPath": "../sdk/node_modules/@dcl/ecs-math/dist/Vector2.d.ts",
+          "releaseTag": "Public",
+          "name": "Vector2",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "Function",
+              "canonicalReference": "@dcl/playground-assets!Vector2.create:function(1)",
+              "docComment": "/**\n * Creates a new Vector2 object from the given x, y (floats) coordinates.\n *\n * @param x - defines the first coordinates (on X axis)\n *\n * @param y - defines the second coordinates (on Y axis)\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "function create(\n    x?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", \n    y?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "MutableVector2",
+                  "canonicalReference": "@dcl/playground-assets!Vector2.MutableVector2:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "x",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": true
+                },
+                {
+                  "parameterName": "y",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": true
+                }
+              ],
+              "name": "create"
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@dcl/playground-assets!Vector2.Mutable:type",
+              "docComment": "/**\n * Type with `Vector2` for readonly usage, e.g. `const zeroPosition: Vector2 = Vector2.Zero()`. For mutable, use `Vector2.Mutable`, e.g. `const oneVector: Vector2.Mutable = Vector2.One()`.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "type Mutable = "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "MutableVector2",
+                  "canonicalReference": "@dcl/playground-assets!Vector2.MutableVector2:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "releaseTag": "Public",
+              "name": "Mutable",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@dcl/playground-assets!Vector2.MutableVector2:type",
+              "docComment": "/**\n * For external usage, type with `Vector2`, e.g. `const zeroPosition: Vector2 = Vector2.Zero()`. For mutable typing, use `Vector2.Mutable`, e.g. `const oneVector: Vector2.Mutable = Vector2.One()`.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "type MutableVector2 = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        x: number;\n        y: number;\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "releaseTag": "Public",
+              "name": "MutableVector2",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "Function",
+              "canonicalReference": "@dcl/playground-assets!Vector2.One:function(1)",
+              "docComment": "/**\n * Returns a new Vector2 set to (1.0, 1.0)\n *\n * @returns a new unit Vector2\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "function One(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "MutableVector2",
+                  "canonicalReference": "@dcl/playground-assets!Vector2.MutableVector2:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [],
+              "name": "One"
+            },
+            {
+              "kind": "TypeAlias",
+              "canonicalReference": "@dcl/playground-assets!Vector2.ReadonlyVector2:type",
+              "docComment": "/**\n * For external use, type with `Vector2`, e.g. `const zeroPosition: Vector2 = Vector2.Zero()`. For mutable typing, use `Vector2.Mutable`, e.g. `const oneVector: Vector2.Mutable = Vector2.One()`.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "type ReadonlyVector2 = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        readonly x: number;\n        readonly y: number;\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "releaseTag": "Public",
+              "name": "ReadonlyVector2",
+              "typeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "Function",
+              "canonicalReference": "@dcl/playground-assets!Vector2.Zero:function(1)",
+              "docComment": "/**\n * Returns a new Vector2 set to (0.0, 0.0)\n *\n * @returns a new empty Vector2\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "function Zero(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "MutableVector2",
+                  "canonicalReference": "@dcl/playground-assets!Vector2.MutableVector2:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [],
+              "name": "Zero"
+            }
+          ]
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@dcl/playground-assets!Vector2:type",
+          "docComment": "/**\n * Vector2 is a type and a namespace. - The namespace contains all types and functions to operates with Vector2 - The type Vector2 is an alias to Vector2.ReadonlyVector2\n * ```\n *\n * // Namespace usage example\n * const next = Vector2.add(pointA, velocityA) // add function not implemented yet\n *\n * // Type usage example\n * const readonlyPosition: Vector2 = Vector2.Zero()\n * readonlyPosition.x = 0.1 // this FAILS\n *\n * // For mutable usage, use `Vector2.Mutable`\n * const position: Vector2.Mutable = Vector2.One()\n * position.x = 3.0 // this WORKS\n * ```\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare type Vector2 = "
+            },
+            {
+              "kind": "Reference",
+              "text": "Vector2.ReadonlyVector2",
+              "canonicalReference": "@dcl/playground-assets!Vector2.ReadonlyVector2:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../sdk/node_modules/@dcl/ecs-math/dist/Vector2.d.ts",
+          "releaseTag": "Public",
+          "name": "Vector2",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Namespace",
           "canonicalReference": "@dcl/playground-assets!Vector3:namespace",
@@ -70841,11 +71161,11 @@
             {
               "kind": "Function",
               "canonicalReference": "@dcl/playground-assets!Vector3.addToRef:function(1)",
-              "docComment": "/**\n * Add component by component the vector2 into dest\n *\n * @param dest - the first vector and destination of addition\n *\n * @param vector2 - the second vector\n */\n",
+              "docComment": "/**\n * Performs addition between vectorA and vectorB and stores the result into result\n *\n * @param vectorA - the first vector for the addition operation\n *\n * @param vectorB - the second vector for the addition operation\n *\n * @param result - the vector where the result of the addition is stored\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "function addToRef(vector1: "
+                  "text": "function addToRef(vectorA: "
                 },
                 {
                   "kind": "Reference",
@@ -70854,7 +71174,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ", vector2: "
+                  "text": ", vectorB: "
                 },
                 {
                   "kind": "Reference",
@@ -70891,7 +71211,7 @@
               "overloadIndex": 1,
               "parameters": [
                 {
-                  "parameterName": "vector1",
+                  "parameterName": "vectorA",
                   "parameterTypeTokenRange": {
                     "startIndex": 1,
                     "endIndex": 2
@@ -70899,7 +71219,7 @@
                   "isOptional": false
                 },
                 {
-                  "parameterName": "vector2",
+                  "parameterName": "vectorB",
                   "parameterTypeTokenRange": {
                     "startIndex": 3,
                     "endIndex": 4
@@ -75296,11 +75616,11 @@
             {
               "kind": "Function",
               "canonicalReference": "@dcl/playground-assets!Vector3.subtractToRef:function(1)",
-              "docComment": "/**\n * Returns a new Vector3 as the result of the substraction of the two given vectors.\n *\n * @returns the resulting vector\n */\n",
+              "docComment": "/**\n * Performs substraction between vectorA and vectorB and stores the result into result\n *\n * @param vectorA - the first vector for the substraction operation\n *\n * @param vectorB - the second vector for the substraction operation\n *\n * @param result - the vector where the result of the substraction is stored\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "function subtractToRef(vector1: "
+                  "text": "function subtractToRef(vectorA: "
                 },
                 {
                   "kind": "Reference",
@@ -75309,7 +75629,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": ", vector2: "
+                  "text": ", vectorB: "
                 },
                 {
                   "kind": "Reference",
@@ -75346,7 +75666,7 @@
               "overloadIndex": 1,
               "parameters": [
                 {
-                  "parameterName": "vector1",
+                  "parameterName": "vectorA",
                   "parameterTypeTokenRange": {
                     "startIndex": 1,
                     "endIndex": 2
@@ -75354,7 +75674,7 @@
                   "isOptional": false
                 },
                 {
-                  "parameterName": "vector2",
+                  "parameterName": "vectorB",
                   "parameterTypeTokenRange": {
                     "startIndex": 3,
                     "endIndex": 4