Skip to content

Latest commit

 

History

History
252 lines (207 loc) · 9.63 KB

3.1-集成文档.md

File metadata and controls

252 lines (207 loc) · 9.63 KB
Raw

集成文档

接口介绍

AsstAppendTask

接口原型

TaskId ASSTAPI AsstAppendTask(AsstHandle handle, const char* type, const char* params);

接口说明

添加任务

返回值

  • TaskId
    若添加成功，返回该任务 ID, 可用于后续设置任务参数；
    若添加失败，返回 0

参数说明

  • AsstHandle handle
    实例句柄
  • const char* type
    任务类型
  • const char* params
    任务参数，json string
任务类型一览
  • StartUp
    开始唤醒
// 对应的任务参数
{
    "enable": bool,             // 是否启用本任务，可选，默认为 true
    "client_type": string,      // 客户端版本，可选，默认为空
                                // 选项："Official" | "Bilibili"
    "start_game_enabled": bool   // 是否自动启动客户端，可选，默认不启动
}
  • Fight
    刷理智
// 对应的任务参数
{
    "enable": bool,             // 是否启用本任务，可选，默认为 true
    "stage": string,            // 关卡名，可选，默认为空，识别当前/上次的关卡。不支持运行中设置
                                // 支持全部主线关卡，如 "1-7"、"S3-2"等
                                // 另支持少部分资源关卡，如 "CE-6" 等（请参考 C# 集成示例）
    "medicine": int,            // 最大使用理智药数量，可选，默认 0
    "stone": int,               // 最大吃石头数量，可选，默认 0
    "times": int,               // 指定次数，可选，默认无穷大
    "drops": {                  // 指定掉落数量，可选，默认不指定
        "30011": int,           // key - item_id, value 数量. key 可参考 resource/item_index.json 文件
        "30062": int            // 是或的关系
    },
    /* 以上全部是或的关系，即任一达到即停止任务 */

    "report_to_penguin": bool,  // 是否汇报企鹅数据，可选，默认 false
    "penguin_id": string,       // 企鹅数据汇报 id, 可选，默认为空。仅在 report_to_penguin 为 true 时有效
    "server": string,           // 服务器，可选，默认 "CN", 会影响掉落识别及上传
                                // 选项："CN" | "US" | "JP" | "KR"
    "client_type": string,      // 客户端版本，可选，默认为空。用于游戏崩溃时重启并连回去继续刷，若为空则不启用该功能
                                // 选项："Official" | "Bilibili"
    "DrGrandet": bool,          // 节省理智碎石模式，可选，默认 false，仅在可能产生碎石效果时生效。
                                // 在碎石确认界面等待，直到当前的 1 点理智恢复完成后再立刻碎石
}
  • Recruit
    公开招募
// 对应的任务参数
{
    "enable": bool,             // 是否启用本任务，可选，默认为 true
    "refresh": bool,            // 是否刷新三星 Tags, 可选，默认 false
    "select": [                 // 会去点击标签的 Tag 等级，必选
        int,
        ...
    ],
    "confirm": [                // 会去点击确认的 Tag 等级，必选。若仅公招计算，可设置为空数组
        int,
        ...
    ],
    "times": int,               // 招募多少次，可选，默认 0。若仅公招计算，可设置为 0
    "set_time": bool,           // 是否设置招募时限。仅在 times 为 0 时生效，可选，默认 true
    "expedite": bool,           // 是否使用加急许可，可选，默认 false
    "expedite_times": int,      // 加急次数，仅在 expedite 为 true 时有效。
                                // 可选，默认无限使用（直到 times 达到上限）
    "skip_robot": bool,         // 是否在识别到小车词条时跳过，可选，默认跳过
    "recruitment_time": {       // Tag 等级（大于等于 3）和对应的希望招募时限，单位为分钟，默认值都为 540（即 09:00:00）
        "3": int,
        "4": int,
        ...
    },
    "report_to_penguin": bool,  // 是否汇报企鹅数据，可选，默认 false
    "penguin_id": string,       // 企鹅数据汇报 id, 可选，默认为空。仅在 report_to_penguin 为 true 时有效
    "report_to_yituliu": bool,  // 是否汇报一图流数据，可选，默认 false
    "yituliu_id": string,       // 一图流汇报 id, 可选，默认为空。仅在 report_to_yituliu 为 true 时有效
}
  • Infrast
    基建换班
{
    "enable": bool,         // 是否启用本任务，可选，默认为 true
    "mode": int,            // 换班工作模式，可选，默认 0
                            // 0 - 默认换班模式，单设施最优解
                            // 10000 - 自定义换班模式，读取用户配置，可参考 3.6-基建排班协议.md

    "facility": [           // 要换班的设施（有序），必选。不支持运行中设置
        string,             // 设施名，"Mfg" | "Trade" | "Power" | "Control" | "Reception" | "Office" | "Dorm"
        ...
    ],
    "drones": string,       // 无人机用途，可选项，默认 _NotUse
                            // mode==10000 时该字段无效（会被忽略）
                            // "_NotUse"、"Money"、"SyntheticJade"、"CombatRecord"、"PureGold"、"OriginStone"、"Chip"
    "threshold": float,     // 工作心情阈值，可选，取值范围 [0, 1.0]，默认 0.3
                            // mode==10000 时该字段仅针对 "autofill" 有效
    "replenish": bool,      // 贸易站“源石碎片”是否自动补货，可选，默认 false

    "dorm_notstationed_enabled": bool, // 是否启用宿舍“未进驻”选项，可选，默认 false
    "drom_trust_enabled": bool, // 是否将宿舍剩余位置填入信赖未满干员，可选，默认 false
    
    /* 以下参数仅在 mode=10000 时生效，否则会被忽略 */
    "filename": string,     // 自定义配置路径，必选。不支持运行中设置
    "plan_index": int,      // 使用配置中的方案序号，必选。不支持运行中设置
}
  • Visit
    访问好友
// 对应的任务参数
{
    "enable": bool          // 是否启用本任务，可选，默认为 true
}
  • Mall
    领取信用及商店购物。
    会先有序的按 buy_first 购买一遍，再从左到右并避开 blacklist 购买第二遍
// 对应的任务参数
{
    "enable": bool,         // 是否启用本任务，可选，默认为 true
    "shopping": bool,       // 是否购物，可选，默认 false。不支持运行中设置
    "buy_first": [          // 优先购买列表，可选。不支持运行中设置
        string,             // 商品名，如 "招聘许可"、"龙门币" 等
        ...
    ],
    "blacklist": [          // 黑名单列表，可选。不支持运行中设置
        string,             // 商品名，如 "加急许可"、"家具零件" 等
        ...
    ]
}
  • Award
    领取日常奖励
// 对应的任务参数
{
    "enable": bool          // 是否启用本任务，可选，默认为 true
}
  • Roguelike
    无限刷肉鸽
{
    "enable": bool,         // 是否启用本任务，可选，默认为 true
    "mode": int,            // 模式，可选项。默认 0
                            // 0 - 刷蜡烛，尽可能稳定的打更多层数
                            // 1 - 刷源石锭，第一层投资完就退出
                            // 2 - 【即将弃用】两者兼顾，投资过后再退出，没有投资就继续往后打
                            // 3 - 【开发中】尝试通关，尽可能打的远
    "starts_count": int,    // 开始探索 次数，可选，默认 INT_MAX。达到后自动停止任务
    "investments_count": int,
                            // 投资源石锭 次数，可选，默认 INT_MAX。达到后自动停止任务
    "stop_when_investment_full": bool,
                            // 投资满了自动停止任务，可选，默认 false      
    "squad": string,        // 开局分队，可选，例如 "突击战术分队" 等，默认 "指挥分队"
    "roles": string,        // 开局职业组，可选，例如 "先手必胜" 等，默认 "取长补短"
    "core_char": string     // 开局干员名，可选，仅支持单个干员中！文！名！。默认识别练度自动选择
}
  • Copilot
    自动抄作业
{
    "enable": bool,             // 是否启用本任务，可选，默认为 true
    "stage_name": string,       // 关卡名，需要与作业 JSON 中的 stage_name 字段相同。不支持运行期设置
    "filename": string,         // 作业 JSON 的文件路径，绝对、相对路径均可。不支持运行期设置
    "formation": bool           // 是否进行 “快捷编队”，可选，默认否。不支持运行期设置
}

作业 JSON请参考 战斗流程协议

  • Depot
    仓库识别
// 对应的任务参数
{
    "enable": bool          // 是否启用本任务，可选，默认为 true
}

AsstSetTaskParams

接口原型

bool ASSTAPI AsstSetTaskParams(AsstHandle handle, TaskId id, const char* params);

接口说明

设置任务参数

返回值

  • bool
    返回是否设置成功

参数说明

  • AsstHandle handle
    实例句柄
  • TaskId task
    任务 ID, AsstAppendTask 接口的返回值
  • const char* params
    任务参数，json string，与 AsstAppendTask 接口相同。
    未标注“不支持运行中设置”的字段都支持实时修改；否则若当前任务正在运行，会忽略对应的字段