@dcl/playground-assets 7.5.5 → 7.5.6-9700437476.commit-7649f90

package/dist/index.bundled.d.ts

@@ -177,6 +177,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>;
 
@@ -197,6 +209,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>;
 
@@ -479,6 +522,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
@@ -1278,6 +1354,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>>;
@@ -4135,6 +4212,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;
 }
 
 /**
@@ -4247,7 +4327,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
@@ -4257,6 +4337,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
@@ -4266,6 +4348,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;
 }
 
 /**
@@ -5247,6 +5332,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
  */
@@ -5263,6 +5363,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;
 }
 
 /**
@@ -5359,6 +5463,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;
 }
 
 /**
@@ -6722,6 +6834,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
  */
@@ -7145,6 +7294,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;
 }
@@ -7154,6 +7307,9 @@ export declare interface UiLabelProps {
  */
 export declare type uint32 = number;
 
+/** @public */
+export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
+
 /** @public */
 export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
 
@@ -7226,6 +7382,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;
 }
 
 /**