@dcl/playground-assets 7.0.6-3939099974.commit-727d673 → 7.0.6-3987590195.commit-4fc1536

package/dist/alpha.d.ts

@@ -1,5 +1,10 @@
 import _m0 from 'protobufjs/minimal';
 
+/**
+ * @public
+ */
+export declare type AlignType = 'auto' | 'flex-start' | 'center' | 'flex-end' | 'stretch' | 'baseline' | 'space-between' | 'space-around';
+
 export declare const AMOUNT_VERSION_AVAILABLE: number;
 
 export declare const Animator: AnimatorComponentDefinitionExtended;
@@ -990,7 +995,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 +1113,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 +1200,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
@@ -1234,6 +1240,11 @@ export declare type DeleteEntityMessageBody = {
     entityId: Entity;
 };
 
+/**
+ * @public
+ */
+export declare type DisplayType = 'flex' | 'none';
+
 /**
  * @public
  */
@@ -1356,6 +1367,16 @@ export declare type ExcludeUndefined<T> = {
  */
 export declare const executeTask: (task: Task<unknown>) => void;
 
+/**
+ * @public
+ */
+export declare type FlexDirectionType = 'row' | 'column' | 'column-reverse' | 'row-reverse';
+
+/**
+ * @public
+ */
+export declare type FlexWrapType = 'wrap' | 'nowrap' | 'wrap-reverse';
+
 /** @public */
 export declare type FloatArray = number[];
 
@@ -1445,42 +1466,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 +1509,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 +1561,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;
 };
 
 /**
@@ -1794,12 +1818,17 @@ export declare namespace JSX {
     }
 }
 
+/**
+ * @public
+ */
+export declare type JustifyType = 'flex-start' | 'center' | 'flex-end' | 'space-between' | 'space-around' | 'space-evenly';
+
 export declare type Key = number | string;
 
 /**
  * @public
  */
-export declare function Label(props: EntityPropTypes & UiTextProps): ReactEcs.JSX.Element;
+export declare function Label(props: EntityPropTypes & UiLabelProps): ReactEcs.JSX.Element;
 
 export declare type Listeners = {
     onMouseDown?: Callback;
@@ -2837,6 +2866,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<{
@@ -2847,6 +2878,11 @@ export declare const onVideoEvent: Observable<{
     totalVideoLength: number;
 }>;
 
+/**
+ * @public
+ */
+export declare type OverflowType = 'hidden' | 'scroll' | 'visible';
+
 export declare interface PBAnimationState {
     name: string;
     clip: string;
@@ -3875,6 +3911,11 @@ export declare type Position = {
     left: PositionUnit;
 };
 
+/**
+ * @public
+ */
+export declare type PositionType = 'absolute' | 'relative';
+
 export declare type PositionUnit = `${number}px` | `${number}%` | number;
 
 export declare type PutComponentMessage = CrdtMessageHeader & PutComponentMessageBody;
@@ -4499,6 +4540,11 @@ export declare const enum TextAlignMode {
     TAM_BOTTOM_RIGHT = 8
 }
 
+/**
+ * @public
+ */
+export declare type TextAlignType = 'top-left' | 'top-center' | 'top-right' | 'middle-left' | 'middle-center' | 'middle-right' | 'bottom-left' | 'bottom-center' | 'bottom-right';
+
 /** @public */
 export declare const TextShape: ComponentDefinition<PBTextShape>;
 
@@ -4524,6 +4570,11 @@ export declare const enum TextureFilterMode {
     TFM_TRILINEAR = 2
 }
 
+/**
+ * @public
+ */
+export declare type TextureFilterType = 'point' | 'bi-linear' | 'tri-linear';
+
 /**
  * @public
  */
@@ -4538,6 +4589,22 @@ export declare type TextureHelper = {
     Avatar: (avatarTexture: AvatarTexture) => TextureUnion;
 };
 
+/**
+ * @public
+ * NINE_SLICES - https://docs.unity3d.com/Manual/UIE-USS-SupportedProperties.html (Slicing section)
+ * https://forum.unity.com/threads/how-does-slicing-in-ui-tookkit-works.1235863/
+ * https://docs.unity3d.com/Manual/9SliceSprites.html
+ * https://developer.mozilla.org/en-US/docs/Web/CSS/border-image-slice
+
+ * CENTER - CENTER enables the texture to be rendered centered in relation to the
+ * element. If the element is smaller than the texture then the background
+ * should use the element as stencil to cut off the out-of-bounds area
+
+ * STRETCH - STRETCH enables the texture to cover all the area of the container,
+ * adopting its aspect ratio.
+ */
+export declare type TextureMode = 'nine-slices' | 'center' | 'stretch';
+
 export declare interface TextureUnion {
     tex?: {
         $case: "texture";
@@ -4563,6 +4630,11 @@ export declare const enum TextureWrapMode {
     TWM_MIRROR_ONCE = 3
 }
 
+/**
+ * @public
+ */
+export declare type TextureWrapType = 'repeat' | 'clamp' | 'mirror' | 'mirror-once';
+
 /**
  * Constant used to convert a value to gamma space
  * @public
@@ -4632,7 +4704,11 @@ export declare type TransportMessage = Omit<ReceiveMessage, 'data'>;
  * @public
  */
 export declare type UiAvatarTexture = {
-    avatarTexture?: AvatarTexture;
+    avatarTexture?: {
+        userId: string;
+        wrapMode?: TextureWrapType;
+        filterMode?: TextureFilterType;
+    };
 };
 
 /** @public */
@@ -4641,12 +4717,17 @@ export declare const UiBackground: ComponentDefinition<PBUiBackground>;
 /**
  * @public
  */
-export declare type UiBackgroundProps = Partial<Omit<PBUiBackground, 'texture'>> & UiTextureUnion;
+export declare type UiBackgroundProps = {
+    color?: PBColor4 | undefined;
+    textureMode?: TextureMode;
+    textureSlices?: BorderRect | undefined;
+    uvs?: number[];
+} & UiTextureUnion;
 
 /**
  * @public
  */
-export declare type UiButtonProps = PBUiText & {
+export declare type UiButtonProps = UiLabelProps & {
     type?: 'primary' | 'secondary';
 };
 
@@ -4658,8 +4739,10 @@ export declare const UiDropdown: ComponentDefinition<PBUiDropdown>;
 /**
  * @public
  */
-export declare type UiDropdownProps = Partial<PBUiDropdown> & {
+export declare type UiDropdownProps = Partial<Omit<PBUiDropdown, 'textAlign' | 'font'>> & {
     onChange?(value: number): void;
+    font?: UiFontType;
+    textAlign?: TextAlignType;
 };
 
 /** @public */
@@ -4670,19 +4753,36 @@ export declare const UiDropdownResult: ComponentDefinition<PBUiDropdownResult>;
  */
 export declare function UiEntity(props: EntityPropTypes & Partial<CommonProps>): ReactEcs.JSX.Element;
 
+/**
+ * @public
+ */
+export declare type UiFontType = 'sans-serif' | 'serif' | 'monospace';
+
 /** @public */
 export declare const UiInput: ComponentDefinition<PBUiInput>;
 
 /**
  * @public
  */
-export declare type UiInputProps = PBUiInput & {
+export declare type UiInputProps = Omit<PBUiInput, 'font' | 'textAlign'> & {
     onChange?(value: string): void;
+    font?: UiFontType;
+    textAlign?: TextAlignType;
 };
 
 /** @public */
 export declare const UiInputResult: ComponentDefinition<PBUiInputResult>;
 
+/**
+ * @public
+ */
+export declare type UiLabelProps = Omit<PBUiText, 'textAlign' | 'font'> & {
+    /** default='middle-center' */
+    textAlign?: TextAlignType | undefined;
+    /** default='sans-serif' */
+    font?: UiFontType | undefined;
+};
+
 export declare type Uint32 = number;
 
 /**
@@ -4693,16 +4793,15 @@ export declare type uint32 = number;
 /** @public */
 export declare const UiText: ComponentDefinition<PBUiText>;
 
-/**
- * @public
- */
-export declare type UiTextProps = PBUiText;
-
 /**
  * @public
  */
 export declare type UiTexture = {
-    texture?: Texture;
+    texture?: {
+        src: string;
+        wrapMode?: TextureWrapType;
+        filterMode?: TextureFilterType;
+    };
 };
 
 /**
@@ -4717,14 +4816,14 @@ export declare const UiTransform: ComponentDefinition<PBUiTransform>;
  * @public
  */
 export declare interface UiTransformProps {
-    display?: YGDisplay;
+    display?: DisplayType;
     flex?: number;
-    justifyContent?: YGJustify;
-    positionType?: YGPositionType;
-    alignItems?: YGAlign;
-    alignSelf?: YGAlign;
-    alignContent?: YGAlign;
-    flexDirection?: YGFlexDirection;
+    justifyContent?: JustifyType;
+    positionType?: PositionType;
+    alignItems?: AlignType;
+    alignSelf?: AlignType;
+    alignContent?: AlignType;
+    flexDirection?: FlexDirectionType;
     position?: Partial<Position>;
     padding?: Partial<Position>;
     margin?: Partial<Position>;
@@ -4734,11 +4833,11 @@ export declare interface UiTransformProps {
     maxWidth?: PositionUnit;
     minHeight?: PositionUnit;
     maxHeight?: PositionUnit;
-    flexWrap?: YGWrap;
+    flexWrap?: FlexWrapType;
     flexBasis?: number;
     flexGrow?: number;
     flexShrink?: number;
-    overflow?: YGOverflow;
+    overflow?: OverflowType;
 }
 
 /**