@dcl/playground-assets 7.4.4 → 7.4.5-8054791102.commit-f06a0a7

package/dist/alpha.d.ts

@@ -1451,6 +1451,25 @@ export declare function createEntityContainer(opts?: {
     reservedStaticEntities: number;
 }): IEntityContainer;
 
+/**
+ * This module is exposed by the sdk via `@dcl/sdk/etherum-provider`
+ *
+
+ * @example
+ * ```tsx
+ * import { createEthereumProvider } from '@dcl/sdk/ethereum-provider'
+ * import { ethers } from 'ethers'
+
+ * const provider = new ethers.providers.Web3Provider(createEthereumProvider() as any)
+ * ```
+ *
+ * @module Etherum Provider
+ *
+ */
+/**
+ * Etherum Provider
+ * @public
+ */
 export declare function createEthereumProvider(): {
     send(message: RPCSendableMessage, callback?: ((error: Error | null, result?: any) => void) | undefined): void;
     sendAsync(message: RPCSendableMessage, callback: (error: Error | null, result?: any) => void): void;
@@ -1707,7 +1726,9 @@ export declare function Engine(options?: IEngineOptions): IEngine;
  */
 export declare const engine: IEngine;
 
+/** @public */
 export declare type EngineEvent<T extends IEventNames = IEventNames, V = IEvents[T]> = {
+    /** eventName */
     type: T;
     data: Readonly<V>;
 };
@@ -1884,6 +1905,7 @@ export declare function getComponentEntityTree<T>(engine: Pick<IEngine, 'getEnti
  */
 export declare function getCompositeRootComponent(engine: IEngine): LastWriteWinElementSetComponentDefinition<CompositeRootType>;
 
+/** @public */
 export declare type GizmoDragEndEvent = {
     type: 'gizmoDragEnded';
     transforms: Array<{
@@ -1894,6 +1916,7 @@ export declare type GizmoDragEndEvent = {
     }>;
 };
 
+/** @public */
 export declare type GizmoSelectedEvent = {
     type: 'gizmoSelected';
     gizmoType: 'MOVE' | 'ROTATE' | 'SCALE' | 'NONE';
@@ -1906,7 +1929,12 @@ export declare type GlobalDirectionRaycastSystemOptions = {
     direction?: PBVector3;
 };
 
+/** @public */
 export declare type GlobalInputEventResult = InputEventResult & {
+    /**
+     * DOWN = 0,
+     * UP = 1
+     */
     type: 0 | 1;
 };
 
@@ -2156,79 +2184,199 @@ export declare type IEntityContainer = {
     updateUsedEntity(entity: Entity): boolean;
 };
 
+/** @public */
 export declare type IEventNames = keyof IEvents;
 
+/**
+ * @public
+ * Note: Don't use `on` prefix for IEvents to avoid redundancy with `event.on("onEventName")` syntax.
+ */
 export declare interface IEvents {
+    /**
+     * `positionChanged` is triggered when the position of the camera changes
+     * This event is throttled to 10 times per second.
+     */
     positionChanged: {
+        /** Camera position relative to the base parcel of the scene */
         position: Vector3Type;
+        /** Camera position, this is a absolute world position */
         cameraPosition: Vector3Type;
+        /** Eye height, in meters. */
         playerHeight: number;
     };
+    /**
+     * `rotationChanged` is triggered when the rotation of the camera changes.
+     * This event is throttled to 10 times per second.
+     */
     rotationChanged: {
+        /** Degree vector. Same as entities */
         rotation: Vector3Type;
+        /** Rotation quaternion, useful in some scenarios. */
         quaternion: QuaternionType;
     };
+    /**
+     * `cameraModeChanged` is triggered when the user changes the camera mode
+     */
     cameraModeChanged: {
+        /**
+         * FIRST_PERSON = 0,
+         * THIRD_PERSON = 1,
+         * FREE_CAMERA = 2
+         */
         cameraMode: 0 | 1 | 2;
     };
+    /**
+     * `idleStateChanged` is triggered when the user not moves for a defined period of time
+     */
     idleStateChanged: {
         isIdle: boolean;
     };
     playerExpression: {
         expressionId: string;
     };
+    /**
+     * `pointerUp` is triggered when the user releases an input pointer.
+     * It could be a VR controller, a touch screen or the mouse.
+     */
     pointerUp: InputEventResult;
+    /**
+     * `pointerDown` is triggered when the user press an input pointer.
+     * It could be a VR controller, a touch screen or the mouse.
+     */
     pointerDown: InputEventResult;
+    /**
+     * `pointerEvent` is triggered when the user press or releases an input pointer.
+     * It could be a VR controller, a touch screen or the mouse.
+     *
+     * @deprecated use actionButtonEvent instead
+     */
     pointerEvent: GlobalInputEventResult;
+    /**
+     * `actionButtonEvent` is triggered when the user press or releases an input pointer.
+     * It could be a VR controller, a touch screen or the mouse.
+     *
+     * This event is exactly the same as `pointerEvent` but the logic in the ECS had an unsolvable
+     * condition that required us to create this new event to handle more cases for new buttons.
+     */
     actionButtonEvent: GlobalInputEventResult;
+    /**
+     * `raycastResponse` is triggered in response to a raycast query
+     */
     raycastResponse: RaycastResponsePayload<any>;
+    /**
+     * `chatMessage` is triggered when the user sends a message through chat entity.
+     */
     chatMessage: {
         id: string;
         sender: string;
         message: string;
         isCommand: boolean;
     };
+    /**
+     * `onChange` is triggered when an entity changes its own internal state.
+     * Dispatched by the `ui-*` entities when their value is changed. It triggers a callback.
+     * Notice: Only entities with ID will be listening for click events.
+     */
     onChange: {
         value?: any;
+        /** ID of the pointer that triggered the event */
         pointerId?: number;
     };
+    /**
+     * `onEnter` is triggered when the user hits the "Enter" key from the keyboard
+     * Used principally by the Chat internal scene
+     */
     onEnter: unknown;
+    /**
+     * `onPointerLock` is triggered when the user clicks the world canvas and the
+     * pointer locks to it so the pointer moves the camera
+     */
     onPointerLock: {
         locked?: boolean;
     };
+    /**
+     * `onAnimationEnd` is triggered when an animation clip gets finish
+     */
     onAnimationEnd: {
         clipName: string;
     };
+    /**
+     * `onFocus` is triggered when an entity focus is active.
+     * Dispatched by the `ui-input` and `ui-password` entities when the value is changed.
+     * It triggers a callback.
+     *
+     * Notice: Only entities with ID will be listening for click events.
+     */
     onFocus: {
+        /** ID of the entitiy of the event */
         entityId: unknown;
+        /** ID of the pointer that triggered the event */
         pointerId: number;
     };
+    /**
+     * `onBlur` is triggered when an entity loses its focus.
+     * Dispatched by the `ui-input` and `ui-password` entities when the value is changed.
+     *  It triggers a callback.
+     *
+     * Notice: Only entities with ID will be listening for click events.
+     */
     onBlur: {
+        /** ID of the entitiy of the event */
         entityId: unknown;
+        /** ID of the pointer that triggered the event */
         pointerId: number;
     };
+    /** The onClick event is only used for UI elements */
     onClick: {
         entityId: unknown;
     };
+    /**
+     * This event gets triggered when an entity leaves the scene fences.
+     */
     entityOutOfScene: {
         entityId: unknown;
     };
+    /**
+     * This event gets triggered when an entity enters the scene fences.
+     */
     entityBackInScene: {
         entityId: unknown;
     };
+    /**
+     * This event gets triggered when the user enters the scene
+     */
     onEnterScene: {
         userId: string;
     };
+    /**
+     * This event gets triggered when the user leaves the scene
+     */
     onLeaveScene: {
         userId: string;
     };
+    /**
+     * This event gets triggered after receiving a comms message.
+     */
     comms: {
         sender: string;
         message: string;
     };
+    /**
+     * This is triggered once the scene should start.
+     */
     sceneStart: unknown;
+    /**
+     * This is triggered once the builder scene is loaded.
+     */
     builderSceneStart: unknown;
+    /**
+     * This is triggered once the builder scene is unloaded.
+     */
     builderSceneUnloaded: unknown;
+    /**
+     * After checking entities outside the fences, if any is outside, this event
+     * will be triggered with all the entities outside the scene.
+     */
     entitiesOutOfBoundaries: {
         entities: string[];
     };
@@ -2247,6 +2395,7 @@ export declare interface IEvents {
         given: Record<string, number>;
         limit: Record<string, number>;
     };
+    /** For gizmos */
     gizmoEvent: GizmoDragEndEvent | GizmoSelectedEvent;
     externalAction: {
         type: string;
@@ -2256,29 +2405,38 @@ export declare interface IEvents {
         type: string;
         payload: any;
     };
+    /** This is triggered at least for each videoStatus change */
     videoEvent: {
         componentId: string;
         videoClipId: string;
+        /** Status, can be NONE = 0, ERROR = 1, LOADING = 2, READY = 3, PLAYING = 4,BUFFERING = 5 */
         videoStatus: number;
+        /** Current offset position in seconds */
         currentOffset: number;
+        /** Video length in seconds. Can be -1 */
         totalVideoLength: number;
     };
+    /** This is trigger everytime a profile is changed */
     profileChanged: {
         ethAddress: string;
         version: number;
     };
+    /** Triggered when peer's avatar is connected and visible */
     playerConnected: {
         userId: string;
     };
+    /** Triggered when peer disconnect and/or it avatar is set invisible by comms */
     playerDisconnected: {
         userId: string;
     };
+    /** Triggered when current realm or island changes */
     onRealmChanged: {
         domain: string;
         room: string;
         serverName: string;
         displayName: string;
     };
+    /** Triggered when other player's avatar is clicked */
     playerClicked: {
         userId: string;
         ray: {
@@ -2287,7 +2445,9 @@ export declare interface IEvents {
             distance: number;
         };
     };
+    /** Triggered when pointer start hovering an entities' shape */
     pointerHoverEnter: unknown;
+    /** Triggered when pointer stop hovering an entities' shape */
     pointerHoverExit: unknown;
 }
 
@@ -2387,16 +2547,27 @@ export declare const enum InputAction {
     IA_ACTION_6 = 13
 }
 
+/** @public */
 export declare type InputEventResult = {
+    /** Origin of the ray, relative to the scene */
     origin: Vector3Type;
+    /** Direction vector of the ray (normalized) */
     direction: Vector3Type;
+    /** ID of the pointer that triggered the event */
     buttonId: number;
+    /** Does this pointer event hit any object? */
     hit?: {
+        /** Length of the ray */
         length: number;
+        /** If the ray hits a mesh the intersection point will be this */
         hitPoint: Vector3Type;
+        /** If the mesh has a name, it will be assigned to meshName */
         meshName: string;
+        /** Normal of the hit */
         normal: Vector3Type;
+        /** Normal of the hit, in world space */
         worldNormal: Vector3Type;
+        /** Hit entity ID if any */
         entityId: unknown;
     };
 };
@@ -3466,6 +3637,10 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
     setSphere(entity: Entity): void;
 }
 
+/**
+ * @alpha
+ * @deprecated this will only exist for a few releases in ECS7
+ */
 export declare class MessageBus {
     private messageQueue;
     private flushing;
@@ -3545,42 +3720,198 @@ export declare const enum NftFrameType {
 /** @public */
 export declare const NftShape: LastWriteWinElementSetComponentDefinition<PBNftShape>;
 
+/**
+ * The Observable class is a simple implementation of the Observable pattern.
+ *
+ * There's one slight particularity though: a given Observable can notify its observer using a particular mask value, only the Observers registered with this mask value will be notified.
+ * This enable a more fine grained execution without having to rely on multiple different Observable objects.
+ * For instance you may have a given Observable that have four different types of notifications: Move (mask = 0x01), Stop (mask = 0x02), Turn Right (mask = 0X04), Turn Left (mask = 0X08).
+ * A given observer can register itself with only Move and Stop (mask = 0x03), then it will only be notified when one of these two occurs and will never be for Turn Left/Right.
+ *
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed
+ */
 export declare class Observable<T> {
     private _observers;
     private _eventState;
     private _onObserverAdded;
+    /**
+     * Creates a new observable
+     * @param onObserverAdded - defines a callback to call when a new observer is added
+     */
     constructor(onObserverAdded?: (observer: Observer<T>) => void);
+    /**
+     * Create a new Observer with the specified callback
+     * @param callback - the callback that will be executed for that Observer
+     * @param mask - the mask used to filter observers
+     * @param insertFirst - if true the callback will be inserted at the first position, hence executed before the others ones. If false (default behavior) the callback will be inserted at the last position, executed after all the others already present.
+     * @param scope - optional scope for the callback to be called from
+     * @param unregisterOnFirstCall - defines if the observer as to be unregistered after the next notification
+     * @returns the new observer created for the callback
+     */
     add(callback: (eventData: T, eventState: ObserverEventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): null | Observer<T>;
+    /**
+     * Create a new Observer with the specified callback and unregisters after the next notification
+     * @param callback - the callback that will be executed for that Observer
+     * @returns the new observer created for the callback
+     */
     addOnce(callback: (eventData: T, eventState: ObserverEventState) => void): null | Observer<T>;
+    /**
+     * Remove an Observer from the Observable object
+     * @param observer - the instance of the Observer to remove
+     * @returns false if it doesn't belong to this Observable
+     */
     remove(observer: null | Observer<T>): boolean;
+    /**
+     * Remove a callback from the Observable object
+     * @param callback - the callback to remove
+     * @param scope - optional scope. If used only the callbacks with this scope will be removed
+     * @returns false if it doesn't belong to this Observable
+     */
     removeCallback(callback: (eventData: T, eventState: ObserverEventState) => void, scope?: any): boolean;
+    /**
+     * Notify all Observers by calling their respective callback with the given data
+     * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
+     * @param eventData - defines the data to send to all observers
+     * @param mask - defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
+     * @param target - defines the original target of the state
+     * @param currentTarget - defines the current target of the state
+     * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
+     */
     notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
+    /**
+     * Calling this will execute each callback, expecting it to be a promise or return a value.
+     * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
+     * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
+     * and it is crucial that all callbacks will be executed.
+     * The order of the callbacks is kept, callbacks are not executed parallel.
+     *
+     * @param eventData - The data to be sent to each callback
+     * @param mask - is used to filter observers defaults to -1
+     * @param target - defines the callback target (see EventState)
+     * @param currentTarget - defines he current object in the bubbling phase
+     * @returns will return a Promise than resolves when all callbacks executed successfully.
+     */
     notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
+    /**
+     * Notify a specific observer
+     * @param observer - defines the observer to notify
+     * @param eventData - defines the data to be sent to each callback
+     * @param mask - is used to filter observers defaults to -1
+     */
     notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
+    /**
+     * Gets a boolean indicating if the observable has at least one observer
+     * @returns true is the Observable has at least one Observer registered
+     */
     hasObservers(): boolean;
+    /**
+     * Clear the list of observers
+     */
     clear(): void;
+    /**
+     * Clone the current observable
+     * @returns a new observable
+     */
     clone(): Observable<T>;
+    /**
+     * Does this observable handles observer registered with a given mask
+     * @param mask - defines the mask to be tested
+     * @returns whether or not one observer registered with the given mask is handeled
+     */
     hasSpecificMask(mask?: number): boolean;
     private _deferUnregister;
     private _remove;
 }
 
+/**
+ * Represent an Observer registered to a given Observable object.
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed
+ * @public
+ */
 export declare class Observer<T> {
+    /**
+     * Defines the callback to call when the observer is notified
+     */
     callback: (eventData: T, eventState: ObserverEventState) => void;
+    /**
+     * Defines the mask of the observer (used to filter notifications)
+     */
     mask: number;
+    /**
+     * Defines the current scope used to restore the JS context
+     */
     scope: any;
+    /**
+     * Gets or sets a property defining that the observer as to be unregistered after the next notification
+     */
     unregisterOnNextCall: boolean;
+    /** For internal usage */
     _willBeUnregistered: boolean;
-    constructor(callback: (eventData: T, eventState: ObserverEventState) => void, mask: number, scope?: any);
+    /**
+     * Creates a new observer
+     * @param callback - defines the callback to call when the observer is notified
+     * @param mask - defines the mask of the observer (used to filter notifications)
+     * @param scope - defines the current scope used to restore the JS context
+     */
+    constructor(
+    /**
+     * Defines the callback to call when the observer is notified
+     */
+    callback: (eventData: T, eventState: ObserverEventState) => void, 
+    /**
+     * Defines the mask of the observer (used to filter notifications)
+     */
+    mask: number, 
+    /**
+     * Defines the current scope used to restore the JS context
+     */
+    scope?: any);
 }
 
+/**
+ * A class serves as a medium between the observable and its observers
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed
+ * @public
+ */
 export declare class ObserverEventState {
+    /**
+     * An Observer can set this property to true to prevent subsequent observers of being notified
+     */
     skipNextObservers: boolean;
+    /**
+     * Get the mask value that were used to trigger the event corresponding to this EventState object
+     */
     mask: number;
+    /**
+     * The object that originally notified the event
+     */
     target?: any;
+    /**
+     * The current object in the bubbling phase
+     */
     currentTarget?: any;
+    /**
+     * This will be populated with the return value of the last function that was executed.
+     * If it is the first function in the callback chain it will be the event data.
+     */
     lastReturnValue?: any;
+    /**
+     * Create a new EventState
+     * @param mask - defines the mask associated with this state
+     * @param skipNextObservers - defines a flag which will instruct the observable to skip following observers when set to true
+     * @param target - defines the original target of the state
+     * @param currentTarget - defines the current target of the state
+     */
     constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
+    /**
+     * Initialize the current event state
+     * @param mask - defines the mask associated with this state
+     * @param skipNextObservers - defines a flag which will instruct the observable to skip following observers when set to true
+     * @param target - defines the original target of the state
+     * @param currentTarget - defines the current target of the state
+     * @returns the current event state
+     */
     initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): ObserverEventState;
 }
 
@@ -3589,18 +3920,34 @@ export declare class ObserverEventState {
  */
 export declare type OnChangeFunction = (entity: Entity, operation: CrdtMessageType, component?: ComponentDefinition<any>, componentValue?: any) => void;
 
+/** @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed. Use onEnterSceneObservable instead. */
 export declare const onEnterScene: Observable<{
     userId: string;
 }>;
 
+/**
+ * These events are triggered after your character enters the scene.
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
 export declare const onEnterSceneObservable: Observable<{
     userId: string;
 }>;
 
+/** @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed. Use onLeaveSceneObservable instead. */
 export declare const onLeaveScene: Observable<{
     userId: string;
 }>;
 
+/**
+ * These events are triggered after your character leaves the scene.
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
 export declare const onLeaveSceneObservable: Observable<{
     userId: string;
 }>;
@@ -3619,6 +3966,10 @@ export declare type OnlyOptionalUndefinedTypes<T> = {
     [K in IncludeUndefined<T>]?: T[K];
 };
 
+/**
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
 export declare const onPlayerClickedObservable: Observable<{
     userId: string;
     ray: {
@@ -3628,23 +3979,43 @@ export declare const onPlayerClickedObservable: Observable<{
     };
 }>;
 
+/**
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
 export declare const onPlayerConnectedObservable: Observable<{
     userId: string;
 }>;
 
+/**
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
 export declare const onPlayerDisconnectedObservable: Observable<{
     userId: string;
 }>;
 
+/**
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
 export declare const onPlayerExpressionObservable: Observable<{
     expressionId: string;
 }>;
 
+/**
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
 export declare const onProfileChanged: Observable<{
     ethAddress: string;
     version: number;
 }>;
 
+/**
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
 export declare const onRealmChangedObservable: Observable<{
     domain: string;
     room: string;
@@ -3652,15 +4023,27 @@ export declare const onRealmChangedObservable: Observable<{
     displayName: string;
 }>;
 
+/**
+ * This event is triggered after all the resources of the scene were loaded (models, textures, etc...)
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
 export declare const onSceneReadyObservable: Observable<unknown>;
 
 export declare function onUpdate(deltaTime: number): Promise<void>;
 
+/**
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
 export declare const onVideoEvent: Observable<{
     componentId: string;
     videoClipId: string;
+    /** Status, can be NONE = 0, ERROR = 1, LOADING = 2, READY = 3, PLAYING = 4,BUFFERING = 5 */
     videoStatus: number;
+    /** Current offset position in seconds */
     currentOffset: number;
+    /** Video length in seconds. Can be -1 */
     totalVideoLength: number;
 }>;
 
@@ -5865,6 +6248,7 @@ export declare const enum RaycastQueryType {
     RQT_NONE = 2
 }
 
+/** @public */
 export declare type RaycastResponsePayload<T> = {
     queryId: string;
     queryType: string;