bettergi-scripts-list/repo/js/SwitchParty/utils/tools.js
云端客 f5a7331ddd
切换队伍(BgiTools版) (#3629)
* feat(SwitchParty): 添加BgiTools版切换队伍功能

- 新增BgiTools工具类,支持通过API获取团队信息
- 实现OCR识别长期训练点数功能
- 添加队伍切换主逻辑,支持输入加载和BgiTools加载两种模式
- 集成HTTP请求工具,支持GET/POST/PUT/DELETE方法
- 实现UI操作工具类,包含返回主界面等功能
- 添加红框绘制工具用于调试显示
- 集成日志、格式化、找图找文本等通用工具
- 配置项目清单文件和设置界面选项

docs(SwitchParty): 添加切换队伍脚本的详细文档

- 新增 README.md 文件,包含脚本简介和功能特点说明
- 详细描述输入加载和 bgi_tools 加载两种模式的使用方法
- 提供完整的目录结构和配置说明表格
- 添加使用示例和 API 请求格式说明
- 包含切换队伍逻辑流程和常见问题解答
- 记录版本历史和注意事项

docs(switchparty): 更新 README 添加演示图片

- 在文档中添加了 bgi_tools_init.jpg 演示图片
- 在文档中添加了 bgi_tools_js.jpg 演示图片
- 丰富了脚本初始化和 JS 配置的视觉说明

* refactor(bgi_tools): 重构接口响应处理逻辑

- 新增 Result 类用于统一接口响应结构封装
- 添加状态码、消息、时间戳和数据字段的标准响应格式
- 实现 isSuccess 方法用于判断响应成功状态
- 添加 fromJson 静态方法支持 JSON 字符串或对象解析
- 修改 getTeamInfo 方法使用 Result 统一处理响应数据
- 移除原有的手动 JSON 解析和格式验证逻辑
- 优化错误处理和日志记录机制

fix(bgi_tools): 统一处理响应数据格式解析

- 移除原有的 isJson 函数判断逻辑
- 添加字符串类型的 JSON 解析处理
- 增加对象类型的直接使用逻辑
- 添加错误处理以应对无效 JSON 响应
- 统一响应数据的解析方式确保格式一致性

fix(bgi_tools): 修复JSON解析错误处理

- 添加isJson函数验证响应体是否为有效JSON字符串
- 防止非JSON格式响应导致的解析异常
- 确保只有有效的JSON字符串才进行解析操作
- 提高请求响应处理的健壮性

fix(utils): 解决响应体解析错误问题

- 添加了安全的JSON解析函数safeParse
- 当JSON解析失败时返回原始字符串
- 避免因响应体格式异常导致的程序崩溃
- 提高了代码的容错性和稳定性

refactor(SwitchParty): 优化团队信息获取逻辑

- 移除未使用的代码注释和变量声明
- 直接解析HTTP响应体为JSON格式
- 重命名变量以提高代码可读性
- 统一错误处理机制

fix(utils): 修复URL参数拼接逻辑

- 在get方法中避免空查询字符串时添加多余的问号
- 在delete方法中避免空查询字符串时添加多余的问号
- 确保只有在查询字符串非空时才添加问号分隔符

fix(utils): 修复查询字符串处理逻辑

- 添加了对空字符串的检查,避免无效的切片操作
- 当查询字符串为空时返回空字符串而不是执行切片
- 防止了潜在的字符串索引越界问题

fix(bgi_tools): 修复团队信息获取功能

- 移除未使用的查询字符串构造逻辑
- 更新Http.get调用方式以支持参数传递
- 添加请求成功日志记录
- 统一错误处理机制为抛出异常
- 在main.js中添加团队信息获取日志
- 完善HTTP工具类的异步处理和日志记录

refactor(SwitchParty): 优化队伍切换逻辑并改进变量命名

- 将 team 变量重命名为 team_name 以提高可读性
- 统一代码风格,移除不必要的分号和空行
- 优化 BgiTools 集成中的团队数据提取逻辑
- 改进错误处理和日志记录的一致性
- 简化条件判断和团队切换流程

feat(SwitchParty): 添加BGI版本信息到清单文件

- 在manifest.json中添加bgi_version字段
- 设置BGI版本为0.64.0以匹配当前依赖版本
2026-09-10 23:23:46 +08:00

401 lines
No EOL
13 KiB
JavaScript
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/**
* 抛出错误函数
* 该函数用于显示错误通知并抛出错误对象
* @param {string} msg - 错误信息,将用于通知和错误对象
*/
export function throwError(msg, isNotification = false) {
// 使用notification组件显示错误通知
// notification.error(`${msg}`);
if (isNotification) {
notification.error(`${msg}`);
}
// 抛出一个包含错误信息的Error对象
throw new Error(`${msg}`);
}
/**
* UI工具类
*/
export class UI {
/**
* 检查当前是否在主界面
* @returns {boolean} 如果在主界面则返回true,否则返回false
*/
static isInMainUI() {
// let name = '主界面' // 注释掉的变量定义,可能是用于调试的临时变量
let main_ui = 'assets/ui/main_ui.png'; // 获取主界面的配置信息,包括路径、名称和类型
// 定义识别对象,使用模板匹配方法来检测主界面特征
let paimonMenuRo = RecognitionObject.TemplateMatch(
file.ReadImageMatSync(`${main_ui}`), // 读取模板图片
0, // 起始点x坐标
0, // 起始点y坐标
1980 / 3.0, // 匹配区域的宽度
1080 / 5.0 // 匹配区域的高度
);
let captureRegion = captureGameRegion(); // 获取游戏区域的截图
try {
// 在捕获的区域中查找模板匹配的结果
let res = captureRegion.find(paimonMenuRo);
return !res.isEmpty(); // 如果找到匹配项则返回true,否则返回false
} finally {
// 确保释放资源
captureRegion.dispose()
}
}
static async toMainUi() {
let ms = 300
let index = 1
await sleep(ms);
while (!UI.isInMainUI()) {
await sleep(ms);
await genshin.returnMainUi(); // 如果未启用,则返回游戏主界面
await sleep(ms);
if (index > 3) {
throwError(`多次尝试返回主界面失败`);
}
index += 1
}
}
}
/**
* 红框工具类
*/
export class Box {
/**
*
* @param {boolean} show - 是否显示调试信息
* @param {Object} result - 目标区域坐标对象,包含 x、y、width、height 属性
* @param {number} [delay=1000] - 红框显示的延时(毫秒),默认1000ms
* @param {Pen} [pen=new Pen(Color.Red, 2)] - 红框的画笔对象,默认红色实线
* @returns {Promise<void>}
*/
static async draw(show = true, result, delay = 1000, pen) {
if (!pen) pen = new Pen(Color.Red, 2);
if (show) {
await Box.drawAndClear(result, delay, pen);
}
}
/**
* 在游戏画面上绘制红框并在延时后自动清除
* 通过截取游戏区域并绘制图标来实现红框标记效果,延时结束后通过重绘同一区域来清除红框
* @param {Object} result - 目标区域坐标对象,包含 x、y、width、height 属性
* @param {number} [delay=1000] - 红框显示的延时(毫秒),默认1000ms
* @param {Pen} [pen=new Pen(Color.Red, 2)] - 红框的画笔对象,默认红色实线
* @returns {Promise<void>}
*/
static async drawAndClear(result, delay = 1000, pen) {
if (!pen) pen = new Pen(Color.Red, 2);
const ro1 = captureGameRegion();
try {
const drawRegion = ro1.DeriveCrop(result.x, result.y, result.width, result.height);
drawRegion.DrawSelf("icon", pen);
} finally {
ro1.dispose();
}
await sleep(delay);
const ro2 = captureGameRegion();
try {
const drawRegion2 = ro2.DeriveCrop(result.x, result.y, result.width, result.height);
try {
drawRegion2.DrawSelf("icon", pen);
} finally {
drawRegion2.dispose();
}
} finally {
ro2.dispose();
}
}
}
/**
* 日志工具类
*/
export class Log{
static info(message, ...args){
log.info(message, ...args)
}
static error(message, ...args){
log.error(message, ...args)
}
static debug(message, ...args){
if (settings.debug){
log.info(`[开发模式] [Debug] ${message}`, ...args)
}else {
log.debug(message, ...args)
}
}
static warn(message, ...args){
log.warn(message, ...args)
}
}
/**
* 格式化工具类
*/
export class Format{
/**
* 字符串格式化函数,支持类似C语言的格式化占位符
* @param {string} format - 格式化字符串,包含%占位符
* @param {...*} args - 可变参数,用于替换格式化字符串中的占位符
* @returns {string} 格式化后的字符串
*/
static async String(format, ...args) {
let argIndex = 0; // 当前使用的参数索引
// 使用正则表达式匹配格式化占位符,如%s, %d, %f等
return format.replace(/%(\d*\.?\d*[sdf%])/g, (match, pattern) => {
// 如果匹配到的是%%,则返回%
if (pattern === '%') return '%';
// 如果参数已用完,返回原始匹配字符串
if (argIndex >= args.length) return match;
// 获取当前参数
const val = args[argIndex++];
// 获取格式化类型(s, d, f)
const type = pattern.slice(-1);
// 获取数字格式(如%.2f中的2)
const numPattern = pattern.slice(0, -1);
// 根据类型进行格式化
switch (type) {
case 's':
return String(val);
case 'd':
return parseInt(val).toString();
case 'f':
const dotIdx = numPattern.indexOf('.');
const fixed = dotIdx > -1 ? Number(numPattern.slice(dotIdx + 1)) : 6;
return Number(val).toFixed(fixed);
default:
return match;
}
});
}
}
/**
* 找图找文本工具类
*/
export class Find{
/**
* 通用找文本并点击(OCR)
* @param {string} text 目标文本(单个文本)
* @param {number} [x=0] OCR 区域左上角 X
* @param {number} [y=0] OCR 区域左上角 Y
* @param {number} [w=1920] OCR 区域宽度
* @param {number} [h=1080] OCR 区域高度
* @param {number} [attempts=5] OCR 尝试次数
* @param {number} [interval=50] 每次 OCR 之间的等待间隔(毫秒)
* @param {number} [preClickDelay=50] 点击前等待时间(毫秒)
* @param {number} [postClickDelay=50] 点击后等待时间(毫秒)
*
* @returns
* - RecognitionResult | null
*/
static async findTextAndClick(
text,
x = 0,
y = 0,
w = 1920,
h = 1080,
attempts = 5,
interval = 50,
preClickDelay = 50,
postClickDelay = 50
) {
const keyword = text.toLowerCase();
for (let i = 0; i < attempts; i++) {
const gameRegion = captureGameRegion();
try {
const ro = RecognitionObject.Ocr(x, y, w, h);
const results = gameRegion.findMulti(ro);
for (let j = 0; j < results.count; j++) {
const res = results[j];
if (
res.isExist() &&
res.text &&
res.text.toLowerCase().includes(keyword)
) {
await sleep(preClickDelay);
res.click();
await sleep(postClickDelay);
return res;
}
}
} finally {
gameRegion.dispose();
}
await sleep(interval);
}
return null;
}
/**
* 通用找图并点击(支持图片文件路径、Mat)
* @param {string|Mat} target 图片路径或已构造的 Mat
* @param {number} [x=0] 识别区域左上角 X
* @param {number} [y=0] 识别区域左上角 Y
* @param {number} [w=1920] 识别区域宽度
* @param {number} [h=1080] 识别区域高度
* @param {number} [timeout=1000] 识别时间上限(毫秒)
* @param {number} [interval=50] 每次识别之间的等待间隔(毫秒)
* @param {number} [preClickDelay=50] 点击前等待时间(毫秒)
* @param {number} [postClickDelay=50] 点击后等待时间(毫秒)
*
* @returns
* - RecognitionResult | null
*/
static async findImgAndClick(
target,
x = 0,
y = 0,
w = 1920,
h = 1080,
timeout = 1000,
interval = 50,
preClickDelay = 50,
postClickDelay = 50
) {
const ro =
typeof target === 'string'
? RecognitionObject.TemplateMatch(
file.readImageMatSync(target),
x, y, w, h
)
: RecognitionObject.TemplateMatch(
target,
x, y, w, h
);
const start = Date.now();
while (Date.now() - start <= timeout) {
const gameRegion = captureGameRegion();
try {
const res = gameRegion.find(ro);
if (!res.isEmpty()) {
await sleep(preClickDelay);
res.click();
await sleep(postClickDelay);
return res;
}
} finally {
gameRegion.dispose();
}
await sleep(interval);
}
return null;
}
}
/**
* HTTP请求工具类
*/
export class Http{
/**
* 构造查询参数
* @param json
* @returns {Promise<string>}
*/
static async buildParams(json){
const paramsMap = new Map(Object.entries(json));
// 遍历 Map 构造查询参数
let queryString = '';
paramsMap.forEach((value, key) => {
if (value !== undefined) {
queryString += `${key}=${value}&`;
}
});
// 去掉末尾多余的 &
queryString = queryString.trim() ? queryString.slice(0, -1) : '';
return queryString;
}
/**
* 发送GET请求
* @param url
* @param params
* @param headersJson
* @returns {status_code:number,body:object}
*/
static async get(url, params={}, headersJson) {
const method = 'GET';
const queryString = await Http.buildParams(params);
url += queryString.trim() ? '?' + queryString : '';
return await Http.request(method, url, null, headersJson);
}
/**
* 发送POST请求
* @param url
* @param body
* @param headersJson
* @returns {status_code:number,body:object}
*/
static async post(url, body={}, headersJson) {
const method = 'POST';
return await Http.request(method, url, body, headersJson)
}
/**
* 发送PUT请求
* @param url
* @param body
* @param headersJson
* @returns {status_code:number,body:object}
*/
static async put(url, body={}, headersJson) {
const method = 'PUT';
return await Http.request(method, url, body, headersJson)
}
/**
* 发送DELETE请求
* @param url
* @param params
* @param headersJson
* @returns {status_code:number,body:object}
*/
static async delete(url, params={}, headersJson) {
const method = 'DELETE';
const queryString = await Http.buildParams(params);
url += queryString.trim() ? '?' + queryString : '';
return await Http.request(method, url, null, headersJson)
}
/**
* 发送HTTP请求
* @param method
* @param url
* @param requestBody
* @param headersJson
* @returns {Promise<http.Response>}
*/
static async request(method, url, requestBody, headersJson) {
const { status_code, body } = await http.request(method, url, requestBody, headersJson);
Log.info(`发送HTTP请求, 方法: {method}, URL: {url}, 参数: {body}, 响应: {response}`,method,url,JSON.stringify(requestBody),JSON.stringify({ status_code, body }))
if (status_code !== 200) {
Log.error(`请求失败, HTTP状态码: {status_code}, 响应: {body}`,status_code,JSON.stringify(body));
throw new Error(`请求失败, HTTP状态码: ${status_code}, 响应: ${JSON.stringify(body)}`);
}
function safeParse(str) {
try {
return JSON.parse(str);
} catch {
return str;
}
}
return safeParse(body)
}
}