@dcl/playground-assets 7.0.6-3803395793.commit-999a6b9 → 7.0.6-3808564125.commit-7a2650b

package/dist/playground-assets.d.ts

@@ -93,6 +93,27 @@ export declare const AvatarTexture: {
     decode(input: _m0.Reader | Uint8Array, length?: number): AvatarTexture;
 };
 
+export declare const enum BackgroundTextureMode {
+    /**
+     * 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
+     */
+    NINE_SLICES = 0,
+    /**
+     * 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
+     */
+    CENTER = 1,
+    /**
+     * STRETCH - STRETCH enables the texture to cover all the area of the container,
+     * adopting its aspect ratio.
+     */
+    STRETCH = 2
+}
+
 /** @public */
 export declare const Billboard: ComponentDefinition<PBBillboard>;
 
@@ -101,6 +122,27 @@ export declare const enum BillboardMode {
     BM_Y_AXE = 1
 }
 
+/** Defines indents from respective edges */
+export declare interface BorderRect {
+    top: number;
+    left: number;
+    right: number;
+    bottom: number;
+}
+
+/**
+ * Internal
+ */
+export declare const BorderRect: {
+    encode(message: BorderRect, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): BorderRect;
+};
+
+/**
+ * @public
+ */
+export declare function Button(props: EntityPropTypes & UiButtonProps): ReactEcs.JSX.Element;
+
 /**
  * @public
  */
@@ -148,6 +190,7 @@ export declare type ByteBuffer = {
     readUint32(): number;
     readUint64(): bigint;
     readBuffer(): Uint8Array;
+    readUtf8String(): string;
     /**
      * Writing purpose
      */
@@ -175,6 +218,7 @@ export declare type ByteBuffer = {
      * @returns The subarray from 0 to offset.
      */
     toCopiedBinary(): Uint8Array;
+    writeUtf8String(value: string, writeLength?: boolean): void;
     writeBuffer(value: Uint8Array, writeLength?: boolean): void;
     writeFloat32(value: number): void;
     writeFloat64(value: number): void;
@@ -208,6 +252,8 @@ export declare type ByteBuffer = {
     setUint64(offset: number, value: bigint): void;
 };
 
+export declare type Callback = () => void;
+
 /** @public */
 export declare const CameraMode: ComponentDefinition<PBCameraMode>;
 
@@ -221,7 +267,7 @@ export declare const enum CameraType {
 
 export declare const CANVAS_ROOT_ENTITY = 0;
 
-export declare type Children = any;
+export declare type Children = unknown;
 
 export declare const enum ColliderLayer {
     CL_NONE = 0,
@@ -1009,10 +1055,6 @@ export declare type ComponentSchema<T extends [ComponentDefinition<any>, ...Comp
     [K in keyof T]: T[K] extends ComponentDefinition<any> ? ReturnType<T[K]['getMutable']> : never;
 };
 
-export declare function Container({ width, height, children }: ContainerPropTypes): ReactEcs.JSX.Element;
-
-export declare type ContainerPropTypes = Partial<CommonProps> & EntityPropTypes['uiTransform'];
-
 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;
@@ -1046,7 +1088,7 @@ export declare function createPointerEventSystem(engine: IEngine, inputSystem: I
      * @param cb - Function to execute when onPointerDown fires
      * @param opts - Opts to trigger Feedback and Button
      */
-    onClick(entity: Entity, cb: EventSystemCallback, opts?: EventSystemOptions): void;
+    onClick(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions>): void;
     /**
      * @public
      * Execute callback when the user press the InputButton pointing at the entity
@@ -1054,7 +1096,7 @@ export declare function createPointerEventSystem(engine: IEngine, inputSystem: I
      * @param cb - Function to execute when click fires
      * @param opts - Opts to trigger Feedback and Button
      */
-    onPointerDown(entity: Entity, cb: EventSystemCallback, opts?: EventSystemOptions): void;
+    onPointerDown(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions>): void;
     /**
      * @public
      * Execute callback when the user releases the InputButton pointing at the entity
@@ -1062,7 +1104,7 @@ export declare function createPointerEventSystem(engine: IEngine, inputSystem: I
      * @param cb - Function to execute when click fires
      * @param opts - Opts to trigger Feedback and Button
      */
-    onPointerUp(entity: Entity, cb: EventSystemCallback, opts?: EventSystemOptions): void;
+    onPointerUp(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions>): void;
 };
 
 export declare function createReactBasedUiSystem(engine: IEngine, pointerSystem: PointerEventsSystem): ReactBasedUiSystem;
@@ -1118,8 +1160,13 @@ export declare function defineComponent<T>(componentId: number, spec: ISchema<T>
  */
 export declare const DEG2RAD: number;
 
+/**
+ * @public
+ */
+export declare function Dropdown(props: EntityPropTypes & UiDropdownProps): ReactEcs.JSX.Element;
+
 export declare type EcsElements = {
-    entity: Partial<Omit<EntityComponents, 'onClick'> & CommonProps>;
+    entity: Partial<EntityComponents & CommonProps>;
 };
 
 /**
@@ -1143,7 +1190,10 @@ export declare type EntityComponents = {
     uiTransform: PBUiTransform;
     uiText: PBUiText;
     uiBackground: PBUiBackground;
-    onClick: EventSystemCallback;
+    uiInput: PBUiInput;
+    uiDropdown: PBUiDropdown;
+    onMouseDown: Callback;
+    onMouseUp: Callback;
 };
 
 export declare function EntityContainer(): {
@@ -1158,9 +1208,8 @@ export declare function EntityContainer(): {
  */
 export declare type EntityPropTypes = {
     uiTransform?: UiTransformProps;
-    uiText?: PBUiText;
-    uiBackground?: PBUiBackground;
-};
+    uiBackground?: UiBackgroundProps;
+} & Listeners;
 
 /**
  * Constant used to define the minimal number value in Babylon.js
@@ -1171,9 +1220,10 @@ export declare const Epsilon = 0.000001;
 export declare type EventSystemCallback = (event: PBPointerEventsResult_PointerCommand) => void;
 
 export declare type EventSystemOptions = {
-    button?: InputAction;
+    button: InputAction;
     hoverText?: string;
     maxDistance?: number;
+    showFeedback?: boolean;
 };
 
 /** Excludes property keys from T where the property is assignable to U */
@@ -1547,6 +1597,11 @@ export declare type IncludeUndefined<T> = {
     [P in keyof T]: undefined extends T[P] ? P : never;
 }[keyof T];
 
+/**
+ * @public
+ */
+export declare function Input(props: EntityPropTypes & Partial<UiInputProps>): ReactEcs.JSX.Element;
+
 export declare const enum InputAction {
     IA_POINTER = 0,
     IA_PRIMARY = 1,
@@ -1595,11 +1650,10 @@ export declare type ISchema<T = any> = {
     extend?: (base?: T) => T;
 };
 
-export declare const isListener: (key: string) => key is "onClick";
+export declare const isListener: (key: string) => key is keyof Listeners;
 
 export declare namespace JSX {
-    export interface Element {
-    }
+    export type Element = {} | null;
     export type IntrinsicElements = EcsElements;
     export interface Component {
     }
@@ -1607,8 +1661,14 @@ export declare namespace JSX {
 
 export declare type Key = number | string;
 
+/**
+ * @public
+ */
+export declare function Label(props: EntityPropTypes & UiTextProps): ReactEcs.JSX.Element;
+
 export declare type Listeners = {
-    onClick?: EventSystemCallback;
+    onMouseDown?: Callback;
+    onMouseUp?: Callback;
 };
 
 export declare interface MapComponentDefinition<T> extends ComponentDefinition<T> {
@@ -3093,82 +3153,82 @@ export declare const PBNftShape: {
     decode(input: _m0.Reader | Uint8Array, length?: number): PBNftShape;
 };
 
-/** the renderer will set this component to the root entity once per frame with all the events */
-export declare interface PBPointerEventsResult {
-    /** a list of the last N pointer commands (from the engine) */
-    commands: PBPointerEventsResult_PointerCommand[];
+export declare interface PBPointerEvents {
+    pointerEvents: PBPointerEvents_Entry[];
 }
 
 /**
  * Internal
  */
-export declare const PBPointerEventsResult: {
-    encode(message: PBPointerEventsResult, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBPointerEventsResult;
+export declare const PBPointerEvents: {
+    encode(message: PBPointerEvents, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): PBPointerEvents;
 };
 
-/** this message represents a pointer event, used both for UP and DOWN actions */
-export declare interface PBPointerEventsResult_PointerCommand {
-    /** identifier of the input */
-    button: InputAction;
-    hit: RaycastHit | undefined;
-    state: PointerEventType;
-    /** could be a Lamport timestamp */
-    timestamp: number;
-    /** if the input is analog then we store it here */
-    analog?: number | undefined;
+export declare interface PBPointerEvents_Entry {
+    eventType: PointerEventType;
+    eventInfo: PBPointerEvents_Info | undefined;
 }
 
 /**
  * Internal
  */
-export declare const PBPointerEventsResult_PointerCommand: {
-    encode(message: PBPointerEventsResult_PointerCommand, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBPointerEventsResult_PointerCommand;
+export declare const PBPointerEvents_Entry: {
+    encode(message: PBPointerEvents_Entry, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): PBPointerEvents_Entry;
 };
 
-export declare interface PBPointerHoverFeedback {
-    pointerEvents: PBPointerHoverFeedback_Entry[];
+export declare interface PBPointerEvents_Info {
+    /** default=InputAction.ANY */
+    button?: InputAction | undefined;
+    /** default='Interact' */
+    hoverText?: string | undefined;
+    /** default=10 */
+    maxDistance?: number | undefined;
+    /** default=true */
+    showFeedback?: boolean | undefined;
 }
 
 /**
  * Internal
  */
-export declare const PBPointerHoverFeedback: {
-    encode(message: PBPointerHoverFeedback, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBPointerHoverFeedback;
+export declare const PBPointerEvents_Info: {
+    encode(message: PBPointerEvents_Info, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): PBPointerEvents_Info;
 };
 
-export declare interface PBPointerHoverFeedback_Entry {
-    eventType: PointerEventType;
-    eventInfo: PBPointerHoverFeedback_Info | undefined;
+/** the renderer will set this component to the root entity once per frame with all the events */
+export declare interface PBPointerEventsResult {
+    /** a list of the last N pointer commands (from the engine) */
+    commands: PBPointerEventsResult_PointerCommand[];
 }
 
 /**
  * Internal
  */
-export declare const PBPointerHoverFeedback_Entry: {
-    encode(message: PBPointerHoverFeedback_Entry, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBPointerHoverFeedback_Entry;
+export declare const PBPointerEventsResult: {
+    encode(message: PBPointerEventsResult, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): PBPointerEventsResult;
 };
 
-export declare interface PBPointerHoverFeedback_Info {
-    /** default=InputAction.ANY */
-    button?: InputAction | undefined;
-    /** default='Interact' */
-    hoverText?: string | undefined;
-    /** default=10 */
-    maxDistance?: number | undefined;
-    /** default=true */
-    showFeedback?: boolean | undefined;
+/** this message represents a pointer event, used both for UP and DOWN actions */
+export declare interface PBPointerEventsResult_PointerCommand {
+    /** identifier of the input */
+    button: InputAction;
+    hit: RaycastHit | undefined;
+    state: PointerEventType;
+    /** could be a Lamport timestamp */
+    timestamp: number;
+    /** if the input is analog then we store it here */
+    analog?: number | undefined;
 }
 
 /**
  * Internal
  */
-export declare const PBPointerHoverFeedback_Info: {
-    encode(message: PBPointerHoverFeedback_Info, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PBPointerHoverFeedback_Info;
+export declare const PBPointerEventsResult_PointerCommand: {
+    encode(message: PBPointerEventsResult_PointerCommand, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): PBPointerEventsResult_PointerCommand;
 };
 
 export declare interface PBPointerLock {
@@ -3271,8 +3331,14 @@ export declare const PBTextShape: {
 };
 
 export declare interface PBUiBackground {
-    /** default=(0.0, 0.0, 0.0, 0.0) */
-    backgroundColor?: PBColor4 | undefined;
+    /** default=(1.0, 1.0, 1.0, 1.0), pixel = color * sample2D(texture, uv) */
+    color?: PBColor4 | undefined;
+    texture?: TextureUnion | undefined;
+    textureMode: BackgroundTextureMode;
+    /** default=(1/3, 1/3, 1/3, 1/3) */
+    textureSlices?: BorderRect | undefined;
+    /** default=[0,0,0,1,1,0,1,0]: starting from bottom-left vertex clock-wise */
+    uvs: number[];
 }
 
 /**
@@ -3283,6 +3349,78 @@ export declare const PBUiBackground: {
     decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
 };
 
+export declare interface PBUiDropdown {
+    acceptEmpty: boolean;
+    emptyLabel?: string | undefined;
+    options: string[];
+    /** default=null when accept_empty==true; default=0 when accept_empty==false */
+    selectedIndex?: number | undefined;
+    disabled: boolean;
+    /** default=(0.0,0.0,0.0,1.0) */
+    color?: PBColor4 | undefined;
+    /** default='center' */
+    textAlign?: TextAlignMode | undefined;
+    /** default=0 */
+    font?: Font | undefined;
+    /** default=10 */
+    fontSize?: number | undefined;
+}
+
+/**
+ * Internal
+ */
+export declare const PBUiDropdown: {
+    encode(message: PBUiDropdown, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): PBUiDropdown;
+};
+
+export declare interface PBUiDropdownResult {
+    value: number;
+}
+
+/**
+ * Internal
+ */
+export declare const PBUiDropdownResult: {
+    encode(message: PBUiDropdownResult, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): PBUiDropdownResult;
+};
+
+export declare interface PBUiInput {
+    placeholder: string;
+    /** default=(0.0,0.0,0.0,1.0) */
+    color?: PBColor4 | undefined;
+    /** default=(0.3,0.3,0.3,1.0) */
+    placeholderColor?: PBColor4 | undefined;
+    disabled: boolean;
+    /** default='center' */
+    textAlign?: TextAlignMode | undefined;
+    /** default=0 */
+    font?: Font | undefined;
+    /** default=10 */
+    fontSize?: number | undefined;
+}
+
+/**
+ * Internal
+ */
+export declare const PBUiInput: {
+    encode(message: PBUiInput, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInput;
+};
+
+export declare interface PBUiInputResult {
+    value: string;
+}
+
+/**
+ * Internal
+ */
+export declare const PBUiInputResult: {
+    encode(message: PBUiInputResult, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
+};
+
 export declare interface PBUiText {
     value: string;
     /** default=(1.0,1.0,1.0,1.0) */
@@ -3552,6 +3690,9 @@ export declare namespace Plane {
     export function signedDistanceTo(plane: ReadonlyPlane, point: Vector3.ReadonlyVector3): number;
 }
 
+/** @public */
+export declare const PointerEvents: ComponentDefinition<PBPointerEvents>;
+
 /** @public */
 export declare const PointerEventsResult: ComponentDefinition<PBPointerEventsResult>;
 
@@ -3561,9 +3702,9 @@ export declare const pointerEventsSystem: {
     removeOnClick(entity: unknown): void;
     removeOnPointerDown(entity: unknown): void;
     removeOnPointerUp(entity: unknown): void;
-    onClick(entity: unknown, cb: EventSystemCallback, opts?: EventSystemOptions | undefined): void;
-    onPointerDown(entity: unknown, cb: EventSystemCallback, opts?: EventSystemOptions | undefined): void;
-    onPointerUp(entity: unknown, cb: EventSystemCallback, opts?: EventSystemOptions | undefined): void;
+    onClick(entity: unknown, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
+    onPointerDown(entity: unknown, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
+    onPointerUp(entity: unknown, cb: EventSystemCallback, opts?: Partial<EventSystemOptions> | undefined): void;
 };
 
 export declare const enum PointerEventType {
@@ -3573,9 +3714,6 @@ export declare const enum PointerEventType {
     PET_HOVER_LEAVE = 3
 }
 
-/** @public */
-export declare const PointerHoverFeedback: ComponentDefinition<PBPointerHoverFeedback>;
-
 /** @public */
 export declare const PointerLock: ComponentDefinition<PBPointerLock>;
 
@@ -3897,8 +4035,7 @@ export declare type ReactBasedUiSystem = {
 
 export declare namespace ReactEcs {
     export namespace JSX {
-        export interface Element {
-        }
+        export type Element = {} | null;
         export type IntrinsicElements = EcsElements;
         export interface Component {
         }
@@ -4315,19 +4452,81 @@ export declare type Transport = {
 
 export declare type TransportMessage = Omit<ReceiveMessage, 'data'>;
 
+/**
+ * @public
+ */
+export declare type UiAvatarTexture = {
+    avatarTexture?: AvatarTexture;
+};
+
 /** @public */
 export declare const UiBackground: ComponentDefinition<PBUiBackground>;
 
+/**
+ * @public
+ */
+export declare type UiBackgroundProps = Partial<Omit<PBUiBackground, 'texture'>> & UiTextureUnion;
+
+/**
+ * @public
+ */
+export declare type UiButtonProps = PBUiText & {
+    type?: 'primary' | 'secondary';
+};
+
 export declare type UiComponent = () => JSX.Element;
 
+/** @public */
+export declare const UiDropdown: ComponentDefinition<PBUiDropdown>;
+
+/**
+ * @public
+ */
+export declare type UiDropdownProps = Partial<PBUiDropdown> & {
+    onChange?(value: number): void;
+};
+
+/** @public */
+export declare const UiDropdownResult: ComponentDefinition<PBUiDropdownResult>;
+
 /**
  * @public
  */
 export declare function UiEntity(props: EntityPropTypes & Partial<CommonProps>): ReactEcs.JSX.Element;
 
+/** @public */
+export declare const UiInput: ComponentDefinition<PBUiInput>;
+
+/**
+ * @public
+ */
+export declare type UiInputProps = PBUiInput & {
+    onChange?(value: string): void;
+};
+
+/** @public */
+export declare const UiInputResult: ComponentDefinition<PBUiInputResult>;
+
 /** @public */
 export declare const UiText: ComponentDefinition<PBUiText>;
 
+/**
+ * @public
+ */
+export declare type UiTextProps = PBUiText;
+
+/**
+ * @public
+ */
+export declare type UiTexture = {
+    texture?: Texture;
+};
+
+/**
+ * @public
+ */
+export declare type UiTextureUnion = UiAvatarTexture | UiTexture;
+
 /** @public */
 export declare const UiTransform: ComponentDefinition<PBUiTransform>;