@dcl/playground-assets 7.17.1-21217092165.commit-1c2ff72 → 7.17.1-21366395728.commit-ada88b6

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

@@ -1,7 +1,7 @@
 {
   "name": "@dcl/sdk",
   "description": "",
-  "version": "7.17.1-21217092165.commit-1c2ff72",
+  "version": "7.17.1-21366395728.commit-ada88b6",
   "author": "Decentraland",
   "dependencies": {
     "@dcl/ecs": "file:../ecs",
@@ -35,5 +35,5 @@
   },
   "types": "./index.d.ts",
   "typings": "./index.d.ts",
-  "commit": "1c2ff7242cd11eb981666a8318f670c0b302813b"
+  "commit": "ada88b6fe8e93150056e0cade4b94e0c1e7dc850"
 }

package/dist/playground-assets.d.ts

@@ -6926,8 +6926,14 @@ export declare type RaycastSystemOptions = {
  * @public
  */
 export declare interface ReactBasedUiSystem {
+    /**
+     * Destroy all UI entities and unregister related systems.
+     */
     destroy(): void;
-    setUiRenderer(ui: UiComponent): void;
+    /**
+     * Set the main UI renderer. Optional virtual size defines the global UI scale factor.
+     */
+    setUiRenderer(ui: UiComponent, options?: UiRendererOptions): void;
     /**
      * Add a UI renderer associated with an entity. The UI will be automatically cleaned up
      * when the entity is removed from the engine.
@@ -6940,10 +6946,12 @@ export declare interface ReactBasedUiSystem {
      * @param entity - The entity to associate with this UI renderer. When the entity is removed,
      *                 the UI renderer is automatically cleaned up.
      * @param ui - The UI component to render
+     * @param options - Optional virtual size used for UI scale factor when main UI has none
      */
-    addUiRenderer(entity: Entity, ui: UiComponent): void;
+    addUiRenderer(entity: Entity, ui: UiComponent, options?: UiRendererOptions): void;
     /**
      * Remove a previously added UI renderer by its associated entity.
+     * It does not affect the main UI renderer.
      * @param entity - The entity whose UI renderer should be removed
      */
     removeUiRenderer(entity: Entity): void;
@@ -8150,6 +8158,14 @@ export declare interface UiLabelProps {
  */
 export declare type uint32 = number;
 
+/**
+ * @public
+ */
+export declare type UiRendererOptions = {
+    virtualWidth: number;
+    virtualHeight: number;
+};
+
 /** @public */
 export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
 

package/etc/playground-assets.api.json

@@ -66759,7 +66759,7 @@
             {
               "kind": "MethodSignature",
               "canonicalReference": "@dcl/playground-assets!ReactBasedUiSystem#addUiRenderer:member(1)",
-              "docComment": "/**\n * Add a UI renderer associated with an entity. The UI will be automatically cleaned up when the entity is removed from the engine.\n *\n * If a renderer is already associated with the given entity, it will be replaced.\n *\n * This allows dynamically adding UI Renderers that are rendered alongside the main UI set via setUiRenderer().\n *\n * @param entity - The entity to associate with this UI renderer. When the entity is removed, the UI renderer is automatically cleaned up.\n *\n * @param ui - The UI component to render\n */\n",
+              "docComment": "/**\n * Add a UI renderer associated with an entity. The UI will be automatically cleaned up when the entity is removed from the engine.\n *\n * If a renderer is already associated with the given entity, it will be replaced.\n *\n * This allows dynamically adding UI Renderers that are rendered alongside the main UI set via setUiRenderer().\n *\n * @param entity - The entity to associate with this UI renderer. When the entity is removed, the UI renderer is automatically cleaned up.\n *\n * @param ui - The UI component to render\n *\n * @param options - Optional virtual size used for UI scale factor when main UI has none\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -66779,6 +66779,15 @@
                   "text": "UiComponent",
                   "canonicalReference": "@dcl/playground-assets!UiComponent:type"
                 },
+                {
+                  "kind": "Content",
+                  "text": ", options?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "UiRendererOptions",
+                  "canonicalReference": "@dcl/playground-assets!UiRendererOptions:type"
+                },
                 {
                   "kind": "Content",
                   "text": "): "
@@ -66794,8 +66803,8 @@
               ],
               "isOptional": false,
               "returnTypeTokenRange": {
-                "startIndex": 5,
-                "endIndex": 6
+                "startIndex": 7,
+                "endIndex": 8
               },
               "releaseTag": "Public",
               "overloadIndex": 1,
@@ -66815,6 +66824,14 @@
                     "endIndex": 4
                   },
                   "isOptional": false
+                },
+                {
+                  "parameterName": "options",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": true
                 }
               ],
               "name": "addUiRenderer"
@@ -66822,7 +66839,7 @@
             {
               "kind": "MethodSignature",
               "canonicalReference": "@dcl/playground-assets!ReactBasedUiSystem#destroy:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Destroy all UI entities and unregister related systems.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -66850,7 +66867,7 @@
             {
               "kind": "MethodSignature",
               "canonicalReference": "@dcl/playground-assets!ReactBasedUiSystem#removeUiRenderer:member(1)",
-              "docComment": "/**\n * Remove a previously added UI renderer by its associated entity.\n *\n * @param entity - The entity whose UI renderer should be removed\n */\n",
+              "docComment": "/**\n * Remove a previously added UI renderer by its associated entity. It does not affect the main UI renderer.\n *\n * @param entity - The entity whose UI renderer should be removed\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -66896,7 +66913,7 @@
             {
               "kind": "MethodSignature",
               "canonicalReference": "@dcl/playground-assets!ReactBasedUiSystem#setUiRenderer:member(1)",
-              "docComment": "",
+              "docComment": "/**\n * Set the main UI renderer. Optional virtual size defines the global UI scale factor.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -66907,6 +66924,15 @@
                   "text": "UiComponent",
                   "canonicalReference": "@dcl/playground-assets!UiComponent:type"
                 },
+                {
+                  "kind": "Content",
+                  "text": ", options?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "UiRendererOptions",
+                  "canonicalReference": "@dcl/playground-assets!UiRendererOptions:type"
+                },
                 {
                   "kind": "Content",
                   "text": "): "
@@ -66922,8 +66948,8 @@
               ],
               "isOptional": false,
               "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
+                "startIndex": 5,
+                "endIndex": 6
               },
               "releaseTag": "Public",
               "overloadIndex": 1,
@@ -66935,6 +66961,14 @@
                     "endIndex": 2
                   },
                   "isOptional": false
+                },
+                {
+                  "parameterName": "options",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": true
                 }
               ],
               "name": "setUiRenderer"
@@ -78335,6 +78369,32 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@dcl/playground-assets!UiRendererOptions:type",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type UiRendererOptions = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    virtualWidth: number;\n    virtualHeight: number;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../react-ecs/dist/system.d.ts",
+          "releaseTag": "Public",
+          "name": "UiRendererOptions",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@dcl/playground-assets!UiText:var",

package/etc/playground-assets.api.md

@@ -3877,12 +3877,10 @@ export type RaycastSystemOptions = {
 
 // @public (undocumented)
 export interface ReactBasedUiSystem {
-    addUiRenderer(entity: Entity, ui: UiComponent): void;
-    // (undocumented)
+    addUiRenderer(entity: Entity, ui: UiComponent, options?: UiRendererOptions): void;
     destroy(): void;
     removeUiRenderer(entity: Entity): void;
-    // (undocumented)
-    setUiRenderer(ui: UiComponent): void;
+    setUiRenderer(ui: UiComponent, options?: UiRendererOptions): void;
 }
 
 // @public (undocumented)
@@ -4656,6 +4654,12 @@ export interface UiLabelProps {
 // @public
 export type uint32 = number;
 
+// @public (undocumented)
+export type UiRendererOptions = {
+    virtualWidth: number;
+    virtualHeight: number;
+};
+
 // @public (undocumented)
 export const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
 

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dcl/playground-assets",
   "description": "",
-  "version": "7.17.1-21217092165.commit-1c2ff72",
+  "version": "7.17.1-21366395728.commit-ada88b6",
   "author": "Decentraland",
   "dependencies": {
-    "@dcl/js-runtime": "7.17.1-21217092165.commit-1c2ff72",
-    "@dcl/sdk": "7.17.1-21217092165.commit-1c2ff72"
+    "@dcl/js-runtime": "7.17.1-21366395728.commit-ada88b6",
+    "@dcl/sdk": "7.17.1-21366395728.commit-ada88b6"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.33.8"
@@ -32,5 +32,5 @@
   },
   "types": "./dist/index.d.ts",
   "typings": "./dist/index.d.ts",
-  "commit": "1c2ff7242cd11eb981666a8318f670c0b302813b"
+  "commit": "ada88b6fe8e93150056e0cade4b94e0c1e7dc850"
 }