@dcl/playground-assets 7.1.8-4747179772.commit-377c8b9 → 7.1.8-4756315995.commit-6d7fbd0

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

@@ -1,7 +1,7 @@
 {
   "name": "@dcl/sdk",
   "description": "",
-  "version": "7.1.8-4747179772.commit-377c8b9",
+  "version": "7.1.8-4756315995.commit-6d7fbd0",
   "author": "Decentraland",
   "dependencies": {
     "@dcl/ecs": "file:../ecs",
@@ -30,5 +30,5 @@
   },
   "types": "./index.d.ts",
   "typings": "./index.d.ts",
-  "commit": "377c8b90e3c0b392136025c65aee8a9f9a845bb5"
+  "commit": "6d7fbd0161e9d081ffb08992f9b6695f5ee026ab"
 }

package/dist/playground-assets.d.ts

@@ -207,7 +207,10 @@ export declare interface BaseComponent<T> {
 /** @public */
 export declare const Billboard: LastWriteWinElementSetComponentDefinition<PBBillboard>;
 
-/** BillboardMode indicates one or more axis for automatic rotation, in OR-able bit flag form. */
+/**
+ * BillboardMode indicates one or more axis for automatic rotation, in OR-able bit flag form.
+ * Only the values below and the (BM_X | BM_Y) combination are valid.
+ */
 /**
  * @public
  */
@@ -1147,6 +1150,7 @@ export declare const componentDefinitionByName: {
     "core::RaycastResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycastResult>>;
     "core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
     "core::UiBackground": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiBackground>>;
+    "core::UiCanvasInformation": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>>;
     "core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
     "core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
     "core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
@@ -3912,7 +3916,7 @@ export declare interface PBRaycast {
      * otherwise it will be performed only once, defaults to false
      */
     continuous?: boolean | undefined;
-    /** Collision mask, by default all bits are 1 (0xFFFF_FFFF) */
+    /** Collision mask, by default CL_POINTER | CL_PHYSICS */
     collisionMask?: number | undefined;
 }
 
@@ -4007,6 +4011,27 @@ export declare interface PBUiBackground {
     uvs: number[];
 }
 
+/** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
+/**
+ * @public
+ */
+export declare interface PBUiCanvasInformation {
+    /** informs the scene about the resolution used for the UI rendering */
+    devicePixelRatio: number;
+    /** informs about the width of the canvas, in virtual pixels. this value does not change when the pixel ratio changes. */
+    width: number;
+    /** informs about the height of the canvas, in virtual pixels. this value does not change when the pixel ratio changes. */
+    height: number;
+    /**
+     * informs the sdk about the interactable area. some implementations may change
+     * this area depending on the HUD that is being shown. this value may change at
+     * any time by the Renderer to create reactive UIs. as an example, an explorer with the
+     * chat UI hidden and with no minimap could have a rect that covers the whole screen.
+     * on the contrary, if the chat UI is shown, the rect would be smaller.
+     */
+    interactableArea: BorderRect | undefined;
+}
+
 /**
  * @public
  */
@@ -4870,6 +4895,17 @@ export declare type ReceiveMessage = CrdtMessageBody & {
     messageBuffer: Uint8Array;
 };
 
+/** Defines a rect with x, y, width and height */
+/**
+ * @public
+ */
+export declare interface Rect {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+
 export declare type RPCSendableMessage = {
     jsonrpc: '2.0';
     id: number;
@@ -5397,6 +5433,9 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
     disabled?: boolean;
 }
 
+/** @public */
+export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
+
 /**
  * @public
  */

package/etc/playground-assets.api.json

@@ -10890,6 +10890,33 @@
               "text": "PBUiBackground",
               "canonicalReference": "@dcl/playground-assets!PBUiBackground:interface"
             },
+            {
+              "kind": "Content",
+              "text": ">>;\n    \"core::UiCanvasInformation\": "
+            },
+            {
+              "kind": "Reference",
+              "text": "LwwComponentGetter",
+              "canonicalReference": "@dcl/playground-assets!LwwComponentGetter:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "LastWriteWinElementSetComponentDefinition",
+              "canonicalReference": "@dcl/playground-assets!LastWriteWinElementSetComponentDefinition:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "PBUiCanvasInformation",
+              "canonicalReference": "@dcl/playground-assets!PBUiCanvasInformation:interface"
+            },
             {
               "kind": "Content",
               "text": ">>;\n    \"core::UiDropdown\": "
@@ -11117,7 +11144,7 @@
           "name": "componentDefinitionByName",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 176
+            "endIndex": 182
           }
         },
         {
@@ -34076,7 +34103,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "@dcl/playground-assets!PBRaycast#collisionMask:member",
-              "docComment": "/**\n * Collision mask, by default all bits are 1 (0xFFFF_FFFF)\n */\n",
+              "docComment": "/**\n * Collision mask, by default CL_POINTER | CL_PHYSICS\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -35218,6 +35245,137 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@dcl/playground-assets!PBUiCanvasInformation:interface",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface PBUiCanvasInformation "
+            }
+          ],
+          "fileUrlPath": "../ecs/dist/components/generated/pb/decentraland/sdk/components/ui_canvas_information.gen.d.ts",
+          "releaseTag": "Public",
+          "name": "PBUiCanvasInformation",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@dcl/playground-assets!PBUiCanvasInformation#devicePixelRatio:member",
+              "docComment": "/**\n * informs the scene about the resolution used for the UI rendering\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "devicePixelRatio: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "devicePixelRatio",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@dcl/playground-assets!PBUiCanvasInformation#height:member",
+              "docComment": "/**\n * informs about the height of the canvas, in virtual pixels. this value does not change when the pixel ratio changes.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "height: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "height",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@dcl/playground-assets!PBUiCanvasInformation#interactableArea:member",
+              "docComment": "/**\n * informs the sdk about the interactable area. some implementations may change this area depending on the HUD that is being shown. this value may change at any time by the Renderer to create reactive UIs. as an example, an explorer with the chat UI hidden and with no minimap could have a rect that covers the whole screen. on the contrary, if the chat UI is shown, the rect would be smaller.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "interactableArea: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "BorderRect",
+                  "canonicalReference": "@dcl/playground-assets!BorderRect:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "interactableArea",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@dcl/playground-assets!PBUiCanvasInformation#width:member",
+              "docComment": "/**\n * informs about the width of the canvas, in virtual pixels. this value does not change when the pixel ratio changes.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "width: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "width",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@dcl/playground-assets!PBUiDropdown:interface",
@@ -42859,6 +43017,132 @@
             "endIndex": 5
           }
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@dcl/playground-assets!Rect:interface",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface Rect "
+            }
+          ],
+          "fileUrlPath": "../ecs/dist/components/generated/pb/decentraland/common/border_rect.gen.d.ts",
+          "releaseTag": "Public",
+          "name": "Rect",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@dcl/playground-assets!Rect#height:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "height: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "height",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@dcl/playground-assets!Rect#width:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "width: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "width",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@dcl/playground-assets!Rect#x:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "x: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "x",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@dcl/playground-assets!Rect#y:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "y: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "y",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@dcl/playground-assets!RPCSendableMessage:type",
@@ -47155,6 +47439,43 @@
             }
           ]
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@dcl/playground-assets!UiCanvasInformation:var",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "UiCanvasInformation: "
+            },
+            {
+              "kind": "Reference",
+              "text": "LastWriteWinElementSetComponentDefinition",
+              "canonicalReference": "@dcl/playground-assets!LastWriteWinElementSetComponentDefinition:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "PBUiCanvasInformation",
+              "canonicalReference": "@dcl/playground-assets!PBUiCanvasInformation:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            }
+          ],
+          "fileUrlPath": "../ecs/dist/components/generated/global.gen.d.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "UiCanvasInformation",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 5
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@dcl/playground-assets!UiComponent:type",

package/etc/playground-assets.api.md

@@ -496,6 +496,7 @@ export const componentDefinitionByName: {
     "core::RaycastResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycastResult>>;
     "core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
     "core::UiBackground": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiBackground>>;
+    "core::UiCanvasInformation": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>>;
     "core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
     "core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
     "core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
@@ -2090,6 +2091,14 @@ export interface PBUiBackground {
     uvs: number[];
 }
 
+// @public (undocumented)
+export interface PBUiCanvasInformation {
+    devicePixelRatio: number;
+    height: number;
+    interactableArea: BorderRect | undefined;
+    width: number;
+}
+
 // @public (undocumented)
 export interface PBUiDropdown {
     // (undocumented)
@@ -2528,6 +2537,18 @@ export type ReceiveMessage = CrdtMessageBody & {
     messageBuffer: Uint8Array;
 };
 
+// @public (undocumented)
+export interface Rect {
+    // (undocumented)
+    height: number;
+    // (undocumented)
+    width: number;
+    // (undocumented)
+    x: number;
+    // (undocumented)
+    y: number;
+}
+
 // Warning: (ae-missing-release-tag) "RPCSendableMessage" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -2823,6 +2844,9 @@ export interface UiButtonProps extends UiLabelProps, EntityPropTypes {
     variant?: 'primary' | 'secondary';
 }
 
+// @public (undocumented)
+export const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
+
 // @public (undocumented)
 export type UiComponent = () => ReactEcs.JSX.Element;
 

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dcl/playground-assets",
   "description": "",
-  "version": "7.1.8-4747179772.commit-377c8b9",
+  "version": "7.1.8-4756315995.commit-6d7fbd0",
   "author": "Decentraland",
   "dependencies": {
-    "@dcl/js-runtime": "7.1.8-4747179772.commit-377c8b9",
-    "@dcl/sdk": "7.1.8-4747179772.commit-377c8b9"
+    "@dcl/js-runtime": "7.1.8-4756315995.commit-6d7fbd0",
+    "@dcl/sdk": "7.1.8-4756315995.commit-6d7fbd0"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.33.8"
@@ -28,5 +28,5 @@
   },
   "types": "./dist/index.d.ts",
   "typings": "./dist/index.d.ts",
-  "commit": "377c8b90e3c0b392136025c65aee8a9f9a845bb5"
+  "commit": "6d7fbd0161e9d081ffb08992f9b6695f5ee026ab"
 }