@dcl/playground-assets 7.23.4-26723618219.commit-ea97433 → 7.23.4-26955626649.commit-5d040fd

package/dist/alpha.d.ts

@@ -1488,14 +1488,16 @@ export declare namespace Composite {
     /** @public */
     export function toBinary(composite: Composite.Definition): Uint8Array;
     /**
-     * Instance a composite and returns its root entity
-     * @param compositeData - state serialized by the CRDT protocol
-     * @param getNextAvailableEntity - function that gives unused entities
-     * @param rootEntity - (optional) suggested mapped rootEntity for the composite
+     * Instance a composite and return its root entity.
+     * @param engine - the engine that will own the new entities
+     * @param compositeData - the composite resource to instance
+     * @param compositeProvider - provider used to resolve nested composite references
+     * @param options - instancing options (`rootEntity`, `entityMapping`, `alreadyRequestedSrc`)
+     * @returns the root entity of the instanced composite
      *
      * @public
      */
-    export function instance(engine: IEngine, compositeData: Composite.Resource, compositeProvider: CompositeProvider, options?: InstanceCompositeOptions): void;
+    export function instance(engine: IEngine, compositeData: Composite.Resource, compositeProvider: CompositeProvider, options?: InstanceCompositeOptions): Entity;
     /**
      * Resolve and normalize a composite path
      * @param src - the source path
@@ -1568,6 +1570,11 @@ export declare namespace CompositeDefinition {
  */
 export declare type CompositeProvider = {
     getCompositeOrNull(src: string): CompositeResource | null;
+    loadComposite?: (src: string) => Promise<CompositeResource>;
+    schemas?: Iterable<{
+        name: string;
+        jsonSchema: any;
+    }>;
 };
 
 /**
@@ -2276,6 +2283,13 @@ export declare function getComponentEntityTree<T>(engine: Pick<IEngine, 'getEnti
     parent?: Entity;
 }>): Generator<Entity>;
 
+/**
+ * Get the composite provider registered via setCompositeProvider. Returns null if
+ * no provider has been set.
+ * @public
+ */
+export declare function getCompositeProvider(): CompositeProvider | null;
+
 /**
  * @public
  * @deprecated composite is not being supported so far, please do not use this feature
@@ -6570,6 +6584,14 @@ export declare interface PBUiCanvasInformation {
      * on the contrary, if the chat UI is shown, the rect would be smaller.
      */
     interactableArea: BorderRect | undefined;
+    /**
+     * informs the sdk about the screen inset area (safe margins). these are the
+     * insets from each edge of the screen that are reserved by the device or
+     * platform UI (for example: the notch, status bar, home indicator, or rounded
+     * corners on mobile). scenes should avoid placing critical UI within these
+     * insets to ensure it is not occluded. on desktop this is typically (0, 0, 0, 0).
+     */
+    screenInsetArea?: BorderRect | undefined;
 }
 
 /**
@@ -8560,6 +8582,35 @@ export declare namespace Schemas {
     }) => void;
 }
 
+/**
+ *
+ * @public
+ * ScreenInsetArea component
+ *
+ * Constrains its children to the area inside the renderer-reported screen
+ * inset (safe margins). On mobile this is the area excluding the notch,
+ * status bar, home indicator and rounded corners. On desktop the insets are
+ * typically zero, so the container fills the canvas.
+ *
+ * The container is absolutely positioned with top/left/right/bottom matching
+ * the current `UiCanvasInformation.screenInsetArea`, so a child sized
+ * 100%x100% fills the safe area exactly.
+ *
+ * @example
+ * <ScreenInsetArea><MyHud /></ScreenInsetArea>
+ *
+ * @category Component
+ */
+export declare function ScreenInsetArea(props: UiScreenInsetAreaProps): ReactEcs.JSX.Element;
+
+/**
+ * Register the composite provider used to resolve composite files. Also registers
+ * any `provider.schemas` on the engine pre-seal so composites that reference those
+ * components can be instanced without further setup.
+ * @public
+ */
+export declare function setCompositeProvider(engine: IEngine, provider: CompositeProvider): void;
+
 /**
  * Sets a globalThis property as a polyfill (only if undefined/null).
  * @public
@@ -9415,6 +9466,28 @@ export declare type UiRendererOptions = {
     virtualHeight: number;
 };
 
+/**
+ * ScreenInsetArea component props
+ *
+ * The container reads the current `screenInsetArea` reported by the renderer
+ * via `UiCanvasInformation` (the device safe margins — notch, status bar,
+ * home indicator, rounded corners) and constrains its children to the area
+ * inside those insets using absolute positioning. Layout props that control
+ * the container's own position (`positionType`, `position`) are owned by the
+ * component and are not configurable from props — every other layout,
+ * background and event prop is forwarded as usual.
+ *
+ * @public
+ */
+export declare type UiScreenInsetAreaProps = Omit<EntityPropTypes, 'uiTransform'> & {
+    /**
+     * Layout overrides forwarded to the underlying entity. The
+     * `positionType` and `position` fields are reserved by the container and
+     * any value provided here is ignored.
+     */
+    uiTransform?: Omit<NonNullable<EntityPropTypes['uiTransform']>, 'positionType' | 'position'>;
+};
+
 /** @public */
 export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
 

package/dist/beta.d.ts

@@ -1488,14 +1488,16 @@ export declare namespace Composite {
     /** @public */
     export function toBinary(composite: Composite.Definition): Uint8Array;
     /**
-     * Instance a composite and returns its root entity
-     * @param compositeData - state serialized by the CRDT protocol
-     * @param getNextAvailableEntity - function that gives unused entities
-     * @param rootEntity - (optional) suggested mapped rootEntity for the composite
+     * Instance a composite and return its root entity.
+     * @param engine - the engine that will own the new entities
+     * @param compositeData - the composite resource to instance
+     * @param compositeProvider - provider used to resolve nested composite references
+     * @param options - instancing options (`rootEntity`, `entityMapping`, `alreadyRequestedSrc`)
+     * @returns the root entity of the instanced composite
      *
      * @public
      */
-    export function instance(engine: IEngine, compositeData: Composite.Resource, compositeProvider: CompositeProvider, options?: InstanceCompositeOptions): void;
+    export function instance(engine: IEngine, compositeData: Composite.Resource, compositeProvider: CompositeProvider, options?: InstanceCompositeOptions): Entity;
     /**
      * Resolve and normalize a composite path
      * @param src - the source path
@@ -1568,6 +1570,11 @@ export declare namespace CompositeDefinition {
  */
 export declare type CompositeProvider = {
     getCompositeOrNull(src: string): CompositeResource | null;
+    loadComposite?: (src: string) => Promise<CompositeResource>;
+    schemas?: Iterable<{
+        name: string;
+        jsonSchema: any;
+    }>;
 };
 
 /**
@@ -2276,6 +2283,13 @@ export declare function getComponentEntityTree<T>(engine: Pick<IEngine, 'getEnti
     parent?: Entity;
 }>): Generator<Entity>;
 
+/**
+ * Get the composite provider registered via setCompositeProvider. Returns null if
+ * no provider has been set.
+ * @public
+ */
+export declare function getCompositeProvider(): CompositeProvider | null;
+
 /**
  * @public
  * @deprecated composite is not being supported so far, please do not use this feature
@@ -6542,6 +6556,14 @@ export declare interface PBUiCanvasInformation {
      * on the contrary, if the chat UI is shown, the rect would be smaller.
      */
     interactableArea: BorderRect | undefined;
+    /**
+     * informs the sdk about the screen inset area (safe margins). these are the
+     * insets from each edge of the screen that are reserved by the device or
+     * platform UI (for example: the notch, status bar, home indicator, or rounded
+     * corners on mobile). scenes should avoid placing critical UI within these
+     * insets to ensure it is not occluded. on desktop this is typically (0, 0, 0, 0).
+     */
+    screenInsetArea?: BorderRect | undefined;
 }
 
 /**
@@ -8532,6 +8554,35 @@ export declare namespace Schemas {
     }) => void;
 }
 
+/**
+ *
+ * @public
+ * ScreenInsetArea component
+ *
+ * Constrains its children to the area inside the renderer-reported screen
+ * inset (safe margins). On mobile this is the area excluding the notch,
+ * status bar, home indicator and rounded corners. On desktop the insets are
+ * typically zero, so the container fills the canvas.
+ *
+ * The container is absolutely positioned with top/left/right/bottom matching
+ * the current `UiCanvasInformation.screenInsetArea`, so a child sized
+ * 100%x100% fills the safe area exactly.
+ *
+ * @example
+ * <ScreenInsetArea><MyHud /></ScreenInsetArea>
+ *
+ * @category Component
+ */
+export declare function ScreenInsetArea(props: UiScreenInsetAreaProps): ReactEcs.JSX.Element;
+
+/**
+ * Register the composite provider used to resolve composite files. Also registers
+ * any `provider.schemas` on the engine pre-seal so composites that reference those
+ * components can be instanced without further setup.
+ * @public
+ */
+export declare function setCompositeProvider(engine: IEngine, provider: CompositeProvider): void;
+
 /**
  * Sets a globalThis property as a polyfill (only if undefined/null).
  * @public
@@ -9382,6 +9433,28 @@ export declare type UiRendererOptions = {
     virtualHeight: number;
 };
 
+/**
+ * ScreenInsetArea component props
+ *
+ * The container reads the current `screenInsetArea` reported by the renderer
+ * via `UiCanvasInformation` (the device safe margins — notch, status bar,
+ * home indicator, rounded corners) and constrains its children to the area
+ * inside those insets using absolute positioning. Layout props that control
+ * the container's own position (`positionType`, `position`) are owned by the
+ * component and are not configurable from props — every other layout,
+ * background and event prop is forwarded as usual.
+ *
+ * @public
+ */
+export declare type UiScreenInsetAreaProps = Omit<EntityPropTypes, 'uiTransform'> & {
+    /**
+     * Layout overrides forwarded to the underlying entity. The
+     * `positionType` and `position` fields are reserved by the container and
+     * any value provided here is ignored.
+     */
+    uiTransform?: Omit<NonNullable<EntityPropTypes['uiTransform']>, 'positionType' | 'position'>;
+};
+
 /** @public */
 export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
 

package/dist/index.bundled.d.ts

@@ -1488,14 +1488,16 @@ export declare namespace Composite {
     /** @public */
     export function toBinary(composite: Composite.Definition): Uint8Array;
     /**
-     * Instance a composite and returns its root entity
-     * @param compositeData - state serialized by the CRDT protocol
-     * @param getNextAvailableEntity - function that gives unused entities
-     * @param rootEntity - (optional) suggested mapped rootEntity for the composite
+     * Instance a composite and return its root entity.
+     * @param engine - the engine that will own the new entities
+     * @param compositeData - the composite resource to instance
+     * @param compositeProvider - provider used to resolve nested composite references
+     * @param options - instancing options (`rootEntity`, `entityMapping`, `alreadyRequestedSrc`)
+     * @returns the root entity of the instanced composite
      *
      * @public
      */
-    export function instance(engine: IEngine, compositeData: Composite.Resource, compositeProvider: CompositeProvider, options?: InstanceCompositeOptions): void;
+    export function instance(engine: IEngine, compositeData: Composite.Resource, compositeProvider: CompositeProvider, options?: InstanceCompositeOptions): Entity;
     /**
      * Resolve and normalize a composite path
      * @param src - the source path
@@ -1568,6 +1570,11 @@ export declare namespace CompositeDefinition {
  */
 export declare type CompositeProvider = {
     getCompositeOrNull(src: string): CompositeResource | null;
+    loadComposite?: (src: string) => Promise<CompositeResource>;
+    schemas?: Iterable<{
+        name: string;
+        jsonSchema: any;
+    }>;
 };
 
 /**
@@ -2276,6 +2283,13 @@ export declare function getComponentEntityTree<T>(engine: Pick<IEngine, 'getEnti
     parent?: Entity;
 }>): Generator<Entity>;
 
+/**
+ * Get the composite provider registered via setCompositeProvider. Returns null if
+ * no provider has been set.
+ * @public
+ */
+export declare function getCompositeProvider(): CompositeProvider | null;
+
 /**
  * @public
  * @deprecated composite is not being supported so far, please do not use this feature
@@ -6542,6 +6556,14 @@ export declare interface PBUiCanvasInformation {
      * on the contrary, if the chat UI is shown, the rect would be smaller.
      */
     interactableArea: BorderRect | undefined;
+    /**
+     * informs the sdk about the screen inset area (safe margins). these are the
+     * insets from each edge of the screen that are reserved by the device or
+     * platform UI (for example: the notch, status bar, home indicator, or rounded
+     * corners on mobile). scenes should avoid placing critical UI within these
+     * insets to ensure it is not occluded. on desktop this is typically (0, 0, 0, 0).
+     */
+    screenInsetArea?: BorderRect | undefined;
 }
 
 /**
@@ -8532,6 +8554,35 @@ export declare namespace Schemas {
     }) => void;
 }
 
+/**
+ *
+ * @public
+ * ScreenInsetArea component
+ *
+ * Constrains its children to the area inside the renderer-reported screen
+ * inset (safe margins). On mobile this is the area excluding the notch,
+ * status bar, home indicator and rounded corners. On desktop the insets are
+ * typically zero, so the container fills the canvas.
+ *
+ * The container is absolutely positioned with top/left/right/bottom matching
+ * the current `UiCanvasInformation.screenInsetArea`, so a child sized
+ * 100%x100% fills the safe area exactly.
+ *
+ * @example
+ * <ScreenInsetArea><MyHud /></ScreenInsetArea>
+ *
+ * @category Component
+ */
+export declare function ScreenInsetArea(props: UiScreenInsetAreaProps): ReactEcs.JSX.Element;
+
+/**
+ * Register the composite provider used to resolve composite files. Also registers
+ * any `provider.schemas` on the engine pre-seal so composites that reference those
+ * components can be instanced without further setup.
+ * @public
+ */
+export declare function setCompositeProvider(engine: IEngine, provider: CompositeProvider): void;
+
 /**
  * Sets a globalThis property as a polyfill (only if undefined/null).
  * @public
@@ -9382,6 +9433,28 @@ export declare type UiRendererOptions = {
     virtualHeight: number;
 };
 
+/**
+ * ScreenInsetArea component props
+ *
+ * The container reads the current `screenInsetArea` reported by the renderer
+ * via `UiCanvasInformation` (the device safe margins — notch, status bar,
+ * home indicator, rounded corners) and constrains its children to the area
+ * inside those insets using absolute positioning. Layout props that control
+ * the container's own position (`positionType`, `position`) are owned by the
+ * component and are not configurable from props — every other layout,
+ * background and event prop is forwarded as usual.
+ *
+ * @public
+ */
+export declare type UiScreenInsetAreaProps = Omit<EntityPropTypes, 'uiTransform'> & {
+    /**
+     * Layout overrides forwarded to the underlying entity. The
+     * `positionType` and `position` fields are reserved by the container and
+     * any value provided here is ignored.
+     */
+    uiTransform?: Omit<NonNullable<EntityPropTypes['uiTransform']>, 'positionType' | 'position'>;
+};
+
 /** @public */
 export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;