@dcl/playground-assets 7.25.1-31496802383.commit-d3168c9 → 7.25.1-31605440953.commit-08dff78

package/dist/alpha.d.ts

@@ -8148,6 +8148,16 @@ export declare interface ReactBasedUiSystem {
     destroy(): void;
     /**
      * Set the main UI renderer. Optional virtual size defines the global UI scale factor.
+     *
+     * When no virtual size is provided, a platform default is used: 1600x720 on
+     * mobile, 1920x1080 otherwise. Providing an invalid size disables the virtual
+     * screen (no UI scaling): either a value \<= 0, or only one of the two
+     * dimensions, which additionally logs a warning. On mobile, a provided 16:9
+     * virtual size is overridden to 1600x720 to fit phone screens.
+     *
+     * The optional `screenInset` selects the screen area the UI is positioned in
+     * (see {@link UiScreenInset}); it defaults to `'device'`. Pass `'none'` to
+     * place the UI over the whole screen.
      */
     setUiRenderer(ui: UiComponent, options?: UiRendererOptions): void;
     /**
@@ -8162,7 +8172,10 @@ 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
+     * @param options - Optional virtual size used for UI scale factor when main UI has none.
+     *                  Defaults and the mobile 16:9 override behave as in {@link ReactBasedUiSystem.setUiRenderer}.
+     *                  `screenInset` is honored per renderer, independently of the main UI's value,
+     *                  and defaults to `'device'` here too.
      */
     addUiRenderer(entity: Entity, ui: UiComponent, options?: UiRendererOptions): void;
     /**
@@ -9675,10 +9688,28 @@ export declare type uint32 = number;
  * @public
  */
 export declare type UiRendererOptions = {
-    virtualWidth: number;
-    virtualHeight: number;
+    virtualWidth?: number;
+    virtualHeight?: number;
+    /**
+     * Screen area the renderer's UI is positioned in. Defaults to `'device'`, so UI
+     * stays inside the device safe area unless the creator opts out with `'none'`.
+     * Each renderer honors its own value, so the main UI and additional renderers
+     * can use different insets simultaneously.
+     */
+    screenInset?: UiScreenInset;
 };
 
+/**
+ * Screen area used to position a renderer's UI entities:
+ * - `'device'` (default): the device safe area (excludes notch, status bar,
+ *   rounded corners), reported in `UiCanvasInformation.screenInsetArea`.
+ * - `'interactable'`: the area free of the Explorer's native HUD (minimap, chat, ...),
+ *   reported in `UiCanvasInformation.interactableArea`.
+ * - `'none'`: the whole screen, with 0,0 at its top-left corner.
+ * @public
+ */
+export declare type UiScreenInset = 'device' | 'interactable' | 'none';
+
 /**
  * ScreenInsetArea component props
  *

package/dist/beta.d.ts

@@ -8120,6 +8120,16 @@ export declare interface ReactBasedUiSystem {
     destroy(): void;
     /**
      * Set the main UI renderer. Optional virtual size defines the global UI scale factor.
+     *
+     * When no virtual size is provided, a platform default is used: 1600x720 on
+     * mobile, 1920x1080 otherwise. Providing an invalid size disables the virtual
+     * screen (no UI scaling): either a value \<= 0, or only one of the two
+     * dimensions, which additionally logs a warning. On mobile, a provided 16:9
+     * virtual size is overridden to 1600x720 to fit phone screens.
+     *
+     * The optional `screenInset` selects the screen area the UI is positioned in
+     * (see {@link UiScreenInset}); it defaults to `'device'`. Pass `'none'` to
+     * place the UI over the whole screen.
      */
     setUiRenderer(ui: UiComponent, options?: UiRendererOptions): void;
     /**
@@ -8134,7 +8144,10 @@ 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
+     * @param options - Optional virtual size used for UI scale factor when main UI has none.
+     *                  Defaults and the mobile 16:9 override behave as in {@link ReactBasedUiSystem.setUiRenderer}.
+     *                  `screenInset` is honored per renderer, independently of the main UI's value,
+     *                  and defaults to `'device'` here too.
      */
     addUiRenderer(entity: Entity, ui: UiComponent, options?: UiRendererOptions): void;
     /**
@@ -9642,10 +9655,28 @@ export declare type uint32 = number;
  * @public
  */
 export declare type UiRendererOptions = {
-    virtualWidth: number;
-    virtualHeight: number;
+    virtualWidth?: number;
+    virtualHeight?: number;
+    /**
+     * Screen area the renderer's UI is positioned in. Defaults to `'device'`, so UI
+     * stays inside the device safe area unless the creator opts out with `'none'`.
+     * Each renderer honors its own value, so the main UI and additional renderers
+     * can use different insets simultaneously.
+     */
+    screenInset?: UiScreenInset;
 };
 
+/**
+ * Screen area used to position a renderer's UI entities:
+ * - `'device'` (default): the device safe area (excludes notch, status bar,
+ *   rounded corners), reported in `UiCanvasInformation.screenInsetArea`.
+ * - `'interactable'`: the area free of the Explorer's native HUD (minimap, chat, ...),
+ *   reported in `UiCanvasInformation.interactableArea`.
+ * - `'none'`: the whole screen, with 0,0 at its top-left corner.
+ * @public
+ */
+export declare type UiScreenInset = 'device' | 'interactable' | 'none';
+
 /**
  * ScreenInsetArea component props
  *

package/dist/index.bundled.d.ts

@@ -8120,6 +8120,16 @@ export declare interface ReactBasedUiSystem {
     destroy(): void;
     /**
      * Set the main UI renderer. Optional virtual size defines the global UI scale factor.
+     *
+     * When no virtual size is provided, a platform default is used: 1600x720 on
+     * mobile, 1920x1080 otherwise. Providing an invalid size disables the virtual
+     * screen (no UI scaling): either a value \<= 0, or only one of the two
+     * dimensions, which additionally logs a warning. On mobile, a provided 16:9
+     * virtual size is overridden to 1600x720 to fit phone screens.
+     *
+     * The optional `screenInset` selects the screen area the UI is positioned in
+     * (see {@link UiScreenInset}); it defaults to `'device'`. Pass `'none'` to
+     * place the UI over the whole screen.
      */
     setUiRenderer(ui: UiComponent, options?: UiRendererOptions): void;
     /**
@@ -8134,7 +8144,10 @@ 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
+     * @param options - Optional virtual size used for UI scale factor when main UI has none.
+     *                  Defaults and the mobile 16:9 override behave as in {@link ReactBasedUiSystem.setUiRenderer}.
+     *                  `screenInset` is honored per renderer, independently of the main UI's value,
+     *                  and defaults to `'device'` here too.
      */
     addUiRenderer(entity: Entity, ui: UiComponent, options?: UiRendererOptions): void;
     /**
@@ -9642,10 +9655,28 @@ export declare type uint32 = number;
  * @public
  */
 export declare type UiRendererOptions = {
-    virtualWidth: number;
-    virtualHeight: number;
+    virtualWidth?: number;
+    virtualHeight?: number;
+    /**
+     * Screen area the renderer's UI is positioned in. Defaults to `'device'`, so UI
+     * stays inside the device safe area unless the creator opts out with `'none'`.
+     * Each renderer honors its own value, so the main UI and additional renderers
+     * can use different insets simultaneously.
+     */
+    screenInset?: UiScreenInset;
 };
 
+/**
+ * Screen area used to position a renderer's UI entities:
+ * - `'device'` (default): the device safe area (excludes notch, status bar,
+ *   rounded corners), reported in `UiCanvasInformation.screenInsetArea`.
+ * - `'interactable'`: the area free of the Explorer's native HUD (minimap, chat, ...),
+ *   reported in `UiCanvasInformation.interactableArea`.
+ * - `'none'`: the whole screen, with 0,0 at its top-left corner.
+ * @public
+ */
+export declare type UiScreenInset = 'device' | 'interactable' | 'none';
+
 /**
  * ScreenInsetArea component props
  *