@dcl/playground-assets 7.5.7-10164853387.commit-376e330 → 7.5.7-10170491272.commit-f46d8e8

package/dist/alpha.d.ts

@@ -178,6 +178,18 @@ export declare const AvatarAttach: LastWriteWinElementSetComponentDefinition<PBA
 /** @public */
 export declare const AvatarBase: LastWriteWinElementSetComponentDefinition<PBAvatarBase>;
 
+/**
+ * @public
+ */
+export declare const enum AvatarControlType {
+    /** CCT_NONE - avatar cannot move */
+    CCT_NONE = 0,
+    /** CCT_RELATIVE - avatar moves relative to the camera origin */
+    CCT_RELATIVE = 1,
+    /** CCT_TANK - avatar moves like a tank: left/right rotate the player, forward/backward advance/retreat the player */
+    CCT_TANK = 2
+}
+
 /** @public */
 export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
 
@@ -198,6 +210,37 @@ export declare const enum AvatarModifierType {
     AMT_DISABLE_PASSPORTS = 1
 }
 
+/**
+ * @public
+ */
+export declare interface AvatarMovementSettings {
+    controlMode?: AvatarControlType | undefined;
+    /** if not explicitly set, the following properties default to user's preference settings */
+    runSpeed?: number | undefined;
+    /** how fast the player gets up to speed or comes to rest. higher = more responsive */
+    friction?: number | undefined;
+    /** how fast the player accelerates vertically when not on a solid surface, in m/s. should normally be negative */
+    gravity?: number | undefined;
+    /** how high the player can jump, in meters. should normally be positive. gravity must have the same sign for jumping to be possible */
+    jumpHeight?: number | undefined;
+    /** max fall speed in m/s. should normally be negative */
+    maxFallSpeed?: number | undefined;
+    /** speed the player turns in tank mode, in radians/s */
+    turnSpeed?: number | undefined;
+    /** speed the player walks at, in m/s */
+    walkSpeed?: number | undefined;
+    /** whether to allow player to move at a slower speed (e.g. with a walk-key or when using a gamepad/joystick). defaults to true */
+    allowWeightedMovement?: boolean | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace AvatarMovementSettings {
+    export function encode(message: AvatarMovementSettings, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): AvatarMovementSettings;
+}
+
 /** @public */
 export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
 
@@ -480,6 +523,39 @@ export declare const enum CameraType {
 
 export declare type Children = ReactEcs.JSX.ReactNode;
 
+/**
+ * @public
+ */
+export declare interface CinematicSettings {
+    /** Entity that defines the cinematic camera transform. */
+    cameraEntity: number;
+    /**
+     * Position -> camera's position
+     * Rotation -> camera's direction
+     * scale.z -> zoom level
+     * scale.x and scale.y -> unused
+     */
+    allowManualRotation?: boolean | undefined;
+    /** how far the camera can rotate around the y-axis / look left/right, in radians. default unrestricted */
+    yawRange?: number | undefined;
+    /** how far the camera can rotate around the x-axis / look up-down, in radians. default unrestricted */
+    pitchRange?: number | undefined;
+    /** note: cameras can never look up/down further than Vec3::Y */
+    rollRange?: number | undefined;
+    /** minimum zoom level. must be greater than 0. defaults to the input zoom level */
+    zoomMin?: number | undefined;
+    /** maximum zoom level. must be greater than 0. defaults to the input zoom level */
+    zoomMax?: number | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace CinematicSettings {
+    export function encode(message: CinematicSettings, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): CinematicSettings;
+}
+
 /** ColliderLayer determines the kind of collision to detect, in OR-able bit flag form. */
 /**
  * @public
@@ -1258,6 +1334,8 @@ export declare const componentDefinitionByName: {
     "core::EngineInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEngineInfo>>;
     "core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
     "core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
+    "core::GltfNode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNode>>;
+    "core::GltfNodeState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeState>>;
     "core::Material": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMaterial>>;
     "core::MeshCollider": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshCollider>>;
     "core::MeshRenderer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshRenderer>>;
@@ -1279,6 +1357,7 @@ export declare const componentDefinitionByName: {
     "core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
     "core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
     "core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
+    "core::UiScrollResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiScrollResult>>;
     "core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
     "core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
     "core::VideoEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBVideoEvent>>;
@@ -2001,6 +2080,21 @@ export declare const GltfContainer: LastWriteWinElementSetComponentDefinition<PB
 /** @public */
 export declare const GltfContainerLoadingState: LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>;
 
+/** @public */
+export declare const GltfNode: LastWriteWinElementSetComponentDefinition<PBGltfNode>;
+
+/** @public */
+export declare const GltfNodeState: LastWriteWinElementSetComponentDefinition<PBGltfNodeState>;
+
+/**
+ * @public
+ */
+export declare const enum GltfNodeStateValue {
+    GNSV_PENDING = 0,
+    GNSV_FAILED = 1,
+    GNSV_READY = 2
+}
+
 /**
  * @public
  */
@@ -3456,6 +3550,14 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
      * @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
      */
     setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
+    /**
+     * @public
+     * Set a gltf internal mesh in the MeshCollider component
+     * @param entity - entity to create or replace the MeshRenderer component
+     * @param source - the path to the gltf
+     * @param meshName - the name of the mesh in the gltf
+     */
+    setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
 }
 
 export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
@@ -3492,6 +3594,14 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
      * @param entity - entity to create or replace the MeshRenderer component
      */
     setSphere(entity: Entity): void;
+    /**
+     * @public
+     * Set a gltf internal mesh in the MeshRenderer component
+     * @param entity - entity to create or replace the MeshRenderer component
+     * @param source - the path to the gltf
+     * @param meshName - the name of the mesh in the gltf
+     */
+    setGltfMesh(entity: Entity, source: string, meshName: string): void;
 }
 
 /**
@@ -4164,6 +4274,9 @@ export declare interface PBAvatarModifierArea {
     excludeIds: string[];
     /** list of modifiers to apply */
     modifiers: AvatarModifierType[];
+    movementSettings?: AvatarMovementSettings | undefined;
+    /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
+    useColliderRange?: boolean | undefined;
 }
 
 /**
@@ -4276,7 +4389,7 @@ export declare namespace PBCameraMode {
 
 /**
  * The CameraModeArea component can be attached to an Entity to define a region of space where
- * the player's camera mode (1st-person or 3rd-person) is overridden.
+ * the player's camera mode (1st-person, 3rd-person or cinematic) is overridden.
  *
  * The Entity's Transform position determines the center-point of the region, while its size is
  * given as a vector in the `area` property below. The Transform rotation is applied, but the scale
@@ -4286,6 +4399,8 @@ export declare namespace PBCameraMode {
  *
  * Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
  * is actually a 3D volume.
+ *
+ * When mode is set to CtCinematic, the cinematic_settings field must also be provided.
  */
 /**
  * @public
@@ -4295,6 +4410,9 @@ export declare interface PBCameraModeArea {
     area: PBVector3 | undefined;
     /** the camera mode to enforce */
     mode: CameraType;
+    cinematicSettings?: CinematicSettings | undefined;
+    /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
+    useColliderRange?: boolean | undefined;
 }
 
 /**
@@ -4401,6 +4519,25 @@ export declare namespace PBGltfContainer {
  */
 export declare interface PBGltfContainerLoadingState {
     currentState: LoadingState;
+    /** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
+    nodePaths: string[];
+    /** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
+    meshNames: string[];
+    /**
+     * where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
+     * conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
+     */
+    materialNames: string[];
+    /**
+     * X is the material index. note this may conflict with manually named materials - to avoid any issues make
+     * sure all your materials are explicitly named.
+     */
+    skinNames: string[];
+    /**
+     * X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
+     * your skins are explicitly named.
+     */
+    animationNames: string[];
 }
 
 /**
@@ -4411,6 +4548,77 @@ export declare namespace PBGltfContainerLoadingState {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
 }
 
+/**
+ * a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
+ * This component must be added to a direct child of an entity with a PbGltfContainer component, or
+ * to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
+ * in the parent.
+ * The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
+ *
+ * The renderer will attach a PbGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
+ * - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
+ * - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
+ * - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
+ * - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
+ *
+ * After creation, if an animation moves the node, the `Transform` will be updated.
+ *
+ * From the scene, you can modify various components to alter the gltf node:
+ * - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
+ *   regardless of any intermediate gltf node hierarchy.
+ *   If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
+ * - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
+ * - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
+ * - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
+ * - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
+ *   used as a base, and any gltf features (e.g. occlusion maps) from the gtlf spec that the renderer supports but that are not exposed in the
+ *   PbMaterial will be maintained.
+ *
+ * The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
+ * - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
+ *   change the state to `GNS_FAILED`.
+ * - deleting the scene entity will not delete the gltf node.
+ *
+ * Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
+ * are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
+ * the gltf node will also be displayed.
+ */
+/**
+ * @public
+ */
+export declare interface PBGltfNode {
+    /** the path of the target node in the Gltf. */
+    path: string;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBGltfNode {
+    export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
+}
+
+/**
+ * The state of a linked gltf node.
+ * If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
+ */
+/**
+ * @public
+ */
+export declare interface PBGltfNodeState {
+    state: GltfNodeStateValue;
+    error?: string | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBGltfNodeState {
+    export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
+}
+
 /**
  * @public
  */
@@ -4422,6 +4630,14 @@ export declare interface PBMaterial {
         $case: "pbr";
         pbr: PBMaterial_PbrMaterial;
     } | undefined;
+    /**
+     * A gltf material that may provide additional features not supported by the PbMaterial fields.
+     * If both gltf and material fields are provided, the gltf will be used only for extended features not
+     * supported by the PbMaterial.
+     * If this is provided and the `material` field is not provided, the renderer will update the material
+     * field with data that reflects the gltf material once it is loaded.
+     */
+    gltf?: PBMaterial_GltfMaterial | undefined;
 }
 
 /**
@@ -4432,6 +4648,22 @@ export declare namespace PBMaterial {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
 }
 
+/**
+ * @public
+ */
+export declare interface PBMaterial_GltfMaterial {
+    gltfSrc: string;
+    name: string;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBMaterial_GltfMaterial {
+    export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
+}
+
 /**
  * @public
  */
@@ -4526,6 +4758,9 @@ export declare interface PBMeshCollider {
     } | {
         $case: "plane";
         plane: PBMeshCollider_PlaneMesh;
+    } | {
+        $case: "gltf";
+        gltf: PBMeshCollider_GltfMesh;
     } | undefined;
 }
 
@@ -4571,6 +4806,25 @@ export declare namespace PBMeshCollider_CylinderMesh {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
 }
 
+/** A collider constructed from a Gltf Mesh. */
+/**
+ * @public
+ */
+export declare interface PBMeshCollider_GltfMesh {
+    /** the GLTF file path as listed in the scene's manifest. */
+    gltfSrc: string;
+    /** the name of the mesh asset */
+    name: string;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBMeshCollider_GltfMesh {
+    export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
+}
+
 /** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
 /**
  * @public
@@ -4603,13 +4857,11 @@ export declare namespace PBMeshCollider_SphereMesh {
 
 /**
  * The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
- * plane, a sphere or a cylinder.
+ * plane, a sphere, a cylinder, or a Gltf mesh.
  *
  * The cube and plane variants can include a UV texture mapping, so specific areas of a material
  * texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
  * `float` coordinates, one for each corner of each side of each face.
- *
- * More complex shapes require the use of a `GltfContainer` component.
  */
 /**
  * @public
@@ -4627,6 +4879,9 @@ export declare interface PBMeshRenderer {
     } | {
         $case: "plane";
         plane: PBMeshRenderer_PlaneMesh;
+    } | {
+        $case: "gltf";
+        gltf: PBMeshRenderer_GltfMesh;
     } | undefined;
 }
 
@@ -4674,6 +4929,25 @@ export declare namespace PBMeshRenderer_CylinderMesh {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
 }
 
+/** A mesh from a Gltf. */
+/**
+ * @public
+ */
+export declare interface PBMeshRenderer_GltfMesh {
+    /** the GLTF file path as listed in the scene's manifest. */
+    gltfSrc: string;
+    /** the name of the mesh asset */
+    name: string;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBMeshRenderer_GltfMesh {
+    export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
+}
+
 /** PlaneMesh renders a 2D rectangular shape. */
 /**
  * @public
@@ -5276,6 +5550,21 @@ export declare namespace PBUiInputResult {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
 }
 
+/**
+ * @public
+ */
+export declare interface PBUiScrollResult {
+    value: PBVector2 | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBUiScrollResult {
+    export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
+}
+
 /**
  * @public
  */
@@ -5292,6 +5581,10 @@ export declare interface PBUiText {
     fontSize?: number | undefined;
     /** wrap text when the border is reached (default: TW_WRAP) */
     textWrap?: TextWrap | undefined;
+    /** width of the outline (default: 0) */
+    outlineWidth?: number | undefined;
+    /** RGBA color of the outline (default: opaque black) */
+    outlineColor?: PBColor4 | undefined;
 }
 
 /**
@@ -5388,6 +5681,14 @@ export declare interface PBUiTransform {
     paddingBottom: number;
     /** default: PointerFilterMode.PFM_NONE */
     pointerFilter?: PointerFilterMode | undefined;
+    /** default: 1 */
+    opacity?: number | undefined;
+    /** default empty */
+    elementId?: string | undefined;
+    /** default position=(0,0) */
+    scrollPosition?: ScrollPositionValue | undefined;
+    /** default ShowScrollBar.SSB_BOTH */
+    scrollVisible?: ShowScrollBar | undefined;
 }
 
 /**
@@ -6751,6 +7052,43 @@ export declare namespace Schemas {
     }) => void;
 }
 
+/**
+ * @public
+ */
+export declare interface ScrollPositionValue {
+    value?: {
+        $case: "position";
+        position: PBVector2;
+    } | {
+        $case: "reference";
+        reference: string;
+    } | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace ScrollPositionValue {
+    export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
+}
+
+/**
+ * @public
+ * The scroll-visible determines if the scrollbars are shown when the scroll overflow is enabled
+ */
+export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
+
+/**
+ * @public
+ */
+export declare const enum ShowScrollBar {
+    SSB_BOTH = 0,
+    SSB_ONLY_VERTICAL = 1,
+    SSB_ONLY_HORIZONTAL = 2,
+    SSB_HIDDEN = 3
+}
+
 /**
  * @public
  */
@@ -7179,6 +7517,10 @@ export declare interface UiLabelProps {
     textAlign?: TextAlignType | undefined;
     /** Label font type. @defaultValue 'sans-serif' */
     font?: UiFontType | undefined;
+    /** Outline width of the text. @defaultValue 0 */
+    outlineWidth?: number | undefined;
+    /** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
+    outlineColor?: PBColor4 | undefined;
     /** Behaviour when text reached. @defaultValue 'wrap' */
     textWrap?: UiTextWrapType | undefined;
 }
@@ -7188,6 +7530,9 @@ export declare interface UiLabelProps {
  */
 export declare type uint32 = number;
 
+/** @public */
+export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
+
 /** @public */
 export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
 
@@ -7260,6 +7605,14 @@ export declare interface UiTransformProps {
     overflow?: OverflowType;
     /** The pointer filter property determines if the ui element blocks the pointer or not (elements with pointer events always block the pointer regardless of this property) **/
     pointerFilter?: PointerFilterType;
+    /** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
+    opacity?: number;
+    /** A reference value to identify the element, default empty */
+    elementId?: string;
+    /** default position=(0,0) if it aplies, a vector or a reference-id */
+    scrollPosition?: PBVector2 | string;
+    /** default ShowScrollBar.SSB_BOTH */
+    scrollVisible?: ScrollVisibleType;
 }
 
 /**