@bettergi/types 0.0.14 → 0.1.1

package/README.md

@@ -16,12 +16,15 @@ pnpm install --save-dev @bettergi/types
 
 ## 用法
 
-在 TypeScript 项目的 `tsconfig.json` 配置文件中添加类型引用。
+在 TypeScript 项目的 [`tsconfig.json`](https://www.typescriptlang.org/tsconfig/#types) 配置文件中添加类型引用。
 
 ```json
 {
   "compilerOptions": {
+    // xxx...
+    "lib": ["ES2022"],
     "types": ["@bettergi/types"]
+    // xxx...
   }
 }
 ```

package/csharp/BetterGenshinImpact/GameTask/AutoDomain/AutoDomainParam.d.ts

@@ -51,7 +51,9 @@ declare global {
        * 设置战斗策略路径
        * @param strategyName 策略名称
        */
-      setCombatStrategyPath(strategyName?: string): void;
+      setCombatStrategyPath(strategyName: string): void;
+      // overload
+      setCombatStrategyPath(strategyName: string | null): void;
 
       /**
        * 设置使用树脂优先级

package/csharp/BetterGenshinImpact/GameTask/AutoFight/AutoFightParam.d.ts

@@ -72,7 +72,9 @@ declare global {
        * 设置战斗策略路径
        * @param strategyName 战斗策略名称
        */
-      setCombatStrategyPath(strategyName?: string): void;
+      setCombatStrategyPath(strategyName: string): void;
+      // overload
+      setCombatStrategyPath(strategyName: string | null): void;
 
       /** 设置默认值 */
       setDefault(): void;

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

@@ -30,11 +30,19 @@ declare global {
        * @param successAction 识别成功回调
        * @param failAction 识别失败回调
        */
-      find: (
+      find(
+        ro: BetterGenshinImpact.Core.Recognition.RecognitionObject
+      ): BetterGenshinImpact.GameTask.Model.Area.Region;
+      // overload
+      find(
         ro: BetterGenshinImpact.Core.Recognition.RecognitionObject,
-        successAction?: (region: BetterGenshinImpact.GameTask.Model.Area.Region) => void,
-        failAction?: () => void
-      ) => BetterGenshinImpact.GameTask.Model.Area.Region;
+        successAction: ((region: BetterGenshinImpact.GameTask.Model.Area.Region) => void) | null
+      ): BetterGenshinImpact.GameTask.Model.Area.Region;
+      find(
+        ro: BetterGenshinImpact.Core.Recognition.RecognitionObject,
+        successAction: ((region: BetterGenshinImpact.GameTask.Model.Area.Region) => void) | null,
+        failAction: (() => void) | null
+      ): BetterGenshinImpact.GameTask.Model.Area.Region;
 
       /**
        * 在本区域内查找识别对象，返回所有找到的结果
@@ -43,21 +51,50 @@ declare global {
        * @param failAction  识别失败回调
        * @returns
        */
-      findMulti: (
+      findMulti(
+        ro: BetterGenshinImpact.Core.Recognition.RecognitionObject
+      ): System.Collections.Generic.List<BetterGenshinImpact.GameTask.Model.Area.Region>;
+      // overload
+      findMulti(
+        ro: BetterGenshinImpact.Core.Recognition.RecognitionObject,
+        successAction:
+          | ((
+              regions: System.Collections.Generic.List<BetterGenshinImpact.GameTask.Model.Area.Region>
+            ) => void)
+          | null
+      ): System.Collections.Generic.List<BetterGenshinImpact.GameTask.Model.Area.Region>;
+      findMulti(
         ro: BetterGenshinImpact.Core.Recognition.RecognitionObject,
-        successAction?: (
-          regions: System.Collections.Generic.List<BetterGenshinImpact.GameTask.Model.Area.Region>
-        ) => void,
-        failAction?: () => void
-      ) => System.Collections.Generic.List<BetterGenshinImpact.GameTask.Model.Area.Region>;
+        successAction:
+          | ((
+              regions: System.Collections.Generic.List<BetterGenshinImpact.GameTask.Model.Area.Region>
+            ) => void)
+          | null,
+        failAction: (() => void) | null
+      ): System.Collections.Generic.List<BetterGenshinImpact.GameTask.Model.Area.Region>;
 
+      constructor(mat: Mat, x: number, y: number);
+      constructor(
+        mat: Mat,
+        x: number,
+        y: number,
+        owner: BetterGenshinImpact.GameTask.Model.Area.Region | null
+      );
+      // overload
+      constructor(
+        mat: Mat,
+        x: number,
+        y: number,
+        owner: BetterGenshinImpact.GameTask.Model.Area.Region | null,
+        converter: BetterGenshinImpact.GameTask.Model.Area.Converter.INodeConverter | null
+      );
       constructor(
         mat: Mat,
         x: number,
         y: number,
-        owner?: BetterGenshinImpact.GameTask.Model.Area.Region,
-        converter?: BetterGenshinImpact.GameTask.Model.Area.Converter.INodeConverter,
-        drawContent?: BetterGenshinImpact.View.Drawable.DrawContent
+        owner: BetterGenshinImpact.GameTask.Model.Area.Region | null,
+        converter: BetterGenshinImpact.GameTask.Model.Area.Converter.INodeConverter | null,
+        drawContent: BetterGenshinImpact.View.Drawable.DrawContent | null
       );
     }
   }

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

@@ -66,62 +66,96 @@ declare global {
       moveTo(x: number, y: number, w: number, h: number): void;
 
       /** 绘制当前区域 */
-      drawSelf(name: string, pen?: System.Drawing.Pen): void;
+      drawSelf(name: string): void;
+      // overload
+      drawSelf(name: string, pen: System.Drawing.Pen | null): void;
 
       /** 绘制矩形区域 */
+      drawRect(x: number, y: number, w: number, h: number, name: string): void;
+      // overload
       drawRect(
         x: number,
         y: number,
         w: number,
         h: number,
         name: string,
-        pen?: System.Drawing.Pen
+        pen: System.Drawing.Pen | null
       ): void;
 
       /** 绘制矩形区域 */
-      drawRect(rect: Rect, name: string, pen?: System.Drawing.Pen): void;
+      drawRect(rect: Rect, name: string): void;
+      // overload
+      drawRect(rect: Rect, name: string, pen: System.Drawing.Pen | null): void;
 
       /** 将 [当前区域] 转换成 [遮罩窗口绘制矩形] */
+      selfToRectDrawable(name: string): BetterGenshinImpact.View.Drawable.RectDrawable;
+      // overload
       selfToRectDrawable(
         name: string,
-        pen?: System.Drawing.Pen
+        pen: System.Drawing.Pen | null
       ): BetterGenshinImpact.View.Drawable.RectDrawable;
 
       /** 将 [区域] 转换成 [遮罩窗口绘制矩形] */
+      toRectDrawable(rect: Rect, name: string): BetterGenshinImpact.View.Drawable.RectDrawable;
+      // overload
       toRectDrawable(
         rect: Rect,
         name: string,
-        pen?: System.Drawing.Pen
+        pen: System.Drawing.Pen | null
       ): BetterGenshinImpact.View.Drawable.RectDrawable;
 
       /** 将 [区域] 转换成 [遮罩窗口绘制矩形] */
+      toRectDrawable(
+        x: number,
+        y: number,
+        w: number,
+        h: number,
+        name: string
+      ): BetterGenshinImpact.View.Drawable.RectDrawable;
+      // overload
       toRectDrawable(
         x: number,
         y: number,
         w: number,
         h: number,
         name: string,
-        pen?: System.Drawing.Pen
+        pen: System.Drawing.Pen | null
       ): BetterGenshinImpact.View.Drawable.RectDrawable;
 
       /** 将 [直线] 转换成 [遮罩窗口绘制直线] */
+      toLineDrawable(
+        x1: number,
+        y1: number,
+        x2: number,
+        y2: number,
+        name: string
+      ): BetterGenshinImpact.View.Drawable.LineDrawable;
+      // overload
       toLineDrawable(
         x1: number,
         y1: number,
         x2: number,
         y2: number,
         name: string,
-        pen?: System.Drawing.Pen
+        pen: System.Drawing.Pen | null
       ): BetterGenshinImpact.View.Drawable.LineDrawable;
 
       /** 绘制直线 */
+      drawLine(
+        x1: number,
+        y1: number,
+        x2: number,
+        y2: number,
+        name: string
+      ): BetterGenshinImpact.View.Drawable.LineDrawable;
+      // overload
       drawLine(
         x1: number,
         y1: number,
         x2: number,
         y2: number,
         name: string,
-        pen?: System.Drawing.Pen
+        pen: System.Drawing.Pen | null
       ): BetterGenshinImpact.View.Drawable.LineDrawable;
 
       /** 将当前区域的截图转换成矩形类型的区域 */
@@ -177,13 +211,22 @@ declare global {
 
       constructor();
 
+      constructor(x: number, y: number, width: number, height: number);
+      // overload
+      constructor(
+        x: number,
+        y: number,
+        width: number,
+        height: number,
+        owner: BetterGenshinImpact.GameTask.Model.Area.Region | null
+      );
       constructor(
         x: number,
         y: number,
         width: number,
         height: number,
-        owner?: BetterGenshinImpact.GameTask.Model.Area.Region,
-        converter?: BetterGenshinImpact.GameTask.Model.Area.Converter.INodeConverter
+        owner: BetterGenshinImpact.GameTask.Model.Area.Region | null,
+        converter: BetterGenshinImpact.GameTask.Model.Area.Converter.INodeConverter | null
       );
     }
   }

package/csharp/BetterGenshinImpact/View/Drawable/RectDrawable.d.ts

@@ -16,9 +16,11 @@ declare global {
       /** 区域面积是否为空 */
       isEmpty: boolean;
 
-      constructor(rect: Rect, pen?: System.Drawing.Pen, name?: string);
-
-      constructor(rect: Rect, name?: string);
+      constructor(rect: Rect);
+      // overload
+      constructor(rect: Rect, name: string | null);
+      constructor(rect: Rect, pen: System.Drawing.Pen | null);
+      constructor(rect: Rect, pen: System.Drawing.Pen | null, name: string | null);
     }
   }
 }

package/csharp/System/Collections/Generic/List.d.ts

@@ -25,14 +25,18 @@ declare global {
       asReadOnly(): System.Collections.Generic.IReadOnlyList<T>;
 
       /** @deprecated Not yet supported  */
-      binarySearch(item: T, comparer?: (a: T, b: T) => number): number;
+      binarySearch(item: T): number;
+      // overload
+      binarySearch(item: T, comparer: ((a: T, b: T) => number) | null): number;
 
       /** @deprecated Not yet supported  */
+      binarySearch(index: number, count: number, item: T): number;
+      // overload
       binarySearch(
         index: number,
         count: number,
         item: T,
-        comparer?: (a: T, b: T) => number
+        comparer: ((a: T, b: T) => number) | null
       ): number;
 
       clear(): void;

package/modules/dispatcher.d.ts

@@ -45,9 +45,13 @@ declare global {
      * @param soloTask 独立任务
      * @since 0.45.1
      */
+    function runTask(
+      soloTask: BetterGenshinImpact.Core.Script.Dependence.Model.SoloTask
+    ): Promise<void>;
+    // overload
     function runTask(
       soloTask: BetterGenshinImpact.Core.Script.Dependence.Model.SoloTask,
-      customCt?: System.Threading.CancellationToken
+      customCt: System.Threading.CancellationToken | null
     ): Promise<void>;
 
     /**
@@ -67,9 +71,13 @@ declare global {
      * @param param 秘境任务参数
      * @since 0.52.0
      */
+    function runAutoDomainTask(
+      param: BetterGenshinImpact.GameTask.AutoDomain.AutoDomainParam
+    ): Promise<void>;
+    // overload
     function runAutoDomainTask(
       param: BetterGenshinImpact.GameTask.AutoDomain.AutoDomainParam,
-      customCt?: System.Threading.CancellationToken
+      customCt: System.Threading.CancellationToken | null
     ): Promise<void>;
 
     /**
@@ -77,9 +85,13 @@ declare global {
      * @param param 战斗任务参数
      * @since 0.52.0
      */
+    function runAutoFightTask(
+      param: BetterGenshinImpact.GameTask.AutoFight.AutoFightParam
+    ): Promise<void>;
+    // overload
     function runAutoFightTask(
       param: BetterGenshinImpact.GameTask.AutoFight.AutoFightParam,
-      customCt?: System.Threading.CancellationToken
+      customCt: System.Threading.CancellationToken | null
     ): Promise<void>;
   }
 }

package/modules/genshin.d.ts

@@ -79,7 +79,9 @@ declare global {
      * @param forceCountry 强制指定移动大地图时先切换的国家（默认值：无）
      * @since 0.44.2
      */
-    function moveMapTo(x: number, y: number, forceCountry?: Area): Promise<void>;
+    function moveMapTo(x: number, y: number): Promise<void>;
+    // overload
+    function moveMapTo(x: number, y: number, forceCountry: Area | null): Promise<void>;
 
     /**
      * 移动[指定大地图]到指定坐标
@@ -89,11 +91,13 @@ declare global {
      * @param forceCountry 强制指定移动大地图时先切换的国家（默认值：无）
      * @since 0.44.9
      */
+    function moveIndependentMapTo(x: number, y: number, mapName: BigMap): Promise<void>;
+    // overload
     function moveIndependentMapTo(
       x: number,
       y: number,
       mapName: BigMap,
-      forceCountry?: Area
+      forceCountry: Area | null
     ): Promise<void>;
 
     /**
@@ -142,7 +146,9 @@ declare global {
      * @param cacheTimeMs 缓存时间（毫秒，默认值：900）
      * @since 0.44.9
      */
-    function getPositionFromMap(mapName: BigMap, cacheTimeMs?: number): Point2f;
+    function getPositionFromMap(mapName: BigMap): Point2f;
+    // overload
+    function getPositionFromMap(mapName: BigMap, cacheTimeMs: number | null): Point2f;
 
     /**
      * 获取当前在小地图上的 [指定大地图] 位置坐标（仅在给定坐标附近匹配）
@@ -179,10 +185,13 @@ declare global {
      * @param isOrange 是否为橙色选项（默认值：false）
      * @since 0.37.4
      */
+    function chooseTalkOption(option: string): Promise<void>;
+    // overload
+    function chooseTalkOption(option: string, skipTimes: number | null): Promise<void>;
     function chooseTalkOption(
       option: string,
-      skipTimes?: number,
-      isOrange?: boolean
+      skipTimes: number | null,
+      isOrange: boolean | null
     ): Promise<void>;
 
     /**

package/modules/globalMethod.d.ts

@@ -37,7 +37,9 @@ declare global {
    * @param dpi - DPI（默认值：1）
    * @since 0.34.5
    */
-  function setGameMetrics(w: number, h: number, dpi?: number): void;
+  function setGameMetrics(w: number, h: number): void;
+  // overload
+  function setGameMetrics(w: number, h: number, dpi: number | null): void;
 
   /**
    * 相对当前鼠标位置移动光标

package/modules/http.d.ts

@@ -9,11 +9,14 @@ declare global {
      * @param headersJson 请求头（可选）
      * @since 0.52.0
      */
+    function request(method: HttpMethod, url: string): Promise<HttpReponse>;
+    // overload
+    function request(method: HttpMethod, url: string, body: string | null): Promise<HttpReponse>;
     function request(
       method: HttpMethod,
       url: string,
-      body?: string,
-      headersJson?: string
+      body: string | null,
+      headersJson: string | null
     ): Promise<HttpReponse>;
   }
 }

package/modules/log.d.ts

@@ -7,7 +7,7 @@ declare global {
      * @param args 占位参数
      * @since 0.32.0
      */
-    function debug(message?: string, ...args: any[]): void;
+    function debug(message: string, ...args: any[]): void;
 
     /**
      * 输出提示信息
@@ -15,7 +15,7 @@ declare global {
      * @param args 占位参数
      * @since 0.32.0
      */
-    function info(message?: string, ...args: any[]): void;
+    function info(message: string, ...args: any[]): void;
 
     /**
      * 输出警告信息
@@ -23,7 +23,7 @@ declare global {
      * @param args 占位参数
      * @since 0.32.0
      */
-    function warn(message?: string, ...args: any[]): void;
+    function warn(message: string, ...args: any[]): void;
 
     /**
      * 输出错误信息
@@ -31,7 +31,7 @@ declare global {
      * @param args 占位参数
      * @since 0.32.0
      */
-    function error(message?: string, ...args: any[]): void;
+    function error(message: string, ...args: any[]): void;
   }
 }
 

package/package.json

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