@bettergi/types 0.1.15 → 0.1.17

package/types/BetterGenshinImpact/GameTask/CharacterDevelopment/CharacterDevelopmentTask.d.ts

@@ -0,0 +1,158 @@
+import type {
+  ClrHostValue,
+  HostType,
+  PublicDefaultConstructorTrait,
+  ReferenceTypeTrait
+} from "../../../Microsoft/ClearScript/HostType";
+import "../../../System/Collections/Generic/IEnumerable";
+import "../../../System/Collections/Generic/List";
+import type { AvatarName } from "../AutoFight/Model/Avatar";
+
+/**
+ * 角色元素类型
+ * 来源：上游 `Assets/Model/AvatarGridIcon/avatar.csv` 的 `element_type`
+ * @since 0.63.0
+ */
+export type CharacterElementType = "火" | "水" | "雷" | "冰" | "风" | "岩" | "草" | (string & {});
+
+/**
+ * 单个角色的养成信息识别结果；未请求或未识别的字段为 null
+ * @since 0.63.0
+ */
+declare const characterDevelopmentResultBrand: unique symbol;
+export interface CharacterDevelopmentResult extends ClrHostValue {
+  readonly [characterDevelopmentResultBrand]: true;
+  /**
+   * 调用方传入并规范化后的角色名称
+   * @since 0.63.0
+   */
+  characterName: AvatarName;
+  /**
+   * 角色元素类型；旅行者和奇偶由模型识别，其余角色来自头像原型表
+   * @since 0.63.0
+   */
+  elementType: CharacterElementType | null;
+  /**
+   * 角色当前等级
+   * @since 0.63.0
+   */
+  level: number | null;
+  /**
+   * 角色当前等级上限
+   * @since 0.63.0
+   */
+  levelLimit: number | null;
+  /**
+   * 经物品原型表编辑距离纠错后的标准武器名称
+   * @since 0.63.0
+   */
+  weaponName: string | null;
+  /**
+   * 武器当前等级
+   * @since 0.63.0
+   */
+  weaponLevel: number | null;
+  /**
+   * 武器当前等级上限
+   * @since 0.63.0
+   */
+  weaponLevelLimit: number | null;
+  /**
+   * 普通攻击的界面显示等级
+   * @since 0.63.0
+   */
+  attackLevel: number | null;
+  /**
+   * 普通攻击是否显示命座带来的固定等级加成
+   * @since 0.63.0
+   */
+  attackHasBonus: boolean | null;
+  /**
+   * 元素战技的界面显示等级
+   * @since 0.63.0
+   */
+  skillLevel: number | null;
+  /**
+   * 元素战技是否显示命座带来的固定等级加成
+   * @since 0.63.0
+   */
+  skillHasBonus: boolean | null;
+  /**
+   * 元素爆发的界面显示等级
+   * @since 0.63.0
+   */
+  burstLevel: number | null;
+  /**
+   * 元素爆发是否显示命座带来的固定等级加成
+   * @since 0.63.0
+   */
+  burstHasBonus: boolean | null;
+}
+
+/**
+ * 角色养成信息识别任务入口
+ * @since 0.63.0
+ */
+declare const characterDevelopmentTaskBrand: unique symbol;
+export interface CharacterDevelopmentTask extends ClrHostValue {
+  readonly [characterDevelopmentTaskBrand]: true;
+  /**
+   * 识别单个角色的养成信息
+   * @param characterName 目标角色名称或已有别名
+   * @param categories 以分号分隔的 `属性`、`武器`、`天赋` 分类，null 表示全部
+   * @returns 在任务完成后兑现识别结果的 Promise
+   * @since 0.63.0
+   */
+  getCharacter(characterName: AvatarName): Promise<CharacterDevelopmentResult>;
+  getCharacter(
+    characterName: AvatarName,
+    categories: string | null
+  ): Promise<CharacterDevelopmentResult>;
+  /**
+   * 识别多个角色的养成信息
+   * @param characterNames 字符串集合或 ClearScript JS Array；不得为空或传入单个字符串
+   * @param categories 以分号分隔的 `属性`、`武器`、`天赋` 分类，null 表示全部
+   * @returns 在任务完成后兑现识别结果列表的 Promise
+   * @since 0.63.0
+   */
+  getMultiCharacters(
+    characterNames: readonly AvatarName[] | System.Collections.Generic.IEnumerableInput<AvatarName>
+  ): Promise<System.Collections.Generic.List<CharacterDevelopmentResult>>;
+  getMultiCharacters(
+    characterNames: readonly AvatarName[] | System.Collections.Generic.IEnumerableInput<AvatarName>,
+    categories: string | null
+  ): Promise<System.Collections.Generic.List<CharacterDevelopmentResult>>;
+}
+
+declare global {
+  namespace BetterGenshinImpact.GameTask.CharacterDevelopment {
+    type CharacterElementType = import("./CharacterDevelopmentTask").CharacterElementType;
+    type CharacterDevelopmentResult =
+      import("./CharacterDevelopmentTask").CharacterDevelopmentResult;
+    type CharacterDevelopmentTask = import("./CharacterDevelopmentTask").CharacterDevelopmentTask;
+  }
+}
+
+export interface CharacterDevelopmentResultHostType extends HostType<
+  CharacterDevelopmentResult,
+  ReferenceTypeTrait & PublicDefaultConstructorTrait
+> {
+  /**
+   * 构造空识别结果
+   * @since 0.63.0
+   */
+  new (): CharacterDevelopmentResult;
+}
+
+export interface CharacterDevelopmentTaskHostType extends HostType<
+  CharacterDevelopmentTask,
+  ReferenceTypeTrait & PublicDefaultConstructorTrait
+> {
+  /**
+   * 构造角色养成信息识别任务
+   * @since 0.63.0
+   */
+  new (): CharacterDevelopmentTask;
+}
+
+export {};

package/types/BetterGenshinImpact/GameTask/Common/Job/CraftMaterialTask.d.ts

@@ -9,6 +9,22 @@ import type {
 import "../../../../System/Collections/Generic/List";
 import "../Reward/RewardItem";
 
+/**
+ * 合成台材料筛选类型
+ * 来源：`Assets/Model/ItemV2/item.csv` 的 `material_type` 去重集合
+ * @since 0.62.0
+ */
+export type CraftMaterialType =
+  | "武器突破素材"
+  | "消耗品"
+  | "药剂"
+  | "角色与武器培养素材"
+  | "角色天赋素材"
+  | "角色突破素材"
+  | "食物"
+  | "鱼饵"
+  | (string & {});
+
 /**
  * 合成指定材料的执行结果
  * @since 0.62.0
@@ -40,7 +56,7 @@ export interface CraftMaterialResult extends ClrHostValue {
    * 本次使用的材料筛选类型
    * @since 0.62.0
    */
-  materialType: string;
+  materialType: CraftMaterialType;
   /**
    * 本次合成产物汇总
    * @since 0.62.0
@@ -51,6 +67,7 @@ export interface CraftMaterialResult extends ClrHostValue {
 declare global {
   namespace BetterGenshinImpact.GameTask.Common.Job {
     type CraftMaterialResult = import("./CraftMaterialTask").CraftMaterialResult;
+    type CraftMaterialType = import("./CraftMaterialTask").CraftMaterialType;
   }
 }
 
@@ -77,7 +94,7 @@ export interface CraftMaterialResultHostType extends HostType<
     materialName: string,
     targetQuantity: number | StrongNumeric<Int32Host>,
     actualQuantity: number | StrongNumeric<Int32Host>,
-    materialType: string,
+    materialType: CraftMaterialType,
     rewards: System.Collections.Generic.List<BetterGenshinImpact.GameTask.Common.Reward.RewardItem>
   ): BetterGenshinImpact.GameTask.Common.Job.CraftMaterialResult;
 }

package/types/BetterGenshinImpact/GameTask/Common/Map/MapScriptNames.d.ts

@@ -43,4 +43,13 @@ export type MapMatchMethod =
   | "SIFT" // SIFT 特征匹配
   | (string & {});
 
+declare global {
+  namespace BetterGenshinImpact.GameTask.Common.Map {
+    type Area = import("./MapScriptNames").Area;
+    type CountryName = import("./MapScriptNames").CountryName;
+    type MapMatchMethod = import("./MapScriptNames").MapMatchMethod;
+    type MapName = import("./MapScriptNames").MapName;
+  }
+}
+
 export {};

package/types/BetterGenshinImpact/GameTask/Model/Area/GameCaptureRegion.d.ts

@@ -9,7 +9,6 @@ import type { VoidResult } from "../../../../Microsoft/ClearScript/VoidResult";
 import "../../../../OpenCvSharp/Mat";
 import "../../../../OpenCvSharp/Size";
 import "../../../../System/Drawing/Pen";
-import "../../../../System/Func";
 import "../../../../System/IDisposable";
 import "../../../../System/ValueTuple";
 import "../../../View/Drawable/DrawContent";
@@ -146,30 +145,30 @@ export interface GameCaptureRegionHostType extends HostType<GameCaptureRegion, R
   ): GameCaptureRegion;
   /**
    * 在游戏截图坐标系点击；回调参数为当前捕获尺寸与到 1080P 的缩放比，魔法数字须按 1080P 编写
-   * @param posFunc 根据捕获尺寸与 1080P 缩放比计算点击坐标的回调
+   * @param posFunc 根据捕获尺寸与 1080P 缩放比计算点击坐标的脚本回调，返回坐标 ValueTuple 宿主对象
    * @returns ClearScript 宿主空结果
    * @since 0.43.1
    */
   gameRegionClick(
-    posFunc: System.Func<OpenCvSharp.Size, number, System.ValueTuple<number, number>>
+    posFunc: (size: OpenCvSharp.Size, scale: number) => System.ValueTuple<number, number>
   ): VoidResult;
   /**
    * 在游戏截图坐标系移动鼠标；回调参数为当前捕获尺寸与到 1080P 的缩放比
-   * @param posFunc 根据捕获尺寸与 1080P 缩放比计算目标坐标的回调
+   * @param posFunc 根据捕获尺寸与 1080P 缩放比计算目标坐标的脚本回调，返回坐标 ValueTuple 宿主对象
    * @returns ClearScript 宿主空结果
    * @since 0.43.1
    */
   gameRegionMove(
-    posFunc: System.Func<OpenCvSharp.Size, number, System.ValueTuple<number, number>>
+    posFunc: (size: OpenCvSharp.Size, scale: number) => System.ValueTuple<number, number>
   ): VoidResult;
   /**
    * 在游戏截图坐标系按偏移移动鼠标；回调参数为当前捕获尺寸与到 1080P 的缩放比
-   * @param deltaFunc 根据捕获尺寸与 1080P 缩放比计算偏移量的回调
+   * @param deltaFunc 根据捕获尺寸与 1080P 缩放比计算偏移量的脚本回调，返回偏移 ValueTuple 宿主对象
    * @returns ClearScript 宿主空结果
    * @since 0.43.1
    */
   gameRegionMoveBy(
-    deltaFunc: System.Func<OpenCvSharp.Size, number, System.ValueTuple<number, number>>
+    deltaFunc: (size: OpenCvSharp.Size, scale: number) => System.ValueTuple<number, number>
   ): VoidResult;
   /**
    * 按 1080P 坐标点击，自动换算到当前捕获分辨率

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

@@ -10,7 +10,6 @@ import "../../../../OpenCvSharp/Mat";
 import "../../../../OpenCvSharp/Rect";
 import "../../../../SixLabors/ImageSharp/Image";
 import "../../../../SixLabors/ImageSharp/PixelFormats/Rgb24";
-import "../../../../System/Action";
 import "../../../../System/Collections/Generic/List";
 import "../../../../System/IDisposable";
 import "../../../Core/Recognition/RecognitionObject";
@@ -83,8 +82,8 @@ export interface ImageRegion
   /**
    * 在本区域内查找最优识别结果；支持模板匹配、OCR 匹配与 OCR 识别
    * @param ro 识别对象
-   * @param successAction 找到时的回调
-   * @param failAction 未找到时的回调
+   * @param successAction 找到时的脚本回调
+   * @param failAction 未找到时的脚本回调
    * @returns 最优识别区域；未找到时为空区域
    * @since 0.43.1
    */
@@ -93,18 +92,18 @@ export interface ImageRegion
   ): BetterGenshinImpact.GameTask.Model.Area.Region;
   find(
     ro: BetterGenshinImpact.Core.Recognition.RecognitionObject,
-    successAction: System.Action<BetterGenshinImpact.GameTask.Model.Area.Region> | null
+    successAction: ((region: BetterGenshinImpact.GameTask.Model.Area.Region) => void) | null
   ): BetterGenshinImpact.GameTask.Model.Area.Region;
   find(
     ro: BetterGenshinImpact.Core.Recognition.RecognitionObject,
-    successAction: System.Action<BetterGenshinImpact.GameTask.Model.Area.Region> | null,
-    failAction: System.Action | null
+    successAction: ((region: BetterGenshinImpact.GameTask.Model.Area.Region) => void) | null,
+    failAction: (() => void) | null
   ): BetterGenshinImpact.GameTask.Model.Area.Region;
   /**
    * 在本区域内查找全部识别结果；仅支持模板匹配与 OCR
    * @param ro 识别对象
-   * @param successAction 找到时的回调
-   * @param failAction 未找到时的回调
+   * @param successAction 找到时的脚本回调
+   * @param failAction 未找到时的脚本回调
    * @returns 识别区域列表，不含内嵌图像
    * @since 0.43.1
    */
@@ -113,16 +112,20 @@ export interface ImageRegion
   ): System.Collections.Generic.List<BetterGenshinImpact.GameTask.Model.Area.Region>;
   findMulti(
     ro: BetterGenshinImpact.Core.Recognition.RecognitionObject,
-    successAction: System.Action<
-      System.Collections.Generic.List<BetterGenshinImpact.GameTask.Model.Area.Region>
-    > | null
+    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: System.Action<
-      System.Collections.Generic.List<BetterGenshinImpact.GameTask.Model.Area.Region>
-    > | null,
-    failAction: System.Action | null
+    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>;
   /**
    * 释放资源

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

@@ -70,6 +70,11 @@ export interface Region extends ClrHostValue, System.IDisposableInput {
    * @since 0.43.1
    */
   text: string;
+  /**
+   * 模板匹配得分，值越大表示匹配程度越高；非模板匹配结果为 null
+   * @since 0.63.0
+   */
+  matchScore: number | null;
   /**
    * 上一层区域节点
    * @since 0.43.1

package/types/BetterGenshinImpact/GameTask/Model/GameUI/GridScreenName.d.ts

@@ -87,7 +87,7 @@ export interface GridScreenNameHostType extends HostType<GridScreenName, EnumTyp
   readonly crafting: GridScreenName;
   /**
    * 队伍配置快速编队界面的左侧角色头像网格
-   * @since unreleased
+   * @since 0.63.0
    */
   readonly partySetupCharacters: GridScreenName;
 }

package/types/BetterGenshinImpact/Helpers/User32Helper.d.ts

@@ -223,4 +223,11 @@ export type Key =
 export type KeyCode =
   Uppercase<Key> | Lowercase<Key> | Uppercase<`VK_${Key}`> | Lowercase<`VK_${Key}`> | (string & {});
 
+declare global {
+  namespace BetterGenshinImpact.Helpers {
+    type Key = import("./User32Helper").Key;
+    type KeyCode = import("./User32Helper").KeyCode;
+  }
+}
+
 export {};