Files
MaaAssistantArknights/docs/ja-jp/protocol/callback-schema.md
Lucien Shaw 14194d1118 chore: 完善容器配置及依赖安装 (#14208)
格式化工具部分:
1. pre-commit 引入 python 的格式化工具,包括 black(代码格式化)和 isort(对“包导入顺序”的规范)
2. 允许 prettier 对文档站的 markdown 文件格式化
3. 不允许 prettier 对 markdown 文件中的代码块的代码本身进行格式化
4. 升级了 pre-commit 的各个 hook 的版本
5. 优化了 pre-commit 的日志文本显示

容器总览部分:
1. 由原来的单一轻量环境转为区分空环境、轻量环境和全量环境
2. 空环境是裸 Linux 镜像(Ubuntu),为默认环境
3. 轻量环境适合开发文档站前端
4. 全量环境适合开发 MaaCore
5. 目前,全量环境完整包含了轻量环境,轻量环境完整包含了空环境
6. 在仓库 README.md 中更新了三个环境的描述,并将链接分别设置为对应环境的创建链接
   **注意:没有修改文档站中的对应文件**
7. 在各个语言的开发指南的最后,移除了 Codespace 部分的“安装额外依赖”相关描述,且将链接设置为全量环境的创建链接
   **注意:没有添加“开发文档站”的指南和对应 codespace 的使用方式**

容器的轻量环境和全量环境共有部分:
1. 安装 black 和 isort 包
2. 调整 VS Code 设置,取消先前(对 markdown 文件单独指定 markdownlint 扩展作为格式化工具)的错误设置,现在 markdown 文件仍然使用默认的 prettier 扩展作为格式化工具
3. 引入 markdown-all-in-one 扩展作为语法提示工具
4. 将 node_modules 和 3rdparty 排除在 VS Code 的文本的搜索路径之外

容器的全量环境部分:
1. 为 tools 下的所有 python 脚本安装依赖
2. 使用 tools/maadeps-download.py 下载 maadeps,且将必要二进制文件软链接到 /usr/local/bin/
3. 使用 apt 安装 cmake 和 clangd-20,将后者通过 update-alternatives 设置为系统 clangd 的默认版本
4. 使用 cmake tools 扩展,并按照 Linux 编译方法进行配置
5. 使用 clang-format 作为 c/cpp 的格式化工具,clang-format 程序主体来自 maadeps(已经软链接到 /usr/local/bin/)
6. 使用 clangd 作为 c/cpp 的语法提示工具
7. 将 MaaDeps、install 和 build 排除在 VS Code 的文本搜索路径之外

其它手动调整:
1. 更新文档站的 package.json,指定 pnpm 包管理器的版本
2. 手动保证 markdown 文件中的列表前后有空行(注意到 MarkdownLint 官方规则不一定能精准定位所有“列表前后空行”的问题,详见:https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md032---lists-should-be-surrounded-by-blank-lines )
3. 修改了部分 markdown 文件中的 json 代码块的语法问题
   **注意:相同的问题并未全部发现,仅修改了两处**
4. 在 tools 目录中,一处 python 脚本的包名误用(本地包名和某个 pip 包重名),这里修改了相应代码
5. 在 tools 目录中,一处 python 脚本使用了弃用的包 cchardet 的问题,这里更换了推荐使用的功能相近的包并修改了相应代码

自动化脚本提交的修改:
1. 自动格式化了大量 tools 中的 python 脚本
2. 自动格式化了大量 docs 中的 markdown 文件

Commits:

* chore: pre-commit引入black和isort规范py文件

* chore: Auto update by pre-commit hooks [skip changelog]

* chore: devcontainer添加isort扩展,排序python导入

* chore: pre-commit任务命名及更名

* style: isort fix

* chore: Auto update by pre-commit hooks [skip changelog]

* chore: 更新pre-commit的hook版本

* fix: 模块名与第三方库重名,大忌

* chore: 容器构建时额外安装isort

* docs: md -> markdown

* chore: 容器安装python包和maadeps

* fix: 修复过时python包

* chore: 指定pnpm版本

* chore: container支持选择轻量环境

* chore: 去掉rust

* chore: add plain env

* chore: 使用clangd语言服务器

* chore: 无需单独设置markdown的格式化工具

* chore: 更新安装的clangd版本

* docs: 简易文档适配

* docs: 在仓库README中重新编排codespaces相关指引

* chore: Auto update by pre-commit hooks [skip changelog]

* style: 调整缩进

* chore: 格式化工具不用特意排除被gitignore忽略的文件

* chore: sh文件在gitattributes中单列一类

* chore: 格式化docs下的markdown文件

* chore: 暂时不修改md文件中的代码块

* style: 人为明确markdown中的部分列表相关格式

* docs: 补上部分markdown的json代码块中缺失的逗号

* chore: Auto update by pre-commit hooks [skip changelog]

* chore: Auto update by pre-commit hooks [skip changelog]

* fix: 补上tools的服务器排序相关代码中缺失的逗号

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* chore: 使用maadeps的clangd

* build: 更新maadeps工具链版本

* style: prettier fix

* revert: 还原maadeps版本

* revert: 取消使用maadeps的clangd依赖,改用系统apt安装

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-09-30 19:39:48 +08:00

17 KiB
Raw Blame History

order, icon
order icon
2 material-symbols:u-turn-left

コールバック図式

::: info 注意 This document is outdated due to the rapid update of the interface. Since the developers are not good at foreign languages, it is recommended that you refer to the Chinese or English documentation for the latest content :::

::: info 注意 コールバックメッセージがバージョンとともに更新される高速反復では、本書は古くなる可能性があります。最新のコンテンツを入手するには、C#統合ソースコード を参照してください。 :::

Prototype

typedef void(ASST_CALL* AsstCallback)(int msg, const char* details, void* custom_arg);

概要

  • int msg
    The message type

    enum class AsstMsg
    {
        /* Global Info */
        InternalError     = 0,      // 内部エラー
        InitFailed        = 1,      // 初期化に失敗しました
        ConnectionInfo    = 2,      // 接続情報
        AllTasksCompleted = 3,      // すべてのタスクが完了したかどうか
        AsyncCallInfo     = 4,      // 外部非同期呼び出し情報
    
        /* TaskChain Info */
        TaskChainError     = 10000, // 一連のタスク 実行/認識のエラー
        TaskChainStart     = 10001, // 一連のタスク 開始
        TaskChainCompleted = 10002, // 一連のタスク 完了
        TaskChainExtraInfo = 10003, // 一連のタスクの追加情報
        TaskChainStopped   = 10004, // 一連のタスク 手動停止
    
        /* SubTask Info */
        SubTaskError     = 20000,   // サブタスク 実行/認識におけるエラー
        SubTaskStart     = 20001,   // サブタスク 実行
        SubTaskCompleted = 20002,   // サブタスク 完了
        SubTaskExtraInfo = 20003,   // サブタスクの追加情報
        SubTaskStopped   = 20004,   // サブタスク 手動停止
    
        /* Web Request */
        ReportRequest    = 30000,   // レポートリクエスト
    };
    
  • const char* details
    メッセージの詳細, JSON. 詳細: Field Description

  • void* custom_arg
    呼び出し元のカスタム引数には、 AsstCreateEx インターフェースの custom_arg 引数が渡される。C ライクな言語では、this ポインタを一緒に渡すことができる。

Field Description

InternalError

Todo

InitFailed

{
    "what": string,     // Error タイプ
    "why": string,      // Error 理由
    "details": object   // Error 詳細
}

ConnectionInfo

{
    "what": string,     // Info タイプ
    "why": string,      // Info 理由
    "uuid": string,     // UUID (接続に失敗した場合は空白)
    "details": {
        "adb": string,     // AsstConnect インターフェースの adb_path 引数
        "address": string, // AsstConnect インターフェースの address 引数
        "config": string   // AsstConnect インターフェースの config 引数
    }
}

多用される What フィルドの値

  • ConnectFailed
    接続失敗
  • Connected
    接続成功。現段階では uuid フィールドが空であることに注意してください (次のステップで取得されます)
  • UuidGot
    UUID の取得
  • UnsupportedResolution
    この解像度はサポートされていません
  • ResolutionError
    解像度を取得できない
  • Reconnecting
    接続切断 (adb/emulator クラッシュ), 再接続開始
  • Reconnected
    接続切断 (adb/emulator クラッシュ), 再接続成功
  • Disconnect
    接続切断 (adb/emulator クラッシュ), 再接続失敗
  • ScreencapFailed
    画面取得失敗 (adb/emulator クラッシュ), 再接続失敗
  • TouchModeNotAvailable
    サポートされていないタッチモード

AsyncCallInfo

{
    "uuid": string,             // デバイス固有コードUUID
    "what": string,             // コールバック タイプ,"Connect" | "Click" | "Screencap" | ...
    "async_call_id": int,       // 非同期要求 id、つまり AsstAsyncXXX を呼び出したときの戻り値
    "details": {
        "ret": bool,            // 実際に呼び出された戻り値
        "cost": int64,          // 経過時間、単位ミリ秒
    }
}

AllTasksCompleted

{
    "taskchain": string,            // 最後の一連のタスク
    "uuid": string,                 // UUID
    "finished_tasks": [             // 最終動作タスクの ID
        int,
        ...
    ]
}

多用される taskchain フィールドの値

  • StartUp
    ゲーム開始
  • CloseDown
    ゲームを閉じる
  • Fight
    作戦
  • Mall
    FPとFP交換所に買い物
  • Recruit
    自動公開求人
  • Infrast
    基地施設
  • Award
    デイリー報酬を受け取る
  • Roguelike
    統合戦略
  • Copilot
    自動作戦
  • SSSCopilot
    自動保全駐在作戦
  • Depot
    倉庫の識別
  • OperBox
    オペレーターボックス識別
  • Reclamation
    生息演算
  • Custom
    カストム タスク
  • SingleStep
    サブタスク
  • VideoRecognition
    ビデオ認識タスク
  • Debug
    デバッグ

TaskChain 関連情報

{
    "taskchain": string,            // 現在の一連タスク
    "taskid": int,                  // 現在のタスク ID
    "uuid": string                  // UUID
}

TaskChainExtraInfo

Todo

SubTask 関連情報

{
    "subtask": string,             // サブタスク名
    "class": string,               // サブタスククラス
    "taskchain": string,           // 現在の一連のタスク
    "taskid": int,                 // 現在のタスク ID
    "details": object,             // 詳細
    "uuid": string                 // UUID
}

多用される subtask フィールドの値

  • ProcessTask

    // 対応する詳細フィールドの例
    {
        "task": "StartButton2",     // タスク名
        "action": 512,
        "exec_times": 1,            // 実行回数
        "max_times": 999,           // 最大実行回数
        "algorithm": 0
    }
    
  • Todo Other

多用される task フィールドの値
  • StartButton2
    開始
  • MedicineConfirm
    理性回復剤使用確認
  • ExpiringMedicineConfirm
    48時間以内に期限が切れる理性回復剤使用確認
  • StoneConfirm
    純正源石使用確認
  • RecruitRefreshConfirm
    公開求人リストの更新確認
  • RecruitConfirm
    公開求人の確認
  • RecruitNowConfirm
    緊急招集票の使用確認
  • ReportToPenguinStats
    ペンギン急便への報告
  • ReportToYituliu
    Yituliu へビッグデータの報告
  • InfrastDormDoubleConfirmButton
    基地施設での二重確認は、他のオペレーターとの競合がある場合のみ発生します
  • StartExplore
    統合戦略: 開始
  • StageTraderInvestConfirm
    統合戦略: 源石錐とアイテム交換
  • StageTraderInvestSystemFull
    統合戦略: 投資満額
  • ExitThenAbandon
    統合戦略: 終了確認
  • MissionCompletedFlag
    統合戦略: ミッション完了
  • MissionFailedFlag
    統合戦略: ミッション失敗
  • StageTraderEnter
    統合戦略: 怪しい旅商人
  • StageSafeHouseEnter
    統合戦略: 安全な片隅
  • StageEncounterEnter
    統合戦略: 思わぬ遭遇
  • StageCombatDpsEnter
    統合戦略: 作戦
  • StageEmergencyDps
    統合戦略: 緊急作戦
  • StageDreadfulFoe
    統合戦略: 悪路凶敵
  • StartGameTask クライアントの起動に失敗 (client_type と設定ファイルの互換性なし)
  • Todo Other

SubTaskExtraInfo

{
    "taskchain": string,           // 一連のタスク
    "class": string,               // サブタスクのクラス
    "what": string,                // Information タイプ
    "details": object,             // Information 詳細
    "uuid": string,                // UUID
}

多用される whatdetails フィールドの値

  • StageDrops
    ステージドロップインフォメーション

    // 対応する詳細フィールドの例
    {
        "drops": [              // 今回のドロップされた素材
            {
                "itemId": "3301",
                "quantity": 2,
                "itemName": "アーツ学1"
            },
            {
                "itemId": "3302",
                "quantity": 1,
                "itemName": "アーツ学2"
            },
            {
                "itemId": "3303",
                "quantity": 2,
                "itemName": "アーツ学3"
            }
        ],
        "stage": {              // レベル情報
            "stageCode": "CA-5",
            "stageId": "wk_fly_5"
        },
        "stars": 3,             // ステージクリア評価
        "stats": [              // この実行中にドロップされた素材の総量
            {
                "itemId": "3301",
                "itemName": "アーツ学1",
                "quantity": 4,
                "addQuantity": 2 // 今回の新規ドロップ数
            },
            {
                "itemId": "3302",
                "itemName": "アーツ学2",
                "quantity": 3,
                "addQuantity": 1
            },
            {
                "itemId": "3303",
                "itemName": "アーツ学3",
                "quantity": 4,
                "addQuantity": 2
            }
        ]
    }
    
  • RecruitTagsDetected
    採用タグの検出

    // 対応するフィールドの詳細
    {
        "tags": [
            "COST回復",
            "防御",
            "先鋒タイプ",
            "補助タイプ",
            "近距離"
        ]
    }
    
  • RecruitSpecialTag
    特別な採用タグの検出

    // 対応する詳細フィールドの例
    {
        "tag": "上級エリート"
    }
    
  • RecruitResult
    公開求人結果

    // 対応する詳細フィールドの例
    {
        "tags": [                   // 全てのタグ、今のところは5つに違いない
            "弱化",
            "減速",
            "術師タイプ",
            "補助タイプ",
            "近距離"
        ],
        "level": 4,                 // 総合的なレアリティ
        "result": [
            {
                "tags": [
                    "弱化"
                ],
                "level": 4,         // レアリティに対応するタグ
                "opers": [
                    {
                        "name": "プラマニクス",
                        "level": 5  // レアリティに対応するオペレーター
                    },
                    {
                        "name": "メテオリーテ",
                        "level": 5
                    },
                    {
                        "name": "ワイフー",
                        "level": 5
                    },
                    {
                        "name": "ヘイズ",
                        "level": 4
                    },
                    {
                        "name": "メテオ",
                        "level": 4
                    }
                ]
            },
            {
                "tags": [
                    "減速",
                    "術師タイプ"
                ],
                "level": 4,
                "opers": [
                    {
                        "name": "ナイトメア",
                        "level": 5
                    },
                    {
                        "name": "グレイ",
                        "level": 4
                    }
                ]
            },
            {
                "tags": [
                    "弱化",
                    "術師タイプ"
                ],
                "level": 4,
                "opers": [
                    {
                        "name": "ヘイズ",
                        "level": 4
                    }
                ]
            }
        ]
    }
    
  • RecruitTagsRefreshed
    公開求人タグの更新

    // 対応する詳細フィールドの例
    {
        "count": 1,               // スロットが更新された回数
        "refresh_limit": 3        // 更新最大回数
    }
    
  • RecruitNoPermit
    求人票が切れた

    // 対応する詳細フィールドの例
    {
        "continue": true,   // 更新を続けるかどうか
    }
    
  • RecruitTagsSelected
    公開求人タグの選択

    // 対応する詳細フィールドの例
    {
        "tags": [
            "減速",
            "術師タイプ"
        ]
    }
    
  • RecruitSlotCompleted
    公開求人スロットの完了

  • RecruitError
    公開求人認識時のエラー

  • EnterFacility
    施設へ入る

    // 対応する詳細フィールドの例
    {
        "facility": "Mfg",  // 施設名
        "index": 0          // 施設 ID
    }
    
  • NotEnoughStaff
    オペレーター不足

    // 対応する詳細フィールドの例
    {
        "facility": "Mfg",  // 施設名
        "index": 0          // 施設 ID
    }
    
  • ProductOfFacility
    施設の生産

    // 対応する詳細フィールドの例
    {
        "product": "Money", // 生産物
        "facility": "Mfg",  // 施設名
        "index": 0          // 施設 ID
    }
    
  • StageInfo
    自動戦闘ステージの情報

    // 対応する詳細フィールドの例
    {
        "name": string  // ステージ名
    }
    
  • StageInfoError
    自動戦闘ステージの情報エラー

  • PenguinId
    PenguinStats ID

    // 対応する詳細フィールドの例
    {
        "id": string
    }
    
  • DepotInfo
    倉庫のアイテムの認識結果

    // 対応する詳細フィールドの例
    "done": bool,       // 認識が完了したかどうかfalse はまだ進行中かどうか(処理中のデータ)
    "arkplanner": {     // https://penguin-stats.cn/planner
        "object": {
            "items": [
                {
                    "id": "2004",
                    "have": 4,
                    "name": "上級作戦記録"
                },
                {
                    "id": "mod_unlock_token",
                    "have": 25,
                    "name": "モジュールデータ"
                },
                {
                    "id": "2003",
                    "have": 20,
                    "name": "中級作戦記録"
                }
            ],
            "@type": "@penguin-statistics/depot"
        },
        "data": "{\"@type\":\"@penguin-statistics/depot\",\"items\":[{\"id\":\"2004\",\"have\":4,\"name\":\"上級作戦記録\"},{\"id\":\"mod_unlock_token\",\"have\":25,\"name\":\"モジュールデータ\"},{\"id\":\"2003\",\"have\":20,\"name\":\"中級作戦記録\"}]}"
    },
    "lolicon": {     // https://arkntools.app/#/material
        "object": {
            "2004" : 4,
            "mod_unlock_token": 25,
            "2003": 20
        },
        "data": "{\"2003\":20,\"2004\": 4,\"mod_unlock_token\": 25}"
    }
    // 現在は ArkPlanner と Lolicon (Arkntools) 形式のみ対応、今後対応するサイトが増える可能性あり
    
  • OperBoxInfo
    オペレーターボックス識別結果

    // 対応する詳細フィールドの例
    "done": bool,       // 認識が完了したかどうかfalse はまだ進行中かどうか(処理中のデータ)
    "all_oper": [
        {
            "id": "char_002_amiya",
            "name": "阿米娅",
            "own": true
        },
        {
            "id": "char_003_kalts",
            "name": "凯尔希",
            "own": true
        },
        {
            "id": "char_1020_reed2",
            "name": "焰影苇草",
            "own": false
        },
    ]
    "own_opers": [
        {
            "id": "char_002_amiya", // オペレーターID
            "name": "阿米娅",        // 氏名、中国語で出力
            "own": true,            // 持っているかどうか
            "elite": 2,             // 昇進段階 0, 1, 2
            "level": 50,            // レベル
            "potential": 6,         // 潜在 [1, 6]
            "rarity": 5             // レア度 [1, 6]
        },
        {
            "id": "char_003_kalts",
            "name": "凯尔希",
            "own": true,
            "elite": 2,
            "level": 50,
            "potential": 1,
            "rarity": 6
        }
    ]
    
  • UnsupportedLevel
    自動作戦で、サポートされていないレベル名

ReportRequest

このフィールドは、コアモジュールがネットワークリクエスト情報をUI層に渡すために主に使用され、UIは実際のHTTP報告処理を担当します。

{
  "url": "string",            // リクエストの完全なURL、例https://penguin-stats.io/PenguinStats/api/v2/report
  "headers": {                // リクエストヘッダーのキーと値のペアContent-Typeは含まず、UIが追加します
    "authorization": "PenguinID 1234567890",
    "User-Agent": "MaaAssistantArknights/1.2.3 cpr/4.5.6"
  },
  "body": "string",           // リクエストボディの内容通常はJSON形式の文字列
  "subtask": "string"         // サブタスク名、具体的な報告タスクを識別します。例:"ReportToPenguinStats"、"ReportToYituliu"
}