@dcl/playground-assets 7.0.6-3874914632.commit-eb56237 → 7.0.6-3942933325.commit-70f967f

package/dist/alpha.d.ts

@@ -990,7 +990,8 @@ export declare type CommonProps = {
  * @public
  */
 export declare type ComponentDefinition<T> = {
-    _id: number;
+    readonly componentId: number;
+    readonly componentName: string;
     /**
      * Return the default value of the current component
      */
@@ -1107,6 +1108,8 @@ export declare enum CrdtMessageType {
     MAX_MESSAGE_TYPE = 4
 }
 
+export declare function createComponentDefinitionFromSchema<T>(componentName: string, componentId: number, schema: ISchema<T>): ComponentDefinition<T>;
+
 export declare function createEthereumProvider(): {
     send(message: RPCSendableMessage, callback?: ((error: Error | null, result?: any) => void) | undefined): void;
     sendAsync(message: RPCSendableMessage, callback: (error: Error | null, result?: any) => void): void;
@@ -1192,8 +1195,6 @@ export declare type DeepReadonlyObject<T> = {
  */
 export declare type DeepReadonlySet<T> = ReadonlySet<DeepReadonly<T>>;
 
-export declare function defineComponent<T>(componentId: number, spec: ISchema<T>): ComponentDefinition<T>;
-
 /**
  * Constant used to convert from Euler degrees to radians
  * @public
@@ -1445,42 +1446,40 @@ export declare type IEngine = {
     removeSystem(selector: string | SystemFn): boolean;
     /**
      * Registers a custom component definition.
-     * @param component - The component definition
-     * @param componentId - unique id to identify the component, if the component id already exist, it will fail.
+     * @param componentName - unique name to identify the component, a hash is calculated for it, it will fail if the hash has collisions.
+     * @param componentDefinition - The component definition
      */
-    registerCustomComponent<T>(component: ComponentDefinition<T>, componentId: number): ComponentDefinition<T>;
+    registerComponentDefinition<T>(componentName: string, componentDefinition: ComponentDefinition<T>): ComponentDefinition<T>;
     /**
      * Define a component and add it to the engine.
      * @param spec - An object with schema fields
-     * @param componentId - unique id to identify the component, if the component id already exist, it will fail.
+     * @param componentName - unique name to identify the component, a hash is calculated for it, it will fail if the hash has collisions.
      * @param constructorDefault - the initial value prefilled when a component is created without a value
      * @returns The component definition
      *
      * ```ts
-     * const DoorComponentId = 10017
-     * const Door = engine.defineComponent({
+     * const Door = engine.defineComponent("my-scene::Door", {
      *   id: Schemas.Int,
      *   name: Schemas.String
-     * }, DoorComponentId)
-     *
+     * })
      * ```
      */
-    defineComponent<T extends Spec>(spec: T, componentId: number, constructorDefault?: Partial<MapResult<T>>): MapComponentDefinition<MapResult<T>>;
+    defineComponent<T extends Spec>(componentName: string, spec: T, constructorDefault?: Partial<MapResult<T>>): MapComponentDefinition<MapResult<T>>;
     /**
      * Define a component and add it to the engine.
+     * @param componentName - unique name to identify the component, a hash is calculated for it, it will fail if the hash has collisions.
      * @param spec - An object with schema fields
-     * @param componentId - unique id to identify the component, if the component id already exist, it will fail.
      * @returns The component definition
      *
      * ```ts
      * const StateComponentId = 10023
-     * const StateComponent = engine.defineComponent(Schemas.Bool, VisibleComponentId)
+     * const StateComponent = engine.defineComponentFromSchema("my-lib::VisibleComponent", Schemas.Bool)
      * ```
      */
-    defineComponentFromSchema<T>(spec: ISchema<T>, componentId: number): ComponentDefinition<T>;
+    defineComponentFromSchema<T>(componentName: string, spec: ISchema<T>): ComponentDefinition<T>;
     /**
      * Get the component definition from the component id.
-     * @param componentId - component number used to identify the component descriptor
+     * @param componentId - component number or name used to identify the component descriptor
      * @returns the component definition, throw an error if it doesn't exist
      * ```ts
      * const StateComponentId = 10023
@@ -1490,7 +1489,7 @@ export declare type IEngine = {
     getComponent<T>(componentId: number): ComponentDefinition<T>;
     /**
      * Get the component definition from the component id.
-     * @param componentId - component number used to identify the component descriptor
+     * @param componentId - component number or name used to identify the component descriptor
      * @returns the component definition or null if its not founded
      * ```ts
      * const StateComponentId = 10023
@@ -1542,6 +1541,11 @@ export declare type IEngine = {
      * Iterator of registered components
      */
     componentsIter(): Iterable<ComponentDefinition<unknown>>;
+    /**
+     * Seals the engine components. It is used to clearly define the scope of the
+     * components that will be available to this engine and to run optimizations.
+     */
+    seal(): void;
 };
 
 /**
@@ -2837,6 +2841,8 @@ export declare const onRealmChangedObservable: Observable<{
 
 export declare const onSceneReadyObservable: Observable<unknown>;
 
+export declare function onStart(): Promise<void>;
+
 export declare function onUpdate(deltaTime: number): Promise<void>;
 
 export declare const onVideoEvent: Observable<{

package/dist/beta.d.ts

@@ -990,7 +990,8 @@ export declare type CommonProps = {
  * @public
  */
 export declare type ComponentDefinition<T> = {
-    _id: number;
+    readonly componentId: number;
+    readonly componentName: string;
     /**
      * Return the default value of the current component
      */
@@ -1107,6 +1108,8 @@ export declare enum CrdtMessageType {
     MAX_MESSAGE_TYPE = 4
 }
 
+export declare function createComponentDefinitionFromSchema<T>(componentName: string, componentId: number, schema: ISchema<T>): ComponentDefinition<T>;
+
 export declare function createEthereumProvider(): {
     send(message: RPCSendableMessage, callback?: ((error: Error | null, result?: any) => void) | undefined): void;
     sendAsync(message: RPCSendableMessage, callback: (error: Error | null, result?: any) => void): void;
@@ -1192,8 +1195,6 @@ export declare type DeepReadonlyObject<T> = {
  */
 export declare type DeepReadonlySet<T> = ReadonlySet<DeepReadonly<T>>;
 
-export declare function defineComponent<T>(componentId: number, spec: ISchema<T>): ComponentDefinition<T>;
-
 /**
  * Constant used to convert from Euler degrees to radians
  * @public
@@ -1445,42 +1446,40 @@ export declare type IEngine = {
     removeSystem(selector: string | SystemFn): boolean;
     /**
      * Registers a custom component definition.
-     * @param component - The component definition
-     * @param componentId - unique id to identify the component, if the component id already exist, it will fail.
+     * @param componentName - unique name to identify the component, a hash is calculated for it, it will fail if the hash has collisions.
+     * @param componentDefinition - The component definition
      */
-    registerCustomComponent<T>(component: ComponentDefinition<T>, componentId: number): ComponentDefinition<T>;
+    registerComponentDefinition<T>(componentName: string, componentDefinition: ComponentDefinition<T>): ComponentDefinition<T>;
     /**
      * Define a component and add it to the engine.
      * @param spec - An object with schema fields
-     * @param componentId - unique id to identify the component, if the component id already exist, it will fail.
+     * @param componentName - unique name to identify the component, a hash is calculated for it, it will fail if the hash has collisions.
      * @param constructorDefault - the initial value prefilled when a component is created without a value
      * @returns The component definition
      *
      * ```ts
-     * const DoorComponentId = 10017
-     * const Door = engine.defineComponent({
+     * const Door = engine.defineComponent("my-scene::Door", {
      *   id: Schemas.Int,
      *   name: Schemas.String
-     * }, DoorComponentId)
-     *
+     * })
      * ```
      */
-    defineComponent<T extends Spec>(spec: T, componentId: number, constructorDefault?: Partial<MapResult<T>>): MapComponentDefinition<MapResult<T>>;
+    defineComponent<T extends Spec>(componentName: string, spec: T, constructorDefault?: Partial<MapResult<T>>): MapComponentDefinition<MapResult<T>>;
     /**
      * Define a component and add it to the engine.
+     * @param componentName - unique name to identify the component, a hash is calculated for it, it will fail if the hash has collisions.
      * @param spec - An object with schema fields
-     * @param componentId - unique id to identify the component, if the component id already exist, it will fail.
      * @returns The component definition
      *
      * ```ts
      * const StateComponentId = 10023
-     * const StateComponent = engine.defineComponent(Schemas.Bool, VisibleComponentId)
+     * const StateComponent = engine.defineComponentFromSchema("my-lib::VisibleComponent", Schemas.Bool)
      * ```
      */
-    defineComponentFromSchema<T>(spec: ISchema<T>, componentId: number): ComponentDefinition<T>;
+    defineComponentFromSchema<T>(componentName: string, spec: ISchema<T>): ComponentDefinition<T>;
     /**
      * Get the component definition from the component id.
-     * @param componentId - component number used to identify the component descriptor
+     * @param componentId - component number or name used to identify the component descriptor
      * @returns the component definition, throw an error if it doesn't exist
      * ```ts
      * const StateComponentId = 10023
@@ -1490,7 +1489,7 @@ export declare type IEngine = {
     getComponent<T>(componentId: number): ComponentDefinition<T>;
     /**
      * Get the component definition from the component id.
-     * @param componentId - component number used to identify the component descriptor
+     * @param componentId - component number or name used to identify the component descriptor
      * @returns the component definition or null if its not founded
      * ```ts
      * const StateComponentId = 10023
@@ -1542,6 +1541,11 @@ export declare type IEngine = {
      * Iterator of registered components
      */
     componentsIter(): Iterable<ComponentDefinition<unknown>>;
+    /**
+     * Seals the engine components. It is used to clearly define the scope of the
+     * components that will be available to this engine and to run optimizations.
+     */
+    seal(): void;
 };
 
 /**
@@ -2837,6 +2841,8 @@ export declare const onRealmChangedObservable: Observable<{
 
 export declare const onSceneReadyObservable: Observable<unknown>;
 
+export declare function onStart(): Promise<void>;
+
 export declare function onUpdate(deltaTime: number): Promise<void>;
 
 export declare const onVideoEvent: Observable<{

package/dist/index.bundled.d.ts

@@ -990,7 +990,8 @@ export declare type CommonProps = {
  * @public
  */
 export declare type ComponentDefinition<T> = {
-    _id: number;
+    readonly componentId: number;
+    readonly componentName: string;
     /**
      * Return the default value of the current component
      */
@@ -1107,6 +1108,8 @@ export declare enum CrdtMessageType {
     MAX_MESSAGE_TYPE = 4
 }
 
+export declare function createComponentDefinitionFromSchema<T>(componentName: string, componentId: number, schema: ISchema<T>): ComponentDefinition<T>;
+
 export declare function createEthereumProvider(): {
     send(message: RPCSendableMessage, callback?: ((error: Error | null, result?: any) => void) | undefined): void;
     sendAsync(message: RPCSendableMessage, callback: (error: Error | null, result?: any) => void): void;
@@ -1192,8 +1195,6 @@ export declare type DeepReadonlyObject<T> = {
  */
 export declare type DeepReadonlySet<T> = ReadonlySet<DeepReadonly<T>>;
 
-export declare function defineComponent<T>(componentId: number, spec: ISchema<T>): ComponentDefinition<T>;
-
 /**
  * Constant used to convert from Euler degrees to radians
  * @public
@@ -1445,42 +1446,40 @@ export declare type IEngine = {
     removeSystem(selector: string | SystemFn): boolean;
     /**
      * Registers a custom component definition.
-     * @param component - The component definition
-     * @param componentId - unique id to identify the component, if the component id already exist, it will fail.
+     * @param componentName - unique name to identify the component, a hash is calculated for it, it will fail if the hash has collisions.
+     * @param componentDefinition - The component definition
      */
-    registerCustomComponent<T>(component: ComponentDefinition<T>, componentId: number): ComponentDefinition<T>;
+    registerComponentDefinition<T>(componentName: string, componentDefinition: ComponentDefinition<T>): ComponentDefinition<T>;
     /**
      * Define a component and add it to the engine.
      * @param spec - An object with schema fields
-     * @param componentId - unique id to identify the component, if the component id already exist, it will fail.
+     * @param componentName - unique name to identify the component, a hash is calculated for it, it will fail if the hash has collisions.
      * @param constructorDefault - the initial value prefilled when a component is created without a value
      * @returns The component definition
      *
      * ```ts
-     * const DoorComponentId = 10017
-     * const Door = engine.defineComponent({
+     * const Door = engine.defineComponent("my-scene::Door", {
      *   id: Schemas.Int,
      *   name: Schemas.String
-     * }, DoorComponentId)
-     *
+     * })
      * ```
      */
-    defineComponent<T extends Spec>(spec: T, componentId: number, constructorDefault?: Partial<MapResult<T>>): MapComponentDefinition<MapResult<T>>;
+    defineComponent<T extends Spec>(componentName: string, spec: T, constructorDefault?: Partial<MapResult<T>>): MapComponentDefinition<MapResult<T>>;
     /**
      * Define a component and add it to the engine.
+     * @param componentName - unique name to identify the component, a hash is calculated for it, it will fail if the hash has collisions.
      * @param spec - An object with schema fields
-     * @param componentId - unique id to identify the component, if the component id already exist, it will fail.
      * @returns The component definition
      *
      * ```ts
      * const StateComponentId = 10023
-     * const StateComponent = engine.defineComponent(Schemas.Bool, VisibleComponentId)
+     * const StateComponent = engine.defineComponentFromSchema("my-lib::VisibleComponent", Schemas.Bool)
      * ```
      */
-    defineComponentFromSchema<T>(spec: ISchema<T>, componentId: number): ComponentDefinition<T>;
+    defineComponentFromSchema<T>(componentName: string, spec: ISchema<T>): ComponentDefinition<T>;
     /**
      * Get the component definition from the component id.
-     * @param componentId - component number used to identify the component descriptor
+     * @param componentId - component number or name used to identify the component descriptor
      * @returns the component definition, throw an error if it doesn't exist
      * ```ts
      * const StateComponentId = 10023
@@ -1490,7 +1489,7 @@ export declare type IEngine = {
     getComponent<T>(componentId: number): ComponentDefinition<T>;
     /**
      * Get the component definition from the component id.
-     * @param componentId - component number used to identify the component descriptor
+     * @param componentId - component number or name used to identify the component descriptor
      * @returns the component definition or null if its not founded
      * ```ts
      * const StateComponentId = 10023
@@ -1542,6 +1541,11 @@ export declare type IEngine = {
      * Iterator of registered components
      */
     componentsIter(): Iterable<ComponentDefinition<unknown>>;
+    /**
+     * Seals the engine components. It is used to clearly define the scope of the
+     * components that will be available to this engine and to run optimizations.
+     */
+    seal(): void;
 };
 
 /**
@@ -2837,6 +2841,8 @@ export declare const onRealmChangedObservable: Observable<{
 
 export declare const onSceneReadyObservable: Observable<unknown>;
 
+export declare function onStart(): Promise<void>;
+
 export declare function onUpdate(deltaTime: number): Promise<void>;
 
 export declare const onVideoEvent: Observable<{