@dcl/playground-assets 7.22.3-24033264917.commit-024caa7 → 7.22.3-24082946861.commit-0d8c4f2

package/dist/beta.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>;
 
@@ -1288,6 +1346,23 @@ export declare type Color4Type = {
     a: number;
 };
 
+/** A range of Color4 values. Randomized or lerped between start and end. */
+/**
+ * @public
+ */
+export declare interface ColorRange {
+    start: PBColor4 | undefined;
+    end: PBColor4 | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace ColorRange {
+    export function encode(message: ColorRange, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): ColorRange;
+}
+
 /**
  * @public
  */
@@ -1321,6 +1396,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 +1404,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>>;
@@ -1344,6 +1421,7 @@ export declare const componentDefinitionByName: {
     "core::MeshCollider": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshCollider>>;
     "core::MeshRenderer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshRenderer>>;
     "core::NftShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBNftShape>>;
+    "core::ParticleSystem": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBParticleSystem>>;
     "core::PhysicsCombinedForce": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPhysicsCombinedForce>>;
     "core::PhysicsCombinedImpulse": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPhysicsCombinedImpulse>>;
     "core::PlayerIdentityData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPlayerIdentityData>>;
@@ -2148,6 +2226,23 @@ export declare type FlexWrapType = 'wrap' | 'nowrap' | 'wrap-reverse';
 /** @public */
 export declare type FloatArray = number[];
 
+/** A range of float values. Randomized or lerped between start and end. */
+/**
+ * @public
+ */
+export declare interface FloatRange {
+    start: number;
+    end: number;
+}
+
+/**
+ * @public
+ */
+export declare namespace FloatRange {
+    export function encode(message: FloatRange, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): FloatRange;
+}
+
 /**
  * @public
  */
@@ -2688,7 +2783,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;
@@ -4345,6 +4441,30 @@ export declare const onVideoEvent: Observable<{
  */
 export declare type OverflowType = 'hidden' | 'scroll' | 'visible';
 
+export declare const ParticleSystem: ParticleSystemComponentDefinitionExtended;
+
+/**
+ * @public
+ */
+export declare interface ParticleSystemComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBParticleSystem> {
+    /** Helpers for constructing emitter shapes */
+    Shape: ParticleSystemHelper;
+}
+
+/**
+ * @public
+ */
+export declare interface ParticleSystemHelper {
+    /** Emit from a single point */
+    Point: (point?: PBParticleSystem_Point) => PBParticleSystem['shape'];
+    /** Emit from the surface or volume of a sphere */
+    Sphere: (sphere?: PBParticleSystem_Sphere) => PBParticleSystem['shape'];
+    /** Emit from the base of a cone, projecting outward */
+    Cone: (cone?: PBParticleSystem_Cone) => PBParticleSystem['shape'];
+    /** Emit from the surface or volume of a box */
+    Box: (box?: PBParticleSystem_Box) => PBParticleSystem['shape'];
+}
+
 /** AnimationState indicates the status and configuration of one available animation. */
 /**
  * @public
@@ -4437,6 +4557,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
  */
@@ -4626,6 +4785,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.
@@ -5396,6 +5591,252 @@ export declare namespace PBNftShape {
     export function decode(input: _m0.Reader | Uint8Array, length?: number): PBNftShape;
 }
 
+/**
+ * @public
+ */
+export declare interface PBParticleSystem {
+    /** --- Emission --- */
+    active?: boolean | undefined;
+    /** default = 10. Particles emitted per second. */
+    rate?: number | undefined;
+    /** default = 1000. Maximum number of live particles. */
+    maxParticles?: number | undefined;
+    /** default = 5. Particle lifetime in seconds. */
+    lifetime?: number | undefined;
+    /** --- Motion --- */
+    gravity?: number | undefined;
+    /** Constant force vector applied to each particle (world space). */
+    additionalForce?: PBVector3 | undefined;
+    /** --- Size --- */
+    initialSize?: FloatRange | undefined;
+    /** default = {1, 1}. Particle size lerped from start to end over its lifetime. */
+    sizeOverTime?: FloatRange | undefined;
+    /** --- Rotation --- */
+    initialRotation?: PBQuaternion | undefined;
+    /** default = identity (0,0,0,1). Per-axis angular velocity as quaternion; converted to Euler XYZ. */
+    rotationOverTime?: PBQuaternion | undefined;
+    /** default = false. Particles orient along their velocity direction. */
+    faceTravelDirection?: boolean | undefined;
+    /** --- Color --- */
+    initialColor?: ColorRange | undefined;
+    /** default = {white, white}. Particle color lerped from start to end over its lifetime. */
+    colorOverTime?: ColorRange | undefined;
+    /** --- Velocity --- */
+    initialVelocitySpeed?: FloatRange | undefined;
+    /** --- Rendering --- */
+    texture?: Texture | undefined;
+    /** default = PSB_ALPHA */
+    blendMode?: PBParticleSystem_BlendMode | undefined;
+    /** default = true */
+    billboard?: boolean | undefined;
+    /** --- Sprite Sheet Animation --- */
+    spriteSheet?: PBParticleSystem_SpriteSheetAnimation | undefined;
+    shape?: {
+        $case: "point";
+        point: PBParticleSystem_Point;
+    } | {
+        $case: "sphere";
+        sphere: PBParticleSystem_Sphere;
+    } | {
+        $case: "cone";
+        cone: PBParticleSystem_Cone;
+    } | {
+        $case: "box";
+        box: PBParticleSystem_Box;
+    } | undefined;
+    /** --- Simulation --- */
+    loop?: boolean | undefined;
+    /** default = false. Start as if already simulated for one full loop cycle. Requires loop = true. */
+    prewarm?: boolean | undefined;
+    /** default = PSS_LOCAL. Controls whether particles simulate in local or world space. */
+    simulationSpace?: PBParticleSystem_SimulationSpace | undefined;
+    /** --- Limit Velocity Over Lifetime --- */
+    limitVelocity?: PBParticleSystem_LimitVelocity | undefined;
+    /** --- Playback --- */
+    playbackState?: PBParticleSystem_PlaybackState | undefined;
+    /** --- Emission Bursts --- */
+    bursts: PBParticleSystem_Burst[];
+}
+
+/**
+ * @public
+ */
+export declare namespace PBParticleSystem {
+    export function encode(message: PBParticleSystem, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBParticleSystem;
+}
+
+/**
+ * @public
+ */
+declare const enum PBParticleSystem_BlendMode {
+    /** PSB_ALPHA - Standard alpha transparency. */
+    PSB_ALPHA = 0,
+    /** PSB_ADD - Additive blending (brightens underlying pixels). */
+    PSB_ADD = 1,
+    /** PSB_MULTIPLY - Multiply blending (darkens underlying pixels). */
+    PSB_MULTIPLY = 2
+}
+export { PBParticleSystem_BlendMode }
+export { PBParticleSystem_BlendMode as ParticleSystemBlendMode }
+
+/** Emitter spawns particles from the surface or volume of a box. */
+/**
+ * @public
+ */
+export declare interface PBParticleSystem_Box {
+    /** default = {1, 1, 1} */
+    size?: PBVector3 | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBParticleSystem_Box {
+    export function encode(message: PBParticleSystem_Box, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBParticleSystem_Box;
+}
+
+/** Emission burst configuration. */
+/**
+ * @public
+ */
+export declare interface PBParticleSystem_Burst {
+    /** Seconds from start of cycle. */
+    time: number;
+    /** Particles to emit. */
+    count: number;
+    /** default = 1. Repeat count (0 = infinite). */
+    cycles?: number | undefined;
+    /** default = 0.01. Seconds between cycles. */
+    interval?: number | undefined;
+    /** default = 1.0. Emission chance [0,1]. */
+    probability?: number | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBParticleSystem_Burst {
+    export function encode(message: PBParticleSystem_Burst, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBParticleSystem_Burst;
+}
+
+/** Emitter spawns particles from the base of a cone and projects them outward. */
+/**
+ * @public
+ */
+export declare interface PBParticleSystem_Cone {
+    /** default = 25. Half-angle of the cone in degrees. */
+    angle?: number | undefined;
+    /** default = 1. Base radius in meters. */
+    radius?: number | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBParticleSystem_Cone {
+    export function encode(message: PBParticleSystem_Cone, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBParticleSystem_Cone;
+}
+
+/** Clamps particle speed over lifetime. */
+/**
+ * @public
+ */
+export declare interface PBParticleSystem_LimitVelocity {
+    /** Maximum particle speed (m/s). */
+    speed: number;
+    /** default = 1. Fraction (0–1) of excess velocity removed per frame. 1 = hard clamp. */
+    dampen?: number | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBParticleSystem_LimitVelocity {
+    export function encode(message: PBParticleSystem_LimitVelocity, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBParticleSystem_LimitVelocity;
+}
+
+/**
+ * @public
+ */
+declare const enum PBParticleSystem_PlaybackState {
+    /** PS_PLAYING - Particle system is emitting and simulating. */
+    PS_PLAYING = 0,
+    /** PS_PAUSED - Simulation is frozen; no new particles are emitted. */
+    PS_PAUSED = 1,
+    /** PS_STOPPED - Simulation stopped and existing particles cleared. */
+    PS_STOPPED = 2
+}
+export { PBParticleSystem_PlaybackState }
+export { PBParticleSystem_PlaybackState as ParticleSystemPlaybackState }
+
+/** Emitter spawns particles from a single point. */
+/**
+ * @public
+ */
+export declare interface PBParticleSystem_Point {
+}
+
+/**
+ * @public
+ */
+export declare namespace PBParticleSystem_Point {
+    export function encode(_: PBParticleSystem_Point, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBParticleSystem_Point;
+}
+
+/**
+ * @public
+ */
+export declare const enum PBParticleSystem_SimulationSpace {
+    /** PSS_LOCAL - Particles move with the entity transform. */
+    PSS_LOCAL = 0,
+    /** PSS_WORLD - Particles stay in world position after emission. */
+    PSS_WORLD = 1
+}
+
+/** Emitter spawns particles from the surface or volume of a sphere. */
+/**
+ * @public
+ */
+export declare interface PBParticleSystem_Sphere {
+    /** default = 1 */
+    radius?: number | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBParticleSystem_Sphere {
+    export function encode(message: PBParticleSystem_Sphere, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBParticleSystem_Sphere;
+}
+
+/** Sprite sheet (texture atlas) animation settings. */
+/**
+ * @public
+ */
+export declare interface PBParticleSystem_SpriteSheetAnimation {
+    /** Number of columns in the sprite sheet. */
+    tilesX: number;
+    /** Number of rows in the sprite sheet. */
+    tilesY: number;
+    /** default = 30. Playback speed in frames per second. */
+    framesPerSecond?: number | undefined;
+}
+
+/**
+ * @public
+ */
+export declare namespace PBParticleSystem_SpriteSheetAnimation {
+    export function encode(message: PBParticleSystem_SpriteSheetAnimation, writer?: _m0.Writer): _m0.Writer;
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBParticleSystem_SpriteSheetAnimation;
+}
+
 /**
  * This component applies a continuous physics force.
  *
@@ -6439,6 +6880,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
@@ -6446,6 +6888,8 @@ export declare namespace PBVideoPlayer {
 export declare interface PBVirtualCamera {
     defaultTransition?: CameraTransition | undefined;
     lookAtEntity?: number | undefined;
+    /** default: 60 */
+    fov?: number | undefined;
 }
 
 /**