@dcl/playground-assets 7.20.5-22670537517.commit-a403a9f → 7.20.5-22674879735.commit-6a30e67

package/dist/alpha.d.ts

@@ -115,6 +115,61 @@ export declare const assetLoadLoadingStateSystem: AssetLoadLoadingStateSystem;
  */
 export declare type AssetLoadLoadingStateSystemCallback = (event: DeepReadonlyObject<PBAssetLoadLoadingState>) => void;
 
+export declare const AudioAnalysis: AudioAnalysisComponentDefinitionExtended;
+
+export declare interface AudioAnalysisComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBAudioAnalysis> {
+    /**
+     * Reads the component data of `entity` into the provided `out` view.
+     *
+     * @throws Error if the entity does not have an AudioAnalysis component.
+     * @param entity - The entity whose AudioAnalysis data will be read.
+     * @param out - An existing AudioAnalysisView to populate with the latest values.
+     */
+    readIntoView(entity: Entity, out: AudioAnalysisView): void;
+    /**
+     * Attempts to read the component data of `entity` into the provided `out` view.
+     *
+     * @returns `true` if the component exists and data was written into `out`,
+     *          `false` if the entity does not have an AudioAnalysis component.
+     * @param entity - The entity whose AudioAnalysis data will be read.
+     * @param out - An existing AudioAnalysisView to populate.
+     */
+    tryReadIntoView(entity: Entity, out: AudioAnalysisView): boolean;
+    /**
+     * Creates an AudioAnalysis component for the given `entity`.
+     *
+     * If a component already exists on the entity, this call fails (does not replace).
+     *
+     * @param entity - The entity to attach the component to.
+     * @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
+     * @param amplitudeGain - Optional amplitude gain multiplier.
+     * @param bandsGain - Optional gain multiplier applied to all frequency bands.
+     */
+    createAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
+    amplitudeGain?: number, bandsGain?: number): void;
+    /**
+     * Creates the AudioAnalysis component if missing, or replaces the existing one.
+     *
+     * @param entity - The target entity.
+     * @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
+     * @param amplitudeGain - Optional amplitude gain multiplier.
+     * @param bandsGain - Optional gain multiplier applied to the frequency bands.
+     */
+    createOrReplaceAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
+    amplitudeGain?: number, bandsGain?: number): void;
+}
+
+/**
+ * A read-only JavaScript-friendly view of AudioAnalysis ECS data.
+ *
+ * `amplitude` represents the aggregated signal strength.
+ * `bands` represents the processed frequency bands.
+ */
+export declare type AudioAnalysisView = {
+    amplitude: number;
+    bands: number[];
+};
+
 /** @public */
 export declare const AudioEvent: GrowOnlyValueSetComponentDefinition<PBAudioEvent>;
 
@@ -209,6 +264,9 @@ export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBA
 /** @public */
 export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
 
+/** @public */
+export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
+
 /** @public */
 export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
 
@@ -1321,6 +1379,7 @@ export declare const componentDefinitionByName: {
     "core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
     "core::AssetLoad": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAssetLoad>>;
     "core::AssetLoadLoadingState": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAssetLoadLoadingState>>;
+    "core::AudioAnalysis": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>>;
     "core::AudioEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAudioEvent>>;
     "core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
     "core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
@@ -1328,6 +1387,7 @@ export declare const componentDefinitionByName: {
     "core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
     "core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
     "core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
+    "core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
     "core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
     "core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
     "core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
@@ -2034,6 +2094,7 @@ export declare type EventSystemOptions = {
     showFeedback?: boolean;
     showHighlight?: boolean;
     maxPlayerDistance?: number;
+    priority?: number;
 };
 
 /**
@@ -2687,7 +2748,8 @@ export declare const enum InputAction {
     IA_ACTION_3 = 10,
     IA_ACTION_4 = 11,
     IA_ACTION_5 = 12,
-    IA_ACTION_6 = 13
+    IA_ACTION_6 = 13,
+    IA_MODIFIER = 14
 }
 
 export declare const InputModifier: InputModifierComponentDefinitionExtended;
@@ -2735,6 +2797,14 @@ export declare type InstanceCompositeOptions = {
     alreadyRequestedSrc?: Set<string>;
 };
 
+/**
+ * @public
+ */
+export declare const enum InteractionType {
+    CURSOR = 0,
+    PROXIMITY = 1
+}
+
 /**
  * @public
  */
@@ -3913,6 +3983,49 @@ export declare namespace MoveContinuous {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
 }
 
+/**
+ * @public
+ */
+export declare interface MoveRotateScale {
+    positionStart: PBVector3 | undefined;
+    positionEnd: PBVector3 | undefined;
+    rotationStart: PBQuaternion | undefined;
+    rotationEnd: PBQuaternion | undefined;
+    scaleStart: PBVector3 | undefined;
+    scaleEnd: PBVector3 | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace MoveRotateScale {
+    export function encode(message: MoveRotateScale, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveRotateScale;
+}
+
+/**
+ * @public
+ * Partial params for Tween.Mode.MoveRotateScale(). At least one of position, rotation, or scale must be provided.
+ * Use this when building a mode for Tween.createOrReplace() or TweenSequence (e.g. only positionStart/positionEnd).
+ */
+export declare interface MoveRotateScaleModeParams {
+    /** Position tween (start → end). Optional. */
+    position?: {
+        start: PBVector3;
+        end: PBVector3;
+    };
+    /** Rotation tween (start → end). Optional. */
+    rotation?: {
+        start: PBQuaternion;
+        end: PBQuaternion;
+    };
+    /** Scale tween (start → end). Optional. */
+    scale?: {
+        start: PBVector3;
+        end: PBVector3;
+    };
+}
+
 export declare const Name: NameComponent;
 
 export declare type NameComponent = LastWriteWinElementSetComponentDefinition<NameType>;
@@ -4391,6 +4504,45 @@ export declare namespace PBAssetLoadLoadingState {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
 }
 
+/**
+ * @public
+ */
+export declare interface PBAudioAnalysis {
+    /** Parameters section */
+    mode: PBAudioAnalysisMode;
+    /** Used only when mode == MODE_LOGARITHMIC */
+    amplitudeGain?: number | undefined;
+    /** End when mode == MODE_LOGARITHMIC */
+    bandsGain?: number | undefined;
+    /** Result section */
+    amplitude: number;
+    /** Protobuf doesn't support fixed arrays -> 8 band fields */
+    band0: number;
+    band1: number;
+    band2: number;
+    band3: number;
+    band4: number;
+    band5: number;
+    band6: number;
+    band7: number;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBAudioAnalysis {
+    export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
+}
+
+/**
+ * @public
+ */
+export declare const enum PBAudioAnalysisMode {
+    MODE_RAW = 0,
+    MODE_LOGARITHMIC = 1
+}
+
 /**
  * @public
  */
@@ -4580,6 +4732,42 @@ export declare namespace PBAvatarEquippedData {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
 }
 
+/**
+ * The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
+ * as the avatar movement speed, jump height etc.
+ */
+/**
+ * @public
+ */
+export declare interface PBAvatarLocomotionSettings {
+    /** Maximum speed when walking (in meters per second) */
+    walkSpeed?: number | undefined;
+    /** Maximum speed when jogging (in meters per second) */
+    jogSpeed?: number | undefined;
+    /** Maximum speed when running (in meters per second) */
+    runSpeed?: number | undefined;
+    /** Height of a regular jump (in meters) */
+    jumpHeight?: number | undefined;
+    /** Height of a jump while running (in meters) */
+    runJumpHeight?: number | undefined;
+    /** Cooldown time after a hard landing before the avatar can move again (in seconds) */
+    hardLandingCooldown?: number | undefined;
+    /** Height of the double jump (in meters) */
+    doubleJumpHeight?: number | undefined;
+    /** Maximum speed when gliding (in meters per second) */
+    glidingSpeed?: number | undefined;
+    /** Maximum falling speed when gliding (in meters per second) */
+    glidingFallingSpeed?: number | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBAvatarLocomotionSettings {
+    export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
+}
+
 /**
  * The AvatarModifierArea component can be attached to an Entity to define a region of space where
  * avatar behavior changes.
@@ -5487,6 +5675,8 @@ export declare interface PBPointerEvents_Entry {
     eventType: PointerEventType;
     /** additional configuration for this detection */
     eventInfo: PBPointerEvents_Info | undefined;
+    /** the type of interaction source (default 0 == CURSOR) */
+    interactionType?: InteractionType | undefined;
 }
 
 /**
@@ -5513,6 +5703,8 @@ export declare interface PBPointerEvents_Info {
     showHighlight?: boolean | undefined;
     /** range of interaction from the avatar's position (default 0) */
     maxPlayerDistance?: number | undefined;
+    /** resolution order when multiple events overlap, higher wins (default 0) */
+    priority?: number | undefined;
 }
 
 /**
@@ -5949,6 +6141,9 @@ export declare interface PBTween {
     } | {
         $case: "textureMoveContinuous";
         textureMoveContinuous: TextureMoveContinuous;
+    } | {
+        $case: "moveRotateScale";
+        moveRotateScale: MoveRotateScale;
     } | undefined;
     /** default true (pause or running) */
     playing?: boolean | undefined;
@@ -6386,6 +6581,7 @@ export declare namespace PBVideoPlayer {
  * an 'instant' transition (like using speed/time = 0)
  * * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
  * the holding entity transform).
+ * * The fov defines the Field of View of the virtual camera
  */
 /**
  * @public
@@ -6393,6 +6589,8 @@ export declare namespace PBVideoPlayer {
 export declare interface PBVirtualCamera {
     defaultTransition?: CameraTransition | undefined;
     lookAtEntity?: number | undefined;
+    /** default: 60 */
+    fov?: number | undefined;
 }
 
 /**
@@ -6588,6 +6786,30 @@ export declare interface PointerEventsSystem {
      * @param entity - Entity where the callback was attached
      */
     removeOnPointerHoverLeave(entity: Entity): void;
+    /**
+     * @public
+     * Remove the callback for onProximityDown event
+     * @param entity - Entity where the callback was attached
+     */
+    removeOnProximityDown(entity: Entity): void;
+    /**
+     * @public
+     * Remove the callback for onProximityUp event
+     * @param entity - Entity where the callback was attached
+     */
+    removeOnProximityUp(entity: Entity): void;
+    /**
+     * @public
+     * Remove the callback for onProximityEnter event
+     * @param entity - Entity where the callback was attached
+     */
+    removeOnProximityEnter(entity: Entity): void;
+    /**
+     * @public
+     * Remove the callback for onProximityLeave event
+     * @param entity - Entity where the callback was attached
+     */
+    removeOnProximityLeave(entity: Entity): void;
     /**
      * @public
      * Execute callback when the user press the InputButton pointing at the entity
@@ -6642,6 +6864,46 @@ export declare interface PointerEventsSystem {
         entity: Entity;
         opts?: Partial<EventSystemOptions>;
     }, cb: EventSystemCallback): void;
+    /**
+     * @public
+     * Execute callback when the user presses the proximity button on the entity
+     * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
+     * @param cb - Function to execute when click fires
+     */
+    onProximityDown(pointerData: {
+        entity: Entity;
+        opts?: Partial<EventSystemOptions>;
+    }, cb: EventSystemCallback): void;
+    /**
+     * @public
+     * Execute callback when the user releases the proximity button on the entity
+     * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
+     * @param cb - Function to execute when event fires
+     */
+    onProximityUp(pointerData: {
+        entity: Entity;
+        opts?: Partial<EventSystemOptions>;
+    }, cb: EventSystemCallback): void;
+    /**
+     * @public
+     * Execute callback when the entity enters the proximity zone of the user
+     * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
+     * @param cb - Function to execute when event fires
+     */
+    onProximityEnter(pointerData: {
+        entity: Entity;
+        opts?: Partial<EventSystemOptions>;
+    }, cb: EventSystemCallback): void;
+    /**
+     * @public
+     * Execute callback when the entity leaves the proximity zone of the user
+     * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
+     * @param cb - Function to execute when event fires
+     */
+    onProximityLeave(pointerData: {
+        entity: Entity;
+        opts?: Partial<EventSystemOptions>;
+    }, cb: EventSystemCallback): void;
 }
 
 /**
@@ -6658,7 +6920,9 @@ export declare const enum PointerEventType {
     PET_UP = 0,
     PET_DOWN = 1,
     PET_HOVER_ENTER = 2,
-    PET_HOVER_LEAVE = 3
+    PET_HOVER_LEAVE = 3,
+    PET_PROXIMITY_ENTER = 4,
+    PET_PROXIMITY_LEAVE = 5
 }
 
 /**
@@ -7875,6 +8139,17 @@ export declare namespace Schemas {
     }) => void;
 }
 
+/**
+ * @public
+ * Parameters for setMoveRotateScale. At least one of position, rotation, or scale must be provided.
+ */
+export declare interface SetMoveRotateScaleParams extends MoveRotateScaleModeParams {
+    /** Duration of the tween in milliseconds. */
+    duration: number;
+    /** Easing function (defaults to EF_LINEAR). */
+    easingFunction?: EasingFunction;
+}
+
 /** @public */
 export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
 
@@ -8397,7 +8672,7 @@ export declare const Tween: TweenComponentDefinitionExtended;
  */
 export declare interface TweenComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBTween> {
     /**
-     * Texture helpers with constructor
+     * Helpers with constructor
      */
     Mode: TweenHelper;
     /**
@@ -8476,6 +8751,16 @@ export declare interface TweenComponentDefinitionExtended extends LastWriteWinEl
      * @param duration - duration of the tween in milliseconds (defaults to 0 for infinite)
      */
     setTextureMoveContinuous(entity: Entity, direction: PBVector2, speed: number, movementType?: TextureMovementType, duration?: number): void;
+    /**
+     * @public
+     *
+     * Creates or replaces a move-rotate-scale tween component that simultaneously animates
+     * an entity's position, rotation, and/or scale from start to end. Provide only the
+     * properties you need (at least one of position, rotation, or scale).
+     * @param entity - entity to apply the tween to
+     * @param params - object with optional position, rotation, scale (each with start/end), duration, and optional easingFunction
+     */
+    setMoveRotateScale(entity: Entity, params: SetMoveRotateScaleParams): void;
 }
 
 /**
@@ -8510,6 +8795,11 @@ export declare interface TweenHelper {
      * @returns a texture-move-continuous mode tween
      */
     TextureMoveContinuous: (textureMove: TextureMoveContinuous) => PBTween['mode'];
+    /**
+     * @returns a move-rotate-scale mode tween
+     * @param params - partial transform (at least one of position, rotation, scale); omit axes you don't need
+     */
+    MoveRotateScale: (params: MoveRotateScaleModeParams) => PBTween['mode'];
 }
 
 /**