@bettergi/types 0.0.4 → 0.0.6

package/README.md

@@ -1,12 +1,14 @@
-TypeScript type definitions for [Better Genshin Impact](https://github.com/babalae/better-genshin-impact) JavaScript scripts.
+本项目是一个为 [Better Genshin Impact](https://github.com/babalae/better-genshin-impact) 提供的 JavaScript 类型声明文件。
 
-## Installation
+## 安装
 
 ```shell
 npm install --save-dev @bettergi/types
 ```
 
-## Usage
+## 用法
+
+在项目的 `tsconfig.json` 文件中添加类型引用。
 
 ```json
 {
@@ -15,7 +17,3 @@ npm install --save-dev @bettergi/types
   }
 }
 ```
-
-## Related Tools
-
-[@bettergi/create-script](https://www.npmjs.com/package/@bettergi/create-script)

package/csharp/BetterGenshinImpact/Core/Recognition/RecognitionObject.d.ts

@@ -83,8 +83,10 @@ export interface RecognitionObject {
   /** 颜色匹配方式 */
   colorConversionCode: ColorConversionCodes;
 
+  /** 起始颜色范围 */
   lowerColor: Scalar;
 
+  /** 终止颜色范围 */
   upperColor: Scalar;
 
   /**
@@ -108,19 +110,44 @@ export interface RecognitionObject {
   /** 正则匹配 多个值全匹配的情况下才算成功 */
   regexMatchText: List<string>;
 
+  /** 初始化模板 */
   initTemplate(): RecognitionObject;
 }
 
 declare global {
   namespace RecognitionObject {
+    /**
+     * 识别图片模板
+     * @param mat 模板图片
+     */
     function templateMatch(mat: Mat): RecognitionObject;
 
+    /**
+     * 在指定区域识别图片模板
+     * @param mat 模板图片
+     * @param x 水平位置（像素）
+     * @param y 垂直位置（像素）
+     * @param w 宽度
+     * @param h 高度
+     */
     function templateMatch(mat: Mat, x: number, y: number, w: number, h: number): RecognitionObject;
 
+    /**
+     * 识别指定区域
+     * @param x 水平位置（像素）
+     * @param y 垂直位置（像素）
+     * @param w 宽度
+     * @param h 高度
+     */
     function ocr(x: number, y: number, w: number, h: number): RecognitionObject;
 
+    /**
+     * 识别矩形区域
+     * @param rect 矩形
+     */
     function ocr(rect: Rect): RecognitionObject;
 
+    /** 识别文字 */
     var ocrThis: RecognitionObject;
   }
 }

package/csharp/BetterGenshinImpact/Core/Recognition/RecognitionTypes.d.ts

@@ -16,5 +16,6 @@ export enum RecognitionTypes {
   /** 提取指定颜色后进行文字识别 */
   ColorRangeAndOcr,
 
+  /** 自动检测 */
   Detect
 }

package/csharp/BetterGenshinImpact/GameTask/Model/Area/ImageRegion.d.ts

@@ -33,7 +33,11 @@ export interface ImageRegion extends Region {
    * @param successAction 识别成功回调
    * @param failAction 识别失败回调
    */
-  find: (ro: RecognitionObject, successAction?: () => Region, failAction?: () => void) => Region;
+  find: (
+    ro: RecognitionObject,
+    successAction?: (region: Region) => void,
+    failAction?: () => void
+  ) => Region;
 
   /**
    * 在本区域内查找识别对象，返回所有找到的结果
@@ -44,7 +48,7 @@ export interface ImageRegion extends Region {
    */
   findMulti: (
     ro: RecognitionObject,
-    successAction?: () => List<Region>,
+    successAction?: (regions: List<Region>) => void,
     failAction?: () => void
   ) => List<Region>;
 }

package/csharp/System/Windows/Point.d.ts

@@ -1,4 +1,7 @@
 export interface Point {
+  /** 目标水平位置（像素） */
   x: number;
+
+  /** 目标垂直位置（像素） */
   y: number;
 }

package/csharp/Vanara/PInvoke/POINT.d.ts

@@ -1,9 +1,23 @@
 export interface POINT {
+  /** 目标水平位置（像素） */
   x: number;
+
+  /** 目标垂直位置（像素） */
   y: number;
+
+  /** 判断该点是否为空 */
   isEmpty: boolean;
 
+  /**
+   * 通过给定的偏移量移动当前点
+   * @param dx - x 轴方向的偏移量（正数向右，负数向左）。
+   * @param dy - y 轴方向的偏移量（正数向下，负数向上）。
+   */
   offset(dx: number, dy: number): void;
 
+  /**
+   * 通过另一个点对象偏移当前点
+   * @param p - 包含偏移量的 `POINT` 对象，其 `x` 和 `y` 值会被加到当前点。
+   */
   offset(p: POINT): void;
 }

package/csharp/Vanara/PInvoke/RECT.d.ts

@@ -2,17 +2,36 @@ import { POINT } from "./POINT";
 import { SIZE } from "./SIZE";
 
 export interface RECT {
+  /**  矩形左侧的 x 坐标 */
   left: number;
+
+  /** 矩形顶部的 y 坐标 */
   top: number;
+
+  /** 矩形右侧的 x 坐标 */
   right: number;
+
+  /** 矩形底部的 y 坐标 */
   bottom: number;
+
+  /** 目标水平位置（像素） */
   x: number;
+
+  /** 目标垂直位置（像素） */
   y: number;
+
+  /** 矩形的宽度 */
   width: number;
+
+  /** 矩形的高度 */
   height: number;
+
+  /** 判断矩形是否为空 */
   isEmpty: boolean;
 
+  /** 获取矩形的位置 */
   location(): POINT;
 
+  /** 获取矩形的尺寸 */
   size(): SIZE;
 }

package/csharp/Vanara/PInvoke/SIZE.d.ts

@@ -1,9 +1,19 @@
 export interface SIZE {
+  /** 尺寸的宽度 */
   cx: number;
+
+  /** 尺寸的高度 */
   cy: number;
+
+  /** 尺寸的宽度 */
   width: number;
+
+  /** 尺寸的高度 */
   height: number;
+
+  /** 判断尺寸是否为空 */
   isEmpty: boolean;
 
+  /** 返回当前尺寸的副本 */
   toSize(): SIZE;
 }

package/modules/globalMethod.d.ts

@@ -121,9 +121,10 @@ declare global {
 
   /**
    * 鼠标滚动
+   * @param scrollAmountInClicks - 滚动的点击数 正数向上滚动，负数向下滚动
    * @since 0.44.5
    */
-  function verticalScroll(): void;
+  function verticalScroll(scrollAmountInClicks: number): void;
 
   /**
    * 捕获当前游戏窗口内容

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bettergi/types",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "TypeScript Definitions for BetterGI JavaScript",
   "type": "module",
   "author": "Bread Grocery<https://github.com/breadgrocery>",