集成文档
约 5265 字大约 18 分钟
接口介绍
AsstAppendTask
接口原型
AsstTaskId ASSTAPI AsstAppendTask(AsstHandle handle, const char* type, const char* params);接口说明
添加任务
返回值
AsstTaskId
若添加成功，返回该任务 ID, 可用于后续设置任务参数；
若添加失败，返回 0
参数说明
handleRequiredAsstHandle
实例句柄
typeRequiredconst char*
任务类型
paramsRequiredconst char*
任务参数，json string
任务类型一览
StartUp
开始唤醒
enableOptionalboolean
true
是否启用本任务。
client_typeRequiredstring
客户端版本。
选项：Official | Bilibili | txwy | YoStarEN | YoStarJP | YoStarKR
start_game_enabledOptionalboolean
false
是否自动启动客户端。
account_nameOptionalstring
切换账号，默认不切换。
仅支持切换至已登录的账号，使用登录名进行查找，保证输入内容在所有已登录账号唯一即可。
官服：123****4567，可输入 123****4567、4567、123、3****4567
B服：张三，可输入 张三、张、三
CloseDown
关闭游戏
enableOptionalboolean
true
是否启用本任务。
client_typeRequiredstring
客户端版本，填空则不执行。
选项：Official | Bilibili | txwy | YoStarEN | YoStarJP | YoStarKR
Fight
刷理智
enableOptionalboolean
true
是否启用本任务。
stageOptionalstring
关卡名，默认为空，识别当前/上次的关卡。不支持运行中设置。
支持全部主线关卡，如 "1-7"、"S3-2"等。
可在关卡结尾输入Normal/Hard表示需要切换标准与磨难难度。
剿灭作战，必须输入 "Annihilation"。
当期 SS 活动 后三关，必须输入完整关卡编号。
medicineOptionalnumber
0
最大使用理智药数量。
expiring_medicineOptionalnumber
0
最大使用 48 小时内过期理智药数量。
stoneOptionalnumber
0
最大吃石头数量。
timesOptionalnumber
2147483647
战斗次数。
seriesOptionalnumber
连战次数, -1~6。-1 为禁用切换。0 为自动切换为当前可用的最大次数, 如当前理智不够6次, 则选择最低可用次数。1~6 为指定连战次数。
dropsOptionalobject
指定掉落数量，默认不指定。key 为 item_id, value 为数量。key 可参考 resource/item_index.json 文件。
例如: { "30011": 10, "30062": 5 }
以上全部是或的关系，即任一达到即停止任务。
report_to_penguinOptionalboolean
false
是否汇报企鹅数据。
penguin_idOptionalstring
企鹅数据汇报 id, 默认为空。仅在 report_to_penguin 为 true 时有效。
serverOptionalstring
CN
服务器，会影响掉落识别及上传。
选项：CN | US | JP | KR
client_typeOptionalstring
客户端版本，默认为空。用于游戏崩溃时重启并连回去继续刷，若为空则不启用该功能。
选项：Official | Bilibili | txwy | YoStarEN | YoStarJP | YoStarKR
DrGrandetOptionalboolean
false
节省理智碎石模式，仅在可能产生碎石效果时生效。
在碎石确认界面等待，直到当前的 1 点理智恢复完成后再立刻碎石。
另支持少部分资源关卡名请参考集成示例
Recruit
公开招募
enableOptionalboolean
true
是否启用本任务。
refreshOptionalboolean
false
是否刷新三星 Tags。
selectRequiredarray<number>
会去点击标签的 Tag 等级。
confirmRequiredarray<number>
会去点击确认的 Tag 等级。若仅公招计算，可设置为空数组。
first_tagsOptionalarray<string>
首选 Tags，仅在 Tag 等级为 3 时有效。默认为空。
当 Tag 等级为 3 时，会尽可能多地选择这里的 Tags（如果有），而且是强制选择，也就是会忽略所有“让 3 星 Tag 不被选择”的设置。
extra_tags_modeOptionalnumber
0
选择更多的 Tags。0 - 默认行为1 - 选 3 个 Tags, 即使可能冲突2 - 如果可能, 同时选择更多的高星 Tag 组合, 即使可能冲突
timesOptionalnumber
0
招募多少次。若仅公招计算，可设置为 0。
set_timeOptionalboolean
true
是否设置招募时限。仅在 times 为 0 时生效。
expediteOptionalboolean
false
是否使用加急许可。
expedite_timesOptionalnumber
加急次数，仅在 expedite 为 true 时有效。默认无限使用（直到 times 达到上限）。
skip_robotOptionalboolean
true
是否在识别到小车词条时跳过。
recruitment_timeOptionalobject
Tag 等级（大于等于 3）和对应的希望招募时限，单位为分钟，默认值都为 540（即 09:00:00）。
例如: { "3": 540, "4": 540 }
report_to_penguinOptionalboolean
false
是否汇报企鹅数据。
penguin_idOptionalstring
企鹅数据汇报 id, 默认为空。仅在 report_to_penguin 为 true 时有效。
report_to_yituliuOptionalboolean
false
是否汇报一图流数据。
yituliu_idOptionalstring
一图流汇报 id, 默认为空。仅在 report_to_yituliu 为 true 时有效。
serverOptionalstring
CN
服务器，会影响上传。
选项：CN | US | JP | KR
Infrast
基建换班
enableOptionalboolean
true
是否启用本任务。
modeOptionalnumber
0
换班工作模式。0 - Default: 默认换班模式，单设施最优解。10000 - Custom: 自定义换班模式，读取用户配置，可参考 基建排班协议。20000 - Rotation: 一键轮换模式，会跳过控制中枢、发电站、宿舍以及办公室，其余设施不进行换班但保留基本操作（如使用无人机、会客室逻辑）。
facilityRequiredarray<string>
要换班的设施（有序）。不支持运行中设置。
设施名：Mfg | Trade | Power | Control | Reception | Office | Dorm | Processing | Training
dronesOptionalstring
\_NotUse
无人机用途。mode = 10000 时该字段无效。
选项：_NotUse | Money | SyntheticJade | CombatRecord | PureGold | OriginStone | Chip
thresholdOptionalnumber
0.3
工作心情阈值，取值范围 [0, 1.0]。mode = 10000 时该字段仅针对 "autofill" 有效。mode = 20000 时该字段无效。
replenishOptionalboolean
false
贸易站“源石碎片”是否自动补货。
dorm_notstationed_enabledOptionalboolean
false
是否启用宿舍“未进驻”选项。
dorm_trust_enabledOptionalboolean
false
是否将宿舍剩余位置填入信赖未满干员。
reception_message_boardOptionalboolean
true
是否领取会客室信息板信用。
reception_clue_exchangeOptionalboolean
true
是否进行线索交流。
filenameRequiredstring
自定义配置路径。不支持运行中设置。
plan_indexRequirednumber
使用配置中的方案序号。不支持运行中设置。
Mall
领取信用及商店购物。
会先有序的按buy_first购买一遍，再从左到右并避开blacklist购买第二遍，在信用溢出时则会无视黑名单从左到右购买第三遍直到不再溢出
enableOptionalboolean
true
是否启用本任务。
visit_friendsOptionalboolean
true
是否访问好友基建以获得信用。
shoppingOptionalboolean
true
是否购物。
buy_firstOptionalarray<string>
[]
优先购买列表。商品名，如 "招聘许可"、"龙门币" 等。
blacklistOptionalarray<string>
[]
购物黑名单列表。商品名，如 "加急许可"、"家具零件" 等。
force_shopping_if_credit_fullOptionalboolean
false
是否在信用溢出时无视黑名单。
only_buy_discountOptionalboolean
false
是否只购买折扣物品，只作用于第二轮购买。
reserve_max_creditOptionalboolean
false
是否在信用点低于 300 时停止购买，只作用于第二轮购买。
credit_fightOptionalboolean
false
是否借助战打一局 OF-1 关卡以便在第二天获得更多信用。
formation_indexOptionalnumber
0
打 OF-1 时所使用的编队栏位的编号。
为 0–4 的整数，其中 0 表示选择当前编队，1-4 分别表示第一、二、三、四编队。
Award
领取各种奖励
enableOptionalboolean
true
是否启用本任务。
awardOptionalboolean
true
领取每日/每周任务奖励。
mailOptionalboolean
false
领取所有邮件奖励。
recruitOptionalboolean
false
领取限定池子赠送的每日免费单抽。
orundumOptionalboolean
false
领取幸运墙的合成玉奖励。
miningOptionalboolean
false
领取限时开采许可的合成玉奖励。
specialaccessOptionalboolean
false
领取五周年赠送的月卡奖励。
Roguelike
无限刷肉鸽
enableOptionalboolean
true
是否启用本任务。
themeOptionalstring
Phantom
主题。Phantom - 傀影与猩红血钻Mizuki - 水月与深蓝之树Sami - 探索者的银凇止境Sarkaz - 萨卡兹的无终奇语JieGarden - 界园
modeOptionalnumber
0
模式。0 - 刷分/奖励点数，尽可能稳定地打更多层数。1 - 刷源石锭，第一层投资完就退出。2 - 已弃用 兼顾模式 0 与 1，投资过后再退出，没有投资就继续往后打。3 - 开发中...4 - 凹开局，先在 0 难度下到达第三层后重开，再到指定难度下凹开局奖励，若不为热水壶或希望则回到 0 难度下重新来过；若在 Phantom 主题下则不切换难度，仅在当前难度下尝试到达第三层、重开、凹开局。5 - 刷坍缩范式；仅适用于 Sami 主题；通过战斗漏怪等方式加快坍缩值积累，若遇到的第一个的坍缩范式在 expected_collapsal_paradigms 列表中则停止任务，否则重开。6 - 刷月度小队蚊子腿，除了针对模式的适配以外和模式0相同。7 - 刷深入调查蚊子腿，除了针对模式的适配以外和模式0相同。
squadOptionalstring
指挥分队
开局分队名。
rolesOptionalstring
取长补短
开局职业组。
core_charOptionalstring
开局干员名。仅支持单个干员中文名，无论区服；若留空或设置为空字符串 "" 则根据练度自动选择。
use_supportOptionalboolean
false
开局干员是否为助战干员。
use_nonfriend_supportOptionalboolean
false
是否可以是非好友助战干员。仅在 use_support 为 true 时有效。
starts_countOptionalnumber
2147483647
开始探索的次数。达到后自动停止任务。
difficultyOptionalnumber
0
指定难度等级。仅适用于除 Phantom 以外的主题。若未解锁难度，则会选择当前已解锁的最高难度。
stop_at_final_bossOptionalboolean
false
是否在第 5 层险路恶敌节点前停止任务。仅适用于除 Phantom 以外的主题。
stop_at_max_levelOptionalboolean
false
是否在肉鸽等级刷满后停止任务。
investment_enabledOptionalboolean
true
是否投资源石锭。
investments_countOptionalnumber
2147483647
投资源石锭的次数。达到后自动停止任务。
stop_when_investment_fullOptionalboolean
false
是否在投资到达上限后自动停止任务。
investment_with_more_scoreOptionalboolean
false
是否在投资后尝试购物。仅适用于模式 1。
start_with_elite_twoOptionalboolean
false
是否在凹开局的同时凹干员精二直升。仅适用于模式 4。
only_start_with_elite_twoOptionalboolean
false
是否只凹开局干员精二直升而忽视其他开局条件。仅在模式为 4 且 start_with_elite_two 为 true 时有效。
refresh_trader_with_diceOptionalboolean
false
是否用骰子刷新商店购买特殊商品。仅适用于 Mizuki 主题，用于刷指路鳞。
first_floor_foldartalOptionalstring
希望在第一层远见阶段得到的密文版。仅适用于 Sami 主题，不限模式；若成功凹到则停止任务。
start_foldartal_listOptionalarray<string>
[]
凹开局时希望在开局奖励阶段得到的密文板。仅在主题为 Sami 且模式为 4 时有效。
仅当开局拥有列表中所有的密文板时才算凹开局成功。
注意，此参数须与 “生活至上分队” 同时使用，其他分队在开局奖励阶段不会获得密文板。
collectible_mode_start_listOptionalobject
凹开局时期望的奖励，默认全为 false。仅在模式为 4 时有效。hot_water: 热水壶奖励，常用于触发烧水机制（通用）。shield: 护盾奖励，约等于额外生命值（通用）。ingot: 源石锭奖励（通用）。hope: 希望奖励（通用，注意：JieGarden 主题下无 hope 奖励）。random: 随机奖励选项：游戏中指“消耗所有源石锭换一个随机收藏品”（通用）。key: 钥匙奖励，仅在 Mizuki 主题时有效。dice: 骰子奖励，仅在 Mizuki 主题时有效。ideas: 2 构想奖励，仅在 Sarkaz 主题时有效。
use_foldartalOptionalboolean
是否使用密文板。模式 5 下默认值 false，其他模式下默认值 true。仅适用于 Sami 主题。
check_collapsal_paradigmsOptionalboolean
是否检测获取的坍缩范式。模式 5 下默认值 true，其他模式下默认值 false。
double_check_collapsal_paradigmsOptionalboolean
true
是否执行坍缩范式检测防漏措施。仅在主题为 Sami 且 check_collapsal_paradigms 为 true 时有效。模式 5 下默认值 true，其他模式下默认值 false。
expected_collapsal_paradigmsOptionalarray<string>
['目空一些', '睁眼瞎', '图像损坏', '一抹黑']
希望触发的坍缩范式。仅在主题为 Sami 且模式为 5 时有效。
monthly_squad_auto_iterateOptionalboolean
是否启动月度小队自动切换。
monthly_squad_check_commsOptionalboolean
是否将月度小队通信也作为切换依据。
deep_exploration_auto_iterateOptionalboolean
是否启动深入调查自动切换。
collectible_mode_shoppingOptionalboolean
false
烧水是否启用购物。
collectible_mode_squadOptionalstring
烧水时使用的分队, 默认与squad同步, 当squad为空字符串且未指定collectible_mode_squad值时为指挥分队。
start_with_seedOptionalboolean
false
使用种子刷钱。
仅在 Sarkaz 主题，Investment 模式，“点刺成锭分队” or “后勤分队” 时可能为 true。
使用固定种子。
刷坍缩范式功能具体请参考 肉鸽辅助协议
Copilot
自动抄作业
{
"enable": bool, // 是否启用本任务，可选，默认值 true
"filename": string, // 单一作业 JSON 文件的路径，与 copilot_list 二选一（必填）；相对路径与绝对路径均可
"copilot_list": [ // 作业列表，与 filename 二选一（必填）；当 filename 与 copilot_list 同时存在时，忽视 copilot_list；此参数生效时仅可执行 set_params 一次
{
"filename": string, // 作业 JSON 文件的路径；相对路径与绝对路径均可
"stage_name": string, // 关卡名，具体请参考 [PRTS.Map](https://map.ark-nights.com)
"is_raid": bool, // 是否切换为突袭模式，可选, 默认值 false
"is_paradox": bool // 是否为悖论模拟关卡, 可选, 默认值 false；测试中参数
},
...
],
"loop_times": int, // 循环次数，可选，默认值 1；仅在单一作业模式下（即指定 filename 时）有效；此参数生效时仅可执行 set_params 一次
"use_sanity_potion": bool, // 是否允许在剩余理智不足时使用理智药，可选，默认值 false
"formation": bool, // 是否进行自动编队，可选，默认值 false
"formation_index": int // 自动编队所使用的编队栏位的编号，可选，默认值 0；仅在 formation 为 true 时有效；
// 为 0–4 的整数，其中 0 表示选择当前编队，1-4 分别表示第一、二、三、四编队
"user_additional": [ // 自定义追加干员列表，可选，默认值 []；仅在 formation 为 true 时有效
{
"name": string, // 干员名，可选，默认值 ""，若留空则忽视此干员
"skill": int // 需要携带的技能，可选，默认值 1；为 1–3 的整数，若不在此范围内则遵从游戏内默认的技能选择
},
...
],
"add_trust": bool, // 是否在自动编队时以信赖值升序自动填充空余栏位，可选，默认值 false；仅在 formation 为 true 时有效
"ignore_requirements": bool, // 是否在自动编队时忽视干员属性要求，可选，默认值 false；仅在 formation 为 true 时有效
"support_unit_usage": int, // 助战干员的使用模式，可选，默认值 0；为 0–3 的整数，其中 support_unit_name；仅在 formation 为 true 时有效
// 0 - 表示不使用助战干员
// 1 - 如果有且仅有一名缺失干员则尝试寻找助战干员补齐编队，如果无缺失干员则不使用助战干员
// 2 - 如果有且仅有一名缺失干员则尝试寻找助战干员补齐编队，如果无缺失干员则使用指定助战干员
// 3 - 如果有且仅有一名缺失干员则尝试寻找助战干员补齐编队，如果无缺失干员则使用随机助战干员
"support_unit_name": string // 指定助战干员名，可选，默认值 ""；仅在 support_unit_usage 为 2 时有效
}作业 JSON 请参考 战斗流程协议
SSSCopilot
自动抄保全作业
enableOptionalboolean
true
是否启用本任务。
filenameRequiredstring
作业 JSON 的文件路径，绝对、相对路径均可。不支持运行期设置。
loop_timesOptionalnumber
循环执行次数。
保全作业 JSON 请参考 保全派驻协议
Depot
仓库识别
enableOptionalboolean
true
是否启用本任务。
OperBox
干员 box 识别
enableOptionalboolean
true
是否启用本任务。
Reclamation
生息演算
enableOptionalboolean
true
是否启用本任务。
themeOptionalstring
Fire
主题。Fire - 沙中之火Tales - 沙洲遗闻
modeOptionalnumber
0
模式。0 - 刷分与建造点，进入战斗直接退出。1 - 沙中之火：刷赤金，联络员买水后基地锻造；沙洲遗闻：自动制造物品并读档刷货币。
tools_to_craftOptionalarray<string>
['荧光棒']
自动制造的物品，建议填写子串。
increment_modeOptionalnumber
0
点击类型。0 - 连点1 - 长按
num_craft_batchesOptionalnumber
16
单次最大制造轮数。
Custom
自定义任务
enableOptionalboolean
true
是否启用本任务。
task_namesRequiredarray<string>
执行数组中第一个匹配上的任务（及后续 next 等）。若想执行多个任务，可多次 append Custom task。
SingleStep
单步任务（目前仅支持战斗）
enableOptionalboolean
true
是否启用本任务。
typeRequiredstring
copilot
目前仅支持 "copilot"。
subtaskRequiredstring
子任务类型。stage - 设置关卡名，需要 "details": { "stage": "xxxx" }。start - 开始作战，无 details。action - 单步作战操作，details 需为作战协议中的单个 action，例如："details": { "name": "史尔特尔", "location": [ 4, 5 ], "direction": "左" }，详情参考 战斗流程协议。
detailsOptionalobject
子任务的详细参数。
VideoRecognition
视频识别，目前仅支持作业（作战）视频
enableOptionalboolean
true
是否启用本任务。
filenameRequiredstring
视频的文件路径，绝对、相对路径均可。不支持运行期设置。
AsstSetTaskParams
接口原型
bool ASSTAPI AsstSetTaskParams(AsstHandle handle, AsstTaskId id, const char* params);接口说明
设置任务参数
返回值
bool
返回是否设置成功
参数说明
handleRequiredAsstHandle
实例句柄
taskRequiredAsstTaskId
任务 ID, AsstAppendTask 接口的返回值
paramsRequiredconst char\*
任务参数，json string，与 AsstAppendTask 接口相同。
未标注“不支持运行中设置”的字段都支持实时修改；否则若当前任务正在运行，会忽略对应的字段
AsstSetStaticOption
接口原型
bool ASSTAPI AsstSetStaticOption(AsstStaticOptionKey key, const char* value);接口说明
设置进程级参数
返回值
bool
返回是否设置成功
参数说明
keyRequiredAsstStaticOptionKey
键
valueRequiredconst char\*
值
键值一览
暂无
AsstSetInstanceOption
接口原型
bool ASSTAPI AsstSetInstanceOption(AsstHandle handle, AsstInstanceOptionKey key, const char* value);接口说明
设置实例级参数
返回值
bool
返回是否设置成功
参数说明
handleRequiredAsstHandle
实例句柄
keyRequiredAsstInstanceOptionKey
键
valueRequiredconst char\*
值
键值一览
enum InstanceOptionKey
{
Invalid = 0,
// 已弃用 // MinitouchEnabled = 1, // 是否启用 minitouch
// 开了也不代表就一定能用，有可能设备不支持等
// "1" 开，"0" 关
TouchMode = 2, // 触控模式设置，默认 minitouch
// minitouch | maatouch | adb
DeploymentWithPause = 3, // 是否暂停下干员，同时影响抄作业、肉鸽、保全
// "1" | "0"
AdbLiteEnabled = 4, // 是否使用 AdbLite， "0" | "1"
KillAdbOnExit = 5, // 退出时是否杀掉 Adb 进程， "0" | "1"
};