@dcl/sdk 7.0.0-3008112906.commit-524d1bd → 7.0.0-3015711272.commit-6716e5a

package/dist/ecs7/index.d.ts

@@ -247,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>;
@@ -480,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>;
@@ -610,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
@@ -646,6 +655,7 @@ export declare type IEngine = {
      * ```
      */
     getEntitiesWith<T extends [ComponentDefinition, ...ComponentDefinition[]]>(...components: T): Iterable<[Entity, ...ReadonlyComponentSchema<T>]>;
+    RootEntity: Entity;
     baseComponents: SdkComponents;
 };
 
@@ -700,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 */
@@ -2072,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;
@@ -2244,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>;
 
@@ -2442,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
  */
@@ -2815,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,