@dcl/sdk 7.0.0-3290193397.commit-3ca136b → 7.0.0-3313983919.commit-4ba44d2

package/dist/ecs7/index.d.ts

@@ -1333,6 +1333,53 @@ export declare type IEngineParams = {
  */
 declare function IEnum<T>(type: ISchema<any>): ISchema<T>;
 
+/**
+ * @public
+ */
+export declare type IInput = {
+    /**
+     * Check if a click was emmited in the current tick for the input action.
+     * This is defined when an UP event is triggered with a previously DOWN state.
+     * @param inputAction - the input action to query
+     * @param entity - the entity to query, ignore for global events.
+     * @returns true if the entity was clicked in the last tick-update
+     */
+    wasJustClicked: (inputAction: InputAction, entity?: Entity) => boolean;
+    /**
+     * Check if a pointer event has been emited in the last tick-update.
+     * @param inputAction - the input action to query
+     * @param pointerEventType - the pointer event type to query
+     * @param entity - the entity to query, ignore for global
+     * @returns
+     */
+    wasInputJustActive: (inputAction: InputAction, pointerEventType: PointerEventType, entity?: Entity) => boolean;
+    /**
+     * Check if an input action is in DOWN state.
+     * @param inputAction - the input action to query
+     * @returns true if the input action is being pressed
+     */
+    isActionDown: (inputAction: InputAction) => boolean;
+    /**
+     * Get the click info if a click was emmited in the current tick for the input action.
+     * This is defined when an UP event is triggered with a previously DOWN state.
+     * @param inputAction - the input action to query
+     * @param entity - the entity to query, ignore for global events.
+     * @returns the click info or undefined if there is no command in the last tick-update
+     */
+    getClick: (inputAction: InputAction, entity?: Entity) => {
+        up: PBPointerEventsResult_PointerCommand;
+        down: PBPointerEventsResult_PointerCommand;
+    } | null;
+    /**
+     * Get the input command info if a pointer event has been emited in the last tick-update.
+     * @param inputAction - the input action to query
+     * @param pointerEventType - the pointer event type to query
+     * @param entity - the entity to query, ignore for global
+     * @returns the input command info or undefined if there is no command in the last tick-update
+     */
+    getInputCommand: (inputAction: InputAction, pointerEventType: PointerEventType, entity?: Entity) => PBPointerEventsResult_PointerCommand | null;
+};
+
 /**
  * @public
  */
@@ -1343,6 +1390,11 @@ declare type IncludeUndefined<T> = {
     [P in keyof T]: undefined extends T[P] ? P : never;
 }[keyof T];
 
+/**
+ * @public
+ */
+export declare const Input: IInput;
+
 declare const enum InputAction {
     IA_POINTER = 0,
     IA_PRIMARY = 1,
@@ -1374,10 +1426,6 @@ export declare type ISchema<T = any> = {
     create(): T;
 };
 
-export declare const isPointerEventActive: (entity: Entity, actionButton: InputAction, pointerEventType: PointerEventType) => boolean;
-
-export declare function isPointerEventActiveGenerator(engine: IEngine): (entity: Entity, actionButton: InputAction, pointerEventType: PointerEventType) => boolean;
-
 export declare const log: (...a: any[]) => void;
 
 /**
@@ -4245,10 +4293,6 @@ declare interface Vector3_2 {
 /** @public */
 export declare const VisibilityComponent: ComponentDefinition<ISchema<PBVisibilityComponent>, PBVisibilityComponent>;
 
-export declare const wasEntityClicked: (entity: Entity, actionButton: InputAction) => boolean;
-
-export declare function wasEntityClickedGenerator(engine: IEngine): (entity: Entity, actionButton: InputAction) => boolean;
-
 declare namespace WireMessage {
     enum Enum {
         RESERVED = 0,