@dcl/react-ecs 0.0.1-3379451953.commit-41b47e2 → 0.0.1-3381668097.commit-01e37d6

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+
+
 export declare const CANVAS_ROOT_ENTITY = 7;
 
 export declare type Children = any;
@@ -28,6 +30,13 @@ export declare type EcsElements = {
     entity: Partial<Omit<EntityComponents, 'onClick'> & CommonProps>;
 };
 
+/**
+ * @public
+ */
+declare type Entity = number & {
+    [entitySymbol]: true;
+};
+
 export declare type EntityComponents = {
     uiTransform: PBUiTransform;
     uiText: PBUiText;
@@ -44,12 +53,70 @@ export declare type EntityPropTypes = {
     uiBackground?: UiBackgroundProps;
 };
 
+declare const entitySymbol: unique symbol;
+
+declare type EventsSystem = typeof EventsSystem;
+
+declare namespace EventsSystem {
+    type Callback = (event: PBPointerEventsResult_PointerCommand) => void | Promise<void>;
+    type Options = {
+        button?: InputAction;
+        hoverText?: string;
+        maxDistance?: number;
+    };
+    /**
+     * @public
+     * Remove the callback for onPointerDown event
+     * @param entity Entity where the callback was attached
+     */
+    function removeOnPointerDown(entity: Entity): void;
+    /**
+     * @public
+     * Remove the callback for onPointerUp event
+     * @param entity Entity where the callback was attached
+     */
+    function removeOnPointerUp(entity: Entity): void;
+    /**
+     * @public
+     * Execute callback when the user press the InputButton pointing at the entity
+     * @param entity Entity to attach the callback
+     * @param cb Function to execute when click fires
+     * @param opts Opts to trigger Feedback and Button
+     */
+    function onPointerDown(entity: Entity, cb: Callback, opts?: Options): void;
+    /**
+     * @public
+     * Execute callback when the user releases the InputButton pointing at the entity
+     * @param entity Entity to attach the callback
+     * @param cb Function to execute when click fires
+     * @param opts Opts to trigger Feedback and Button
+     */
+    function onPointerUp(entity: Entity, cb: Callback, opts?: Options): void;
+}
+
 export declare enum Font {
     F_LIBERATION_SANS = 0,
     F_SANS_SERIF = 1,
     UNRECOGNIZED = -1
 }
 
+declare const enum InputAction {
+    IA_POINTER = 0,
+    IA_PRIMARY = 1,
+    IA_SECONDARY = 2,
+    IA_ANY = 3,
+    IA_FORWARD = 4,
+    IA_BACKWARD = 5,
+    IA_RIGHT = 6,
+    IA_LEFT = 7,
+    IA_JUMP = 8,
+    IA_WALK = 9,
+    IA_ACTION_3 = 10,
+    IA_ACTION_4 = 11,
+    IA_ACTION_5 = 12,
+    IA_ACTION_6 = 13
+}
+
 export declare const isListener: (key: string) => key is "onClick";
 
 export declare namespace JSX {
@@ -66,7 +133,19 @@ export declare type Listeners = {
     onClick?: OnClick;
 };
 
-export declare type OnClick = () => Promise<void> | void;
+export declare type OnClick = EventsSystem.Callback;
+
+/** this message represents a pointer event, used both for UP and DOWN actions */
+declare interface PBPointerEventsResult_PointerCommand {
+    /** identifier of the input */
+    button: InputAction;
+    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;
+}
 
 export declare interface PBUiBackground {
     /** default=(0.0, 0.0, 0.0, 0.0) */
@@ -146,6 +225,13 @@ export declare interface PBUiTransform {
     borderBottom: number;
 }
 
+declare const enum PointerEventType {
+    PET_UP = 0,
+    PET_DOWN = 1,
+    PET_HOVER_ENTER = 2,
+    PET_HOVER_LEAVE = 3
+}
+
 /**
  * @public
  */
@@ -158,6 +244,17 @@ export declare type Position = {
 
 export declare type PositionUnit = `${number}px` | `${number}%` | 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;
+}
+
 declare namespace ReactEcs {
     namespace JSX {
         interface Element {
@@ -228,6 +325,12 @@ export declare interface UiTransformProps {
     overflow?: YGOverflow;
 }
 
+declare interface Vector3_2 {
+    x: number;
+    y: number;
+    z: number;
+}
+
 export declare enum YGAlign {
     YGA_AUTO = 0,
     YGA_FLEX_START = 1,