@dcl/sdk 7.0.0-3000191624.commit-0ff97dc → 7.0.0-3015711272.commit-6716e5a

package/dist/ecs7/index.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="@dcl/posix" />
+
 declare const enum ActionButton {
     POINTER = 0,
     PRIMARY = 1,
@@ -245,8 +247,14 @@ export declare namespace Components {
     /** @public */
     const PlaneShape: ComponentDefinition<ISchema<PBPlaneShape>, PBPlaneShape>;
     /** @public */
+    const PointerEvents: ComponentDefinition<ISchema<PBPointerEvents>, PBPointerEvents>;
+    /** @public */
+    const PointerEventsResult: ComponentDefinition<ISchema<PBPointerEventsResult>, PBPointerEventsResult>;
+    /** @public */
     const PointerLock: ComponentDefinition<ISchema<PBPointerLock>, PBPointerLock>;
     /** @public */
+    const RaycastResult: ComponentDefinition<ISchema<PBRaycastResult>, PBRaycastResult>;
+    /** @public */
     const SphereShape: ComponentDefinition<ISchema<PBSphereShape>, PBSphereShape>;
     /** @public */
     const TextShape: ComponentDefinition<ISchema<PBTextShape>, PBTextShape>;
@@ -478,7 +486,10 @@ declare function defineSdkComponents(engine: PreEngine): {
     OnPointerUp: ComponentDefinition<ISchema<PBOnPointerUp>, PBOnPointerUp>;
     OnPointerUpResult: ComponentDefinition<ISchema<PBOnPointerUpResult>, PBOnPointerUpResult>;
     PlaneShape: ComponentDefinition<ISchema<PBPlaneShape>, PBPlaneShape>;
+    PointerEvents: ComponentDefinition<ISchema<PBPointerEvents>, PBPointerEvents>;
+    PointerEventsResult: ComponentDefinition<ISchema<PBPointerEventsResult>, PBPointerEventsResult>;
     PointerLock: ComponentDefinition<ISchema<PBPointerLock>, PBPointerLock>;
+    RaycastResult: ComponentDefinition<ISchema<PBRaycastResult>, PBRaycastResult>;
     SphereShape: ComponentDefinition<ISchema<PBSphereShape>, PBSphereShape>;
     TextShape: ComponentDefinition<ISchema<PBTextShape>, PBTextShape>;
     UiText: ComponentDefinition<ISchema<PBUiText>, PBUiText>;
@@ -608,7 +619,7 @@ export declare type IEngine = {
      *
      * ```
      */
-    defineComponent<T extends Spec, ConstructorType = Partial<Result<T>>>(spec: T, componentId: number, constructorDefault?: Partial<Result<T>>): ComponentDefinition<ISchema<Result<T>>, ConstructorType>;
+    defineComponent<T extends Spec, ConstructorType = Partial<Result<T>>>(spec: T, componentId: number, constructorDefault?: ConstructorType): ComponentDefinition<ISchema<Result<T>>, Partial<Result<T>>>;
     /**
      * Define a component and add it to the engine.
      * @param spec An object with schema fields
@@ -644,6 +655,7 @@ export declare type IEngine = {
      * ```
      */
     getEntitiesWith<T extends [ComponentDefinition, ...ComponentDefinition[]]>(...components: T): Iterable<[Entity, ...ReadonlyComponentSchema<T>]>;
+    RootEntity: Entity;
     baseComponents: SdkComponents;
 };
 
@@ -698,6 +710,17 @@ export declare interface ISize {
     height: number;
 }
 
+/**
+ * Check if a pointer event has been emited in the last tick-update.
+ * @param entity the entity to query, for global clicks use `engine.RootEntity`
+ * @param actionButton
+ * @param pointerEventType
+ * @returns
+ */
+export declare function isPointerEventActive(entity: Entity, actionButton: ActionButton, pointerEventType: PointerEventType): boolean;
+
+export declare function isPointerEventActiveGenerator(engine: IEngine): (entity: Entity, actionButton: ActionButton, pointerEventType: PointerEventType) => boolean;
+
 export declare const log: (...a: any[]) => void;
 
 /** @public */
@@ -1434,6 +1457,248 @@ export declare const NFTShape: ComponentDefinition<ISchema<PBNFTShape>, PBNFTSha
 /** @public */
 export declare type Nullable<T> = T | null;
 
+/**
+ * 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.
+ *
+ * @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
+ */
+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;
+    /**
+     * 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
+ */
+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;
+}
+
+/**
+ * This event is triggered when you change your camera between 1st and 3rd person
+ * @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 onCameraModeChangedObservable: Observable<{
+    cameraMode: 0 | 1 | 2;
+}>;
+
+/** @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;
+}>;
+
+/**
+ * This event is triggered when you change your camera between 1st and 3rd person
+ * @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 onIdleStateChangedObservable: Observable<{
+    isIdle: boolean;
+}>;
+
+/** @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;
+}>;
+
 declare type OnlyNonUndefinedTypes<T> = {
     [K in ExcludeUndefined<T>]: T[K];
 };
@@ -1442,18 +1707,102 @@ 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: {
+        origin: ReadOnlyVector3;
+        direction: ReadOnlyVector3;
+        distance: 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 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 */
 export declare const OnPointerDown: ComponentDefinition<ISchema<PBOnPointerDown>, PBOnPointerDown>;
 
 /** @public */
 export declare const OnPointerDownResult: ComponentDefinition<ISchema<PBOnPointerDownResult>, PBOnPointerDownResult>;
 
+/**
+ * @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 onPointerLockedStateChange: Observable<{
+    locked?: boolean | undefined;
+}>;
+
 /** @public */
 export declare const OnPointerUp: ComponentDefinition<ISchema<PBOnPointerUp>, PBOnPointerUp>;
 
 /** @public */
 export declare const OnPointerUpResult: ComponentDefinition<ISchema<PBOnPointerUpResult>, PBOnPointerUpResult>;
 
+/**
+ * @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;
+    serverName: string;
+    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<{}>;
+
+/**
+ * @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;
+    videoStatus: number;
+    currentOffset: number;
+    totalVideoLength: number;
+}>;
+
 /**
  * Defines potential orientation for back face culling
  * @public
@@ -1744,10 +2093,55 @@ declare interface PBPlaneShape {
     uvs: number[];
 }
 
+declare interface PBPointerEvents {
+    pointerEvents: PBPointerEvents_Entry[];
+}
+
+declare interface PBPointerEvents_Entry {
+    eventType: PointerEventType;
+    eventInfo: PBPointerEvents_Info | undefined;
+}
+
+declare interface PBPointerEvents_Info {
+    /** default=ActionButton.ANY */
+    button?: ActionButton | undefined;
+    /** default='Interact' */
+    hoverText?: string | undefined;
+    /** default=10 */
+    maxDistance?: number | undefined;
+    /** default=true */
+    showFeedback?: boolean | undefined;
+}
+
+/** the renderer will set this component to the root entity once per frame with all the events */
+declare interface PBPointerEventsResult {
+    /** a list of the last N pointer commands (from the engine) */
+    commands: PBPointerEventsResult_PointerCommand[];
+}
+
+/** this message represents a pointer event, used both for UP and DOWN actions */
+declare interface PBPointerEventsResult_PointerCommand {
+    /** identifier of the input */
+    button: ActionButton;
+    hit: RaycastHit | undefined;
+    state: PointerEventType;
+    /** could be a Lamport timestamp */
+    timestamp: number;
+    /** if the input is analog then we store it here */
+    analog?: number | undefined;
+}
+
 declare interface PBPointerLock {
     isPointerLocked: boolean;
 }
 
+declare interface PBRaycastResult {
+    timestamp: number;
+    origin: Vector3_2 | undefined;
+    direction: Vector3_2 | undefined;
+    hits: RaycastHit[];
+}
+
 declare interface PBSphereShape {
     /** @deprecated use MeshCollider instead https://github.com/decentraland/sdk/issues/366 */
     withCollisions?: boolean | undefined;
@@ -1916,6 +2310,20 @@ declare namespace Plane {
 /** @public */
 export declare const PlaneShape: ComponentDefinition<ISchema<PBPlaneShape>, PBPlaneShape>;
 
+/** @public */
+export declare const PointerEvents: ComponentDefinition<ISchema<PBPointerEvents>, PBPointerEvents>;
+
+/** @public */
+export declare const PointerEventsResult: ComponentDefinition<ISchema<PBPointerEventsResult>, PBPointerEventsResult>;
+
+declare const enum PointerEventType {
+    UP = 0,
+    DOWN = 1,
+    HOVER_ENTER = 2,
+    HOVER_LEAVE = 3,
+    UNRECOGNIZED = -1
+}
+
 /** @public */
 export declare const PointerLock: ComponentDefinition<ISchema<PBPointerLock>, PBPointerLock>;
 
@@ -2114,6 +2522,20 @@ export declare namespace Quaternion {
  */
 export declare const RAD2DEG: number;
 
+/** Position will be relative to the scene */
+declare interface RaycastHit {
+    position: Vector3_2 | undefined;
+    origin: Vector3_2 | undefined;
+    direction: Vector3_2 | undefined;
+    normalHit: Vector3_2 | undefined;
+    length: number;
+    meshName?: string | undefined;
+    entityId?: number | undefined;
+}
+
+/** @public */
+export declare const RaycastResult: ComponentDefinition<ISchema<PBRaycastResult>, PBRaycastResult>;
+
 /**
  * @public
  */
@@ -2487,6 +2909,16 @@ declare interface Vector3_2 {
 /** @public */
 export declare const VisibilityComponent: ComponentDefinition<ISchema<PBVisibilityComponent>, PBVisibilityComponent>;
 
+/**
+ * Check if an entity emitted a clicked event
+ * @param entity the entity to query, for global clicks use `engine.RootEntity`
+ * @param actionButton
+ * @returns true if the entity was clicked in the last tick-update
+ */
+export declare function wasEntityClicked(entity: Entity, actionButton: ActionButton): boolean;
+
+export declare function wasEntityClickedGenerator(engine: IEngine): (entity: Entity, actionButton: ActionButton) => boolean;
+
 declare namespace WireMessage {
     enum Enum {
         RESERVED = 0,