@dcl/playground-assets 7.20.2-22104870534.commit-0df3cc0 → 7.20.2-22169778016.commit-030cbfe

package/dist/alpha.d.ts

@@ -115,61 +115,6 @@ 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>;
 
@@ -218,6 +163,42 @@ export declare interface AudioStreamComponentDefinitionExtended extends LastWrit
     getAudioState(entity: Entity): PBAudioEvent | undefined;
 }
 
+/**
+ * @public
+ */
+export declare type AuthoritativePutComponentMessage = CrdtMessageHeader & AuthoritativePutComponentMessageBody;
+
+/**
+ * Server authoritative message - identical to PutComponentMessageBody but with forced processing
+ * Min. length = header (8 bytes) + 16 bytes = 24 bytes
+ *
+ * @param entity - Uint32 number of the entity
+ * @param componentId - Uint32 number of id
+ * @param timestamp - Uint32 Lamport timestamp (server's authoritative timestamp)
+ * @param data - Uint8[] data of component => length(4 bytes) + block of bytes[0..length-1]
+ * @public
+ */
+export declare type AuthoritativePutComponentMessageBody = {
+    type: CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT;
+    entityId: Entity;
+    componentId: number;
+    timestamp: number;
+    data: Uint8Array;
+};
+
+/**
+ * @public
+ */
+export declare namespace AuthoritativePutComponentOperation {
+    const MESSAGE_HEADER_LENGTH = 16;
+    /**
+     * Call this function for an optimal writing data passing the ByteBuffer
+     *  already allocated
+     */
+    export function write(entity: Entity, timestamp: number, componentId: number, data: Uint8Array, buf: ByteBuffer): void;
+    export function read(buf: ByteBuffer): AuthoritativePutComponentMessage | null;
+}
+
 /** AvatarAnchorPointType determines the part of the avatar's body that anchors the Entity. */
 /**
  * @public
@@ -264,9 +245,6 @@ 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>;
 
@@ -380,6 +358,22 @@ export declare interface BaseComponent<T> {
      * If the value is undefined, the component was deleted.
      */
     onChange(entity: Entity, cb: (value: T | undefined) => void): void;
+    /**
+     * @public
+     *
+     */
+    validateBeforeChange(entity: Entity, cb: ValidateCallback<T>): void;
+    validateBeforeChange(cb: ValidateCallback<T>): void;
+    /**
+     * Get the CRDT state for an entity (serialized data and timestamp)
+     * @param entity - Entity to get the CRDT state for
+     * @returns Object with serialized data and timestamp, or null if entity doesn't have the component
+     * @public
+     */
+    getCrdtState(entity: Entity): {
+        data: Uint8Array;
+        timestamp: number;
+    } | null;
 }
 
 /** @public */
@@ -1379,7 +1373,6 @@ 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>>;
@@ -1387,7 +1380,6 @@ 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>>;
@@ -1590,12 +1582,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
 /**
  * @public
  */
-export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
+export declare type CrdtMessage = PutComponentMessage | AuthoritativePutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
 
 /**
  * @public
  */
-export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
+export declare type CrdtMessageBody = PutComponentMessageBody | AuthoritativePutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
 
 /**
  * Min length = 8 bytes
@@ -1650,7 +1642,8 @@ export declare enum CrdtMessageType {
     PUT_COMPONENT_NETWORK = 5,
     DELETE_COMPONENT_NETWORK = 6,
     DELETE_ENTITY_NETWORK = 7,
-    MAX_MESSAGE_TYPE = 8
+    AUTHORITATIVE_PUT_COMPONENT = 8,
+    MAX_MESSAGE_TYPE = 9
 }
 
 /**
@@ -1658,6 +1651,8 @@ export declare enum CrdtMessageType {
  */
 export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
 
+export declare const CreatedBy: ICreatedBy;
+
 /**
  * @public
  */
@@ -2350,6 +2345,12 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
 
 export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
 
+export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
+
+export declare interface ICreatedByType {
+    address: string;
+}
+
 /**
  * @public
  */
@@ -2745,8 +2746,7 @@ export declare const enum InputAction {
     IA_ACTION_3 = 10,
     IA_ACTION_4 = 11,
     IA_ACTION_5 = 12,
-    IA_ACTION_6 = 13,
-    IA_MODIFIER = 14
+    IA_ACTION_6 = 13
 }
 
 export declare const InputModifier: InputModifierComponentDefinitionExtended;
@@ -2794,6 +2794,35 @@ export declare type InstanceCompositeOptions = {
     alreadyRequestedSrc?: Set<string>;
 };
 
+/**
+ * Internal component interface that exposes all internal methods for SDK use
+ * This is not exposed to users, only for internal SDK operations
+ */
+export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
+    /**
+     * @public
+     * Dry run update to check if a CRDT message would be accepted without actually applying it
+     */
+    __dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
+    /**
+     * @public
+     * Get the iterator to every entity has the component
+     */
+    iterator(): Iterable<[Entity, any]>;
+    /**
+     * @public
+     */
+    dirtyIterator(): Iterable<Entity>;
+    /**
+     * @public
+     */
+    __onChangeCallbacks(entity: Entity, value: T): void;
+    /**
+     * @public
+     */
+    __run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
+}
+
 /**
  * @public
  */
@@ -4450,45 +4479,6 @@ 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
  */
@@ -4678,36 +4668,6 @@ 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;
-}
-
-/**
- * @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.
@@ -6459,7 +6419,6 @@ 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
@@ -6467,8 +6426,6 @@ export declare namespace PBVideoPlayer {
 export declare interface PBVirtualCamera {
     defaultTransition?: CameraTransition | undefined;
     lookAtEntity?: number | undefined;
-    /** default: 60 */
-    fov?: number | undefined;
 }
 
 /**
@@ -8837,6 +8794,14 @@ export declare interface UiTransformProps {
  */
 export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
 
+export declare type ValidateCallback<T> = (value: {
+    entity: Entity;
+    currentValue: T | undefined;
+    newValue: T | undefined;
+    senderAddress: string;
+    createdBy: string;
+}) => boolean;
+
 /**
  * @public
  */