lyb-pixi-js 1.4.10 → 1.5.0

package/README.md

@@ -122,8 +122,6 @@ app.stage.addChild(box);
 
 \- [LibPixiEvent-事件注册](#LibPixiEvent-事件注册)
 
-\- [LibPixiEventControlled-可关闭的事件](#LibPixiEventControlled-可关闭的事件)
-
 \- [LibPixiFilter-滤镜](#LibPixiFilter-滤镜)
 
 \- [LibPixiIntervalTrigger-间隔触发](#LibPixiIntervalTrigger-间隔触发)
@@ -610,21 +608,34 @@ libPixiEvent(
   (e) => {
     console.log("Pointer up event triggered", e);
   },
-  true
+  {
+    once: true,
+  }
 );
-```
 
-### LibPixiEventControlled-可关闭的事件
-
-> 设置可关闭的事件监听，调用自身后不再触发
-
-```ts
-const closeEvent = libPixiEventControlled(container, "pointerdown", (e) => {
-  console.log("Pointer down event triggered", e);
-});
+//防抖
+libPixiEvent(
+  container,
+  "pointerup",
+  (e) => {
+    console.log("Pointer up event triggered", e);
+  },
+  {
+    debounce: true,
+    debounceTime: 1000,
+  }
+);
 
-//调用返回的函数关闭事件监听
-closeEvent();
+//停止监听
+const off = libPixiEvent(
+  container,
+  "pointerup",
+  (e) => {
+    console.log("Pointer up event triggered", e);
+  },
+  true
+);
+off();
 ```
 
 ### LibPixiFilter-滤镜

package/Utils/LibPixiEvent.d.ts

@@ -1,10 +1,16 @@
-import type { Container, DisplayObjectEvents } from "pixi.js";
+import type { Container, DisplayObjectEvents, FederatedPointerEvent } from "pixi.js";
+export interface LibPixiEventParams {
+    /** 是否只执行一次 */
+    once?: boolean;
+    /** 是否启用防抖 */
+    debounce?: boolean;
+    /** 防抖时长 */
+    debounceTime?: number;
+}
 /** @description 事件注册
  * @param v 事件容器
  * @param eventName 事件名称
  * @param callback 回调函数
- * @param once 是否只执行一次
  * @returns 停止监听
- * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiEvent-事件注册
  */
-export declare const libPixiEvent: (v: Container, eventName: keyof DisplayObjectEvents, callback: (...args: any) => void, once?: boolean) => () => void;
+export declare const libPixiEvent: (v: Container, eventName: keyof DisplayObjectEvents, callback: (event: FederatedPointerEvent) => void, params?: LibPixiEventParams) => () => void;

package/Utils/LibPixiEvent.js

@@ -1,12 +1,26 @@
+const debounceImmediate = (func, wait) => {
+    let timer = null;
+    let invoked = false;
+    return (...args) => {
+        if (!invoked) {
+            func(...args);
+            invoked = true;
+        }
+        if (timer)
+            clearTimeout(timer);
+        timer = setTimeout(() => {
+            invoked = false;
+        }, wait);
+    };
+};
 /** @description 事件注册
  * @param v 事件容器
  * @param eventName 事件名称
  * @param callback 回调函数
- * @param once 是否只执行一次
  * @returns 停止监听
- * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiEvent-事件注册
  */
-export const libPixiEvent = (v, eventName, callback, once = false) => {
+export const libPixiEvent = (v, eventName, callback, params = {}) => {
+    const { once = false, debounce = false, debounceTime = 1000 } = params;
     v.cursor = "pointer";
     v.eventMode = "static";
     const fn = (e) => {
@@ -14,13 +28,14 @@ export const libPixiEvent = (v, eventName, callback, once = false) => {
             return;
         callback(e);
     };
+    const handler = debounce ? debounceImmediate(fn, debounceTime) : fn;
     if (once) {
-        v.once(eventName, fn);
+        v.once(eventName, handler);
     }
     else {
-        v.on(eventName, fn);
+        v.on(eventName, handler);
     }
     return () => {
-        v.off(eventName, fn);
+        v.off(eventName, handler);
     };
 };

package/Utils/LibPixiEventControlled.d.ts

@@ -1,8 +1,8 @@
-import type { Container, DisplayObjectEvents } from "pixi.js";
+import type { Container, DisplayObjectEvents, FederatedPointerEvent } from "pixi.js";
 /** @description 设置可关闭的事件监听，调用自身后不再触发
  * @param container 事件容器
  * @param eventName 事件名称
  * @param callback 事件回调
  * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiEventControlled-可关闭的事件
  */
-export declare const libPixiEventControlled: (container: Container, eventName: keyof DisplayObjectEvents, callback: (...args: any) => void) => () => void;
+export declare const libPixiEventControlled: (container: Container, eventName: keyof DisplayObjectEvents, callback: (e: FederatedPointerEvent) => void) => () => void;

package/libPixiJs.d.ts

@@ -106,14 +106,7 @@ export declare const Utils: {
      * @param once 是否只执行一次
      * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiEvent-事件注册
      */
-    libPixiEvent: (v: import("pixi.js").Container, eventName: keyof import("pixi.js").DisplayObjectEvents, callback: (...args: any) => void, once?: boolean) => () => void;
-    /** @description 设置可关闭的事件监听，调用自身后不再触发
-     * @param container 事件容器
-     * @param eventName 事件名称
-     * @param callback 事件回调
-     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiEventControlled-可关闭的事件
-     */
-    libPixiEventControlled: (container: import("pixi.js").Container, eventName: keyof import("pixi.js").DisplayObjectEvents, callback: (...args: any) => void) => () => void;
+    libPixiEvent: (v: import("pixi.js").Container, eventName: keyof import("pixi.js").DisplayObjectEvents, callback: (event: import("pixi.js").FederatedPointerEvent) => void, params?: import("./Utils/LibPixiEvent").LibPixiEventParams) => () => void;
     /** @description 滤镜
      * @param filterName 滤镜名称
      * @param v 滤镜值

package/libPixiJs.js

@@ -17,7 +17,6 @@ import { LibPixiTable } from "./Components/Custom/LibPixiTable";
 import { LibPixiAudio } from "./Utils/LibPixiAudio";
 import { libPixiCreateNineGrid } from "./Utils/LibPixiCreateNineGrid";
 import { libPixiEvent } from "./Utils/LibPixiEvent";
-import { libPixiEventControlled } from "./Utils/LibPixiEventControlled";
 import { libPixiIntervalTrigger } from "./Utils/LibPixiIntervalTrigger";
 import { libPixiOutsideClick } from "./Utils/LibPixiOutsideClick";
 import { libPixiOverflowHidden } from "./Utils/LibPixiOverflowHidden";
@@ -118,13 +117,6 @@ export const Utils = {
      * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiEvent-事件注册
      */
     libPixiEvent,
-    /** @description 设置可关闭的事件监听，调用自身后不再触发
-     * @param container 事件容器
-     * @param eventName 事件名称
-     * @param callback 事件回调
-     * @link 使用方法：https://www.npmjs.com/package/lyb-pixi-js#LibPixiEventControlled-可关闭的事件
-     */
-    libPixiEventControlled,
     /** @description 滤镜
      * @param filterName 滤镜名称
      * @param v 滤镜值