@bettergi/types 0.1.15 → 0.1.16

package/types/BetterGenshinImpact/GameTask/AutoFight/AutoFightConfig.d.ts

@@ -17,6 +17,28 @@ export type OnlyPickEliteDropsMode =
   | "DisableAutoPickupForNonElite" // 非精英关闭自动拾取
   | (string & {});
 
+/**
+ * 战斗策略名称；`根据队伍自动选择` 表示按当前队伍匹配策略目录，其余为 `User/AutoFight` 下策略文件名（不含扩展名）
+ * @since 0.52.0
+ */
+export type CombatStrategyName = "根据队伍自动选择" | (string & {});
+
+/**
+ * 战斗策略文件种类标识
+ * 与上游 `AutoFightParam.ResolveStrategyPath` 返回的第二项对齐：优先命中 `.json`，否则回退 `.txt`；自动选队目录亦标为 `txt`
+ * @since 0.52.0
+ */
+export type StrategyFileKind =
+  | "json" // JSON 战斗策略
+  | "txt" // 文本 / 简易策略（含「根据队伍自动选择」目录）
+  | (string & {});
+
+/**
+ * 队伍内角色槽位序号（字符串），从 1 开始；空字符串表示不指定
+ * @since 0.52.0
+ */
+export type PartySlotIndex = "1" | "2" | "3" | "4" | "" | (string & {});
+
 /**
  * 自动战斗配置
  * @since 0.52.0
@@ -89,7 +111,7 @@ export interface AutoFightConfig
    * 盾奶位角色队伍序号，从 1 开始，空字符串表示不指定
    * @since 0.52.0
    */
-  guardianAvatar: string;
+  guardianAvatar: PartySlotIndex;
   /**
    * 是否跳过盾奶位自身的战斗策略脚本
    * @since 0.52.0
@@ -134,7 +156,7 @@ export interface AutoFightConfig
    * 战斗策略名称，`根据队伍自动选择` 表示按当前队伍匹配策略
    * @since 0.52.0
    */
-  strategyName: string;
+  strategyName: CombatStrategyName;
   /**
    * 是否启用游泳脱困检测
    * @since 0.52.0
@@ -248,6 +270,10 @@ declare global {
 declare global {
   namespace BetterGenshinImpact.GameTask.AutoFight {
     type AutoFightConfig = import("./AutoFightConfig").AutoFightConfig;
+    type CombatStrategyName = import("./AutoFightConfig").CombatStrategyName;
+    type OnlyPickEliteDropsMode = import("./AutoFightConfig").OnlyPickEliteDropsMode;
+    type PartySlotIndex = import("./AutoFightConfig").PartySlotIndex;
+    type StrategyFileKind = import("./AutoFightConfig").StrategyFileKind;
   }
 }
 

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

@@ -8,7 +8,12 @@ import type { VoidResult } from "../../../Microsoft/ClearScript/VoidResult";
 import "../../../System/ValueTuple";
 import "../Model/BaseTaskParam";
 import "./AutoFightConfig";
-import type { OnlyPickEliteDropsMode } from "./AutoFightConfig";
+import type {
+  CombatStrategyName,
+  OnlyPickEliteDropsMode,
+  PartySlotIndex,
+  StrategyFileKind
+} from "./AutoFightConfig";
 import "./AutoFightTask";
 
 /**
@@ -101,7 +106,7 @@ export interface AutoFightParam extends Omit<
    * 盾奶位角色队伍序号，从 1 开始，空字符串表示不指定
    * @since 0.52.0
    */
-  guardianAvatar: string;
+  guardianAvatar: PartySlotIndex;
   /**
    * 是否跳过盾奶位自身的战斗策略脚本
    * @since 0.52.0
@@ -149,7 +154,7 @@ export interface AutoFightParam extends Omit<
    * @since 0.52.0
    */
   setCombatStrategyPath(): VoidResult;
-  setCombatStrategyPath(strategyName: string | null): VoidResult;
+  setCombatStrategyPath(strategyName: CombatStrategyName | null): VoidResult;
   /**
    * 从当前全局自动战斗配置填充默认参数
    * @returns ClearScript 宿主空结果
@@ -243,7 +248,7 @@ export interface AutoFightParamHostType extends HostType<AutoFightParam, Referen
    * @since 0.52.0
    */
   new (): AutoFightParam;
-  new (strategyName: string | null): AutoFightParam;
+  new (strategyName: CombatStrategyName | null): AutoFightParam;
   /**
    * 是否启用游泳脱困检测
    * @since 0.52.0
@@ -252,10 +257,12 @@ export interface AutoFightParamHostType extends HostType<AutoFightParam, Referen
   /**
    * 解析策略文件路径，优先检测 `.json`，未命中则回退 `.txt`
    * @param strategyName 策略名称（不含扩展名）
-   * @returns 完整路径与类型标识组成的元组，类型为 `json` 或 `txt`
+   * @returns 完整路径与策略文件种类组成的元组
    * @since 0.52.0
    */
-  resolveStrategyPath(strategyName: string): System.ValueTuple<string, string>;
+  resolveStrategyPath(
+    strategyName: CombatStrategyName
+  ): System.ValueTuple<string, StrategyFileKind>;
   readonly FightFinishDetectConfig: AutoFightParam_FightFinishDetectConfigHostType;
 }
 

package/types/BetterGenshinImpact/GameTask/AutoFight/Config/CombatAvatar.d.ts

@@ -5,6 +5,152 @@ import type {
   ReferenceTypeTrait
 } from "../../../../Microsoft/ClearScript/HostType";
 import "../../../../System/Collections/Generic/List";
+import type { AvatarName } from "../Model/Avatar";
+
+/**
+ * 战斗角色武器类型编码（`combat_avatar.json` 的 `weapon` 字段）
+ * @since 0.50.0
+ */
+export type CombatAvatarWeaponCode =
+  | "0" // 未知 / 占位
+  | "1" // 单手剑
+  | "10" // 法器
+  | "11" // 双手剑
+  | "12" // 弓
+  | "13" // 长柄武器
+  | (string & {});
+
+/**
+ * 战斗角色英文名（`combat_avatar.json` 的 `nameEn`）
+ * 与 `AvatarName` 一一对应、顺序对齐；配置标准英文名，不是 YOLO 侧面头像 class（分类结果可能含 `Costume` 后缀）
+ * @since 0.50.0
+ */
+export type CombatAvatarNameEn =
+  | "Unknown"
+  | "Ayaka"
+  | "Qin"
+  | "Traveler"
+  | "PlayerGirl"
+  | "PlayerBoy"
+  | "Lisa"
+  | "Barbara"
+  | "Kaeya"
+  | "Diluc"
+  | "Razor"
+  | "Ambor"
+  | "Venti"
+  | "Xiangling"
+  | "Beidou"
+  | "Xingqiu"
+  | "Xiao"
+  | "Ningguang"
+  | "Klee"
+  | "Zhongli"
+  | "Fischl"
+  | "Bennett"
+  | "Tartaglia"
+  | "Noel"
+  | "Qiqi"
+  | "Chongyun"
+  | "Ganyu"
+  | "Albedo"
+  | "Diona"
+  | "Mona"
+  | "Keqing"
+  | "Sucrose"
+  | "Xinyan"
+  | "Rosaria"
+  | "Hutao"
+  | "Kazuha"
+  | "Feiyan"
+  | "Yoimiya"
+  | "Tohma"
+  | "Eula"
+  | "Shougun"
+  | "Sayu"
+  | "Kokomi"
+  | "Gorou"
+  | "Sara"
+  | "Itto"
+  | "Yae"
+  | "Heizo"
+  | "Yelan"
+  | "Momoka"
+  | "Aloy"
+  | "Shenhe"
+  | "Yunjin"
+  | "Shinobu"
+  | "Ayato"
+  | "Collei"
+  | "Dori"
+  | "Tighnari"
+  | "Nilou"
+  | "Cyno"
+  | "Candace"
+  | "Nahida"
+  | "Layla"
+  | "Wanderer"
+  | "Faruzan"
+  | "Yaoyao"
+  | "Alhatham"
+  | "Dehya"
+  | "Mika"
+  | "Kaveh"
+  | "Baizhuer"
+  | "Linette"
+  | "Liney"
+  | "Freminet"
+  | "Wriothesley"
+  | "Neuvillette"
+  | "Charlotte"
+  | "Furina"
+  | "Chevreuse"
+  | "Navia"
+  | "Gaming"
+  | "Liuyun"
+  | "Chiori"
+  | "Sigewinne"
+  | "Arlecchino"
+  | "Sethos"
+  | "Clorinde"
+  | "Emilie"
+  | "Kachina"
+  | "Kinich"
+  | "Mualani"
+  | "Xilonen"
+  | "Chasca"
+  | "Olorun"
+  | "Mavuika"
+  | "Citlali"
+  | "Lanyan"
+  | "Mizuki"
+  | "Iansan"
+  | "Varesa"
+  | "Escoffier"
+  | "Ifa"
+  | "SkirkNew"
+  | "Dahlia"
+  | "Ineffa"
+  | "MannequinBoy"
+  | "MannequinGirl"
+  | "Lauma"
+  | "Flins"
+  | "Aino"
+  | "Nefer"
+  | "Durin"
+  | "Jahoda"
+  | "Columbina"
+  | "Zibai"
+  | "Illuga"
+  | "Varka"
+  | "Linnea"
+  | "Lohen"
+  | "Nicole"
+  | "Prune"
+  | "Marionette"
+  | "Alyosha"
+  | "Odette"
+  | (string & {});
 
 /**
  * 战斗角色静态配置
@@ -22,17 +168,17 @@ export interface CombatAvatar extends ClrHostValue {
    * 角色名称（中文）
    * @since 0.50.0
    */
-  name: string;
+  name: AvatarName;
   /**
-   * 角色英文名
+   * 角色英文名（配置标准名，非 YOLO class）
    * @since 0.50.0
    */
-  nameEn: string;
+  nameEn: CombatAvatarNameEn;
   /**
-   * 武器类型
+   * 武器类型编码（非中文武器名）
    * @since 0.50.0
    */
-  weapon: string;
+  weapon: CombatAvatarWeaponCode;
   /**
    * 元素战技冷却时长，单位秒
    * @since 0.50.0
@@ -58,6 +204,8 @@ export interface CombatAvatar extends ClrHostValue {
 declare global {
   namespace BetterGenshinImpact.GameTask.AutoFight.Config {
     type CombatAvatar = import("./CombatAvatar").CombatAvatar;
+    type CombatAvatarNameEn = import("./CombatAvatar").CombatAvatarNameEn;
+    type CombatAvatarWeaponCode = import("./CombatAvatar").CombatAvatarWeaponCode;
   }
 }
 

package/types/BetterGenshinImpact/GameTask/AutoFight/Model/Avatar.d.ts

@@ -19,11 +19,138 @@ import "../../Model/Area/ImageRegion";
 import "../Config/CombatAvatar";
 import "./CombatScenes";
 
+export type AvatarName =
+  | "未知角色"
+  | "神里绫华"
+  | "琴"
+  | "旅行者"
+  | "荧"
+  | "空"
+  | "丽莎"
+  | "芭芭拉"
+  | "凯亚"
+  | "迪卢克"
+  | "雷泽"
+  | "安柏"
+  | "温迪"
+  | "香菱"
+  | "北斗"
+  | "行秋"
+  | "魈"
+  | "凝光"
+  | "可莉"
+  | "钟离"
+  | "菲谢尔"
+  | "班尼特"
+  | "达达利亚"
+  | "诺艾尔"
+  | "七七"
+  | "重云"
+  | "甘雨"
+  | "阿贝多"
+  | "迪奥娜"
+  | "莫娜"
+  | "刻晴"
+  | "砂糖"
+  | "辛焱"
+  | "罗莎莉亚"
+  | "胡桃"
+  | "枫原万叶"
+  | "烟绯"
+  | "宵宫"
+  | "托马"
+  | "优菈"
+  | "雷电将军"
+  | "早柚"
+  | "珊瑚宫心海"
+  | "五郎"
+  | "九条裟罗"
+  | "荒泷一斗"
+  | "八重神子"
+  | "鹿野院平藏"
+  | "夜兰"
+  | "绮良良"
+  | "埃洛伊"
+  | "申鹤"
+  | "云堇"
+  | "久岐忍"
+  | "神里绫人"
+  | "柯莱"
+  | "多莉"
+  | "提纳里"
+  | "妮露"
+  | "赛诺"
+  | "坎蒂丝"
+  | "纳西妲"
+  | "莱依拉"
+  | "流浪者"
+  | "珐露珊"
+  | "瑶瑶"
+  | "艾尔海森"
+  | "迪希雅"
+  | "米卡"
+  | "卡维"
+  | "白术"
+  | "琳妮特"
+  | "林尼"
+  | "菲米尼"
+  | "莱欧斯利"
+  | "那维莱特"
+  | "夏洛蒂"
+  | "芙宁娜"
+  | "夏沃蕾"
+  | "娜维娅"
+  | "嘉明"
+  | "闲云"
+  | "千织"
+  | "希格雯"
+  | "阿蕾奇诺"
+  | "赛索斯"
+  | "克洛琳德"
+  | "艾梅莉埃"
+  | "卡齐娜"
+  | "基尼奇"
+  | "玛拉妮"
+  | "希诺宁"
+  | "恰斯卡"
+  | "欧洛伦"
+  | "玛薇卡"
+  | "茜特菈莉"
+  | "蓝砚"
+  | "梦见月瑞希"
+  | "伊安珊"
+  | "瓦雷莎"
+  | "爱可菲"
+  | "伊法"
+  | "丝柯克"
+  | "塔利雅"
+  | "伊涅芙"
+  | "奇偶(男)"
+  | "奇偶(女)"
+  | "菈乌玛"
+  | "菲林斯"
+  | "爱诺"
+  | "奈芙尔"
+  | "杜林"
+  | "雅珂达"
+  | "哥伦比娅"
+  | "兹白"
+  | "叶洛亚"
+  | "法尔伽"
+  | "莉奈娅"
+  | "洛恩"
+  | "尼可"
+  | "布伦妮"
+  | "桑多涅"
+  | "阿罗夏"
+  | "奥黛塔"
+  | (string & {});
+
 /**
  * 角色行走方向键
  * @since 0.50.0
  */
-type WalkKey =
+export type WalkKey =
   | "w" // 前
   | "s" // 后
   | "a" // 左
@@ -31,10 +158,10 @@ type WalkKey =
   | (string & {});
 
 /**
- * 角色模拟用鼠标按键
+ * 角色模拟用鼠标按键（小写；与 `KeyMouseHook.MouseButton` 的 PascalCase 不同）
  * @since 0.50.0
  */
-type MouseButtonName =
+export type MouseButtonName =
   | "left" // 左键
   | "right" // 右键
   | "middle" // 中键
@@ -56,7 +183,7 @@ export interface Avatar extends ClrHostValue {
    * 角色名称（中文）
    * @since 0.50.0
    */
-  name: string;
+  name: AvatarName;
   /**
    * 队伍内序号，从 1 开始
    * @since 0.50.0
@@ -303,6 +430,9 @@ export interface Avatar extends ClrHostValue {
 declare global {
   namespace BetterGenshinImpact.GameTask.AutoFight.Model {
     type Avatar = import("./Avatar").Avatar;
+    type AvatarName = import("./Avatar").AvatarName;
+    type MouseButtonName = import("./Avatar").MouseButtonName;
+    type WalkKey = import("./Avatar").WalkKey;
   }
 }
 
@@ -318,13 +448,13 @@ export interface AvatarHostType extends HostType<Avatar, ReferenceTypeTrait> {
    */
   new (
     combatScenes: BetterGenshinImpact.GameTask.AutoFight.Model.CombatScenes,
-    name: string,
+    name: AvatarName,
     index: number | StrongNumeric<Int32Host>,
     nameRect: OpenCvSharp.Rect
   ): Avatar;
   new (
     combatScenes: BetterGenshinImpact.GameTask.AutoFight.Model.CombatScenes,
-    name: string,
+    name: AvatarName,
     index: number | StrongNumeric<Int32Host>,
     nameRect: OpenCvSharp.Rect,
     manualSkillCd: number | StrongNumeric<DoubleHost>
@@ -355,7 +485,7 @@ export interface AvatarHostType extends HostType<Avatar, ReferenceTypeTrait> {
    * @returns 仅有角色名时返回 -1，未找到角色返回 null，否则返回冷却秒数
    * @since 0.50.0
    */
-  parseActionSchedulerByCd(avatarName: string, input: string): number | null;
+  parseActionSchedulerByCd(avatarName: AvatarName, input: string): number | null;
   /**
    * 识别屏幕上的血条位置列表
    * @param existingCapture 可选的已有截图区域，省略时重新截图

package/types/BetterGenshinImpact/GameTask/AutoFight/Model/CombatScenes.d.ts

@@ -20,7 +20,7 @@ import "../../Model/Area/ImageRegion";
 import "../../Model/ISystemInfo";
 import "../Assets/AutoFightAssets";
 import "../AutoFightConfig";
-import "./Avatar";
+import type { AvatarName } from "./Avatar";
 import "./AvatarActiveCheckContext";
 import "./MultiGameStatus";
 
@@ -104,12 +104,12 @@ export interface CombatScenes extends ClrHostValue, System.IDisposableInput {
   classifyAvatarCnName(
     img: SixLabors.ImageSharp.Image<SixLabors.ImageSharp.PixelFormats.Rgb24>,
     index: number | StrongNumeric<Int32Host>
-  ): System.ValueTuple<string, string>;
+  ): System.ValueTuple<AvatarName, string>;
   /**
    * 对角色头像图像进行名称分类
    * @param img 角色头像图像
    * @param index 队伍内序号，从 1 开始
-   * @returns 角色名称
+   * @returns YOLO 英文分类名（可含 `Costume` 后缀），不是中文角色名
    * @since 0.48.0
    */
   classifyAvatarName(
@@ -128,7 +128,7 @@ export interface CombatScenes extends ClrHostValue, System.IDisposableInput {
    * @returns 配置中有效的角色名列表
    * @since 0.48.0
    */
-  updateActionSchedulerByCd(cdConfig: string): System.Collections.Generic.List<string>;
+  updateActionSchedulerByCd(cdConfig: string): System.Collections.Generic.List<AvatarName>;
   /**
    * 在战斗任务开始前绑定取消令牌等运行时上下文
    * @param ct 取消令牌
@@ -154,29 +154,29 @@ export interface CombatScenes extends ClrHostValue, System.IDisposableInput {
   /**
    * 按角色名称选择角色
    * @param name 角色名称（中文）
-   * @returns 对应角色
+   * @returns 对应角色，未找到时为 null
    * @since 0.48.0
    */
-  selectAvatar(name: string): BetterGenshinImpact.GameTask.AutoFight.Model.Avatar;
+  selectAvatar(name: AvatarName): BetterGenshinImpact.GameTask.AutoFight.Model.Avatar | null;
   /**
    * 获取当前出战角色名，不刷新编号框位置，不推荐使用
    * @param force 是否强制重新识别
    * @param region 可选的图像区域
    * @param ct 取消令牌
-   * @returns 出战角色名称
+   * @returns 出战角色名称，未识别时为 null
    * @since 0.48.0
    */
-  currentAvatar(): string;
-  currentAvatar(force: boolean): string;
+  currentAvatar(): AvatarName | null;
+  currentAvatar(force: boolean): AvatarName | null;
   currentAvatar(
     force: boolean,
     region: BetterGenshinImpact.GameTask.Model.Area.ImageRegion | null
-  ): string;
+  ): AvatarName | null;
   currentAvatar(
     force: boolean,
     region: BetterGenshinImpact.GameTask.Model.Area.ImageRegion | null,
     ct: System.Threading.CancellationToken
-  ): string;
+  ): AvatarName | null;
   /**
    * 获取当前出战角色编号，失败后自动刷新编号框位置，推荐使用
    * @param imageRegion 完整游戏画面的图像区域
@@ -201,11 +201,11 @@ export interface CombatScenes extends ClrHostValue, System.IDisposableInput {
   /**
    * 对 OCR 识别结果进行纠错；单字名称（如魈、琴）仍可能无法识别
    * @param name OCR 原始名称
-   * @returns 纠错后的角色名称
+   * @returns 纠错后的角色名称；未命中纠错规则时原样返回
    * @deprecated 已过时
    * @since 0.48.0
    */
-  errorOcrCorrection(name: string): string;
+  errorOcrCorrection(name: string): AvatarName;
   /**
    * 释放资源
    * @returns ClearScript 宿主空结果

package/types/BetterGenshinImpact/GameTask/AutoFight/Script/CombatCommand.d.ts

@@ -5,7 +5,7 @@ import type {
 } from "../../../../Microsoft/ClearScript/HostType";
 import type { VoidResult } from "../../../../Microsoft/ClearScript/VoidResult";
 import "../../../../System/Collections/Generic/List";
-import "../Model/Avatar";
+import type { AvatarName } from "../Model/Avatar";
 import "../Model/CombatScenes";
 import "./Method";
 
@@ -20,7 +20,7 @@ export interface CombatCommand extends ClrHostValue {
    * 执行该指令的角色名称
    * @since 0.50.0
    */
-  name: string;
+  name: "当前角色" | AvatarName;
   /**
    * 指令动作方法
    * @since 0.50.0
@@ -76,7 +76,7 @@ export interface CombatCommandHostType extends HostType<CombatCommand, Reference
    * @param command 指令文本，如 `skill` 或 `walk(s, 0.2)`
    * @since 0.50.0
    */
-  new (name: string, command: string): CombatCommand;
+  new (name: "当前角色" | AvatarName, command: string): CombatCommand;
 }
 
 export {};

package/types/BetterGenshinImpact/GameTask/AutoFight/Script/CombatScript.d.ts

@@ -5,6 +5,7 @@ import type {
 } from "../../../../Microsoft/ClearScript/HostType";
 import "../../../../System/Collections/Generic/HashSet";
 import "../../../../System/Collections/Generic/List";
+import type { AvatarName } from "../Model/Avatar";
 import "./CombatCommand";
 
 /**
@@ -28,7 +29,7 @@ export interface CombatScript extends ClrHostValue {
    * 脚本涉及的角色名称集合
    * @since 0.50.0
    */
-  avatarNames: System.Collections.Generic.HashSet<string>;
+  avatarNames: System.Collections.Generic.HashSet<"当前角色" | AvatarName>;
   /**
    * 解析后的战斗指令列表
    * @since 0.50.0
@@ -55,7 +56,7 @@ export interface CombatScriptHostType extends HostType<CombatScript, ReferenceTy
    * @since 0.50.0
    */
   new (
-    avatarNames: System.Collections.Generic.HashSet<string>,
+    avatarNames: System.Collections.Generic.HashSet<"当前角色" | AvatarName>,
     combatCommands: System.Collections.Generic.List<BetterGenshinImpact.GameTask.AutoFight.Script.CombatCommand>
   ): CombatScript;
 }