mirror of
https://github.com/MaaAssistantArknights/MaaAssistantArknights.git
synced 2026-07-19 18:47:55 +08:00
Update 3.2-コールバックAPI.md
English base in Japanese text add.
This commit is contained in:
@@ -0,0 +1,240 @@
|
||||
# インテグレーション
|
||||
|
||||
## API
|
||||
|
||||
### `AsstAppendTask`
|
||||
|
||||
#### Prototype
|
||||
|
||||
```c++
|
||||
TaskId ASSTAPI AsstAppendTask(AsstHandle handle, const char* type, const char* params);
|
||||
```
|
||||
|
||||
#### Description
|
||||
|
||||
タスクの追加
|
||||
|
||||
#### Return Value
|
||||
|
||||
- `TaskId`
|
||||
以下の構成で、タスクの追加に成功した場合のタスクID;
|
||||
タスクの追加に失敗した場合は0。
|
||||
|
||||
#### Parameter Description
|
||||
|
||||
- `AsstHandle handle`
|
||||
Instance handle
|
||||
- `const char* type`
|
||||
Task type
|
||||
- `const char* params`
|
||||
Task parameters in JSON
|
||||
|
||||
##### List of Task Types
|
||||
|
||||
- `StartUp`
|
||||
Start-up
|
||||
|
||||
```jsonc
|
||||
// 対応するタスクのパラメータ
|
||||
{
|
||||
"enable": bool, // このタスクを有効にするかどうか、オプション、デフォルトは true
|
||||
"client_type": string, // クライアントバージョン, オプション, デフォルトは空白
|
||||
// オプション: "Official" | "Bilibili"
|
||||
"start_game_enabled": bool // クライアントを自動的に起動するかどうか, オプション, デフォルトはfalse
|
||||
}
|
||||
```
|
||||
|
||||
- `Fight`
|
||||
Operation
|
||||
|
||||
```jsonc
|
||||
// 対応するタスクのパラメータ
|
||||
{
|
||||
"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: number of items. キーは resource/item_index.json に記載されています
|
||||
"30062": int // OR 組み合わせ
|
||||
},
|
||||
/* 項目はOR演算子で結合され、いずれかの条件を満たしたときにタスクが停止する。 */
|
||||
|
||||
"report_to_penguin": bool, // Pengiun Stats にデータをアップロードするかどうか, オプション, デフォルトは false
|
||||
"penguin_id": string, // Penguin Stats ID, オプション, デフォルトは空白. `report_to_penguin` が `true`の時のみ使用可能.
|
||||
"server": string, // サーバー, オプション, デフォルトは "CN", ドロップ認識とアップロードに影響します
|
||||
// 選択オプション:"CN" | "US" | "JP" | "KR"
|
||||
"client_type": string, // クライアントバージョン, オプション, デフォルトは空白. ゲームがクラッシュした後、再接続するために使用します. 空白の場合この機能を無効にします。
|
||||
// オプション: "Official" | "Bilibili"
|
||||
"DrGrandet": bool, // 純正源石を使用する際に理性を節約します, オプション, デフォルトは false. 純正源石の使用画面でしか機能しません
|
||||
// 理性が1ポイント回復するまで、使用確認画面で待ち、すぐに純正源石を使用することができます。
|
||||
}
|
||||
```
|
||||
|
||||
- `Recruit`
|
||||
公開求人
|
||||
|
||||
```jsonc
|
||||
// 対応するタスクのパラメータ
|
||||
{
|
||||
"enable": bool, // このタスクを有効にするかどうか, オプション, デフォルトは true
|
||||
"refresh": bool, // ★3 タグの場合更新, オプション, デフォルトは false
|
||||
"select": [ // タグレベルのクリック, 必須
|
||||
int,
|
||||
...
|
||||
],
|
||||
"confirm": [ // 確認するタグのレベル, 必須. 計算用に空配列を設定することも可能.
|
||||
int,
|
||||
...
|
||||
],
|
||||
"times": int, // 採用回数, オプション, デフォルトは 0. 0 にセットすることで計算だけに使用可能.
|
||||
"set_time": bool, // 時刻を9時間に設定するかどうか, `times` が 0 の時のみ設定可能, オプション, デフォルトは true
|
||||
"expedite": bool, // 緊急招集票の使用, オプション, デフォルトは false
|
||||
"expedite_times": int, // 緊急招集票の使用回数, `expedite` が `true` の場合のみ使用可能
|
||||
// オプション, デフォルトでは `times` の限界まで使用します.
|
||||
"skip_robot": bool, // ロボットタグが認識されたときにスキップするかどうか, オプション, デフォルトは skip.
|
||||
"recruitment_time": { // タグレベルおよび設定時間(分), オプション, デフォルトは 540 (例. 9 時間)
|
||||
"3": int,
|
||||
"4": int,
|
||||
...
|
||||
},
|
||||
"report_to_penguin": bool, // Pengiun Stats にデータをアップロードするかどうか, オプション, デフォルトは false
|
||||
"penguin_id": string, // Penguin Stats ID, オプション, デフォルトは空白. `report_to_penguin` が `true`の時のみ使用可能.
|
||||
"report_to_yituliu": bool, // YITULIU にデータをアップロードするかどうか, オプション, デフォルトは false
|
||||
"yituliu_id": string, // YITULIU user id, オプション, デフォルトは空白. `report_to_yituliu` が `true`の時のみ使用可能.
|
||||
}
|
||||
```
|
||||
|
||||
- `Infrast`
|
||||
基地シフト
|
||||
|
||||
```jsonc
|
||||
{
|
||||
"enable": bool, // タスクを有効にするかどうか, オプション, デフォルトは true
|
||||
"mode": int, // シフトモード, 予約, オプション. 動作中に変更はできません.
|
||||
"facility": [ // シフト対象設備, 必須. 動作中の編集はサポートされていません.
|
||||
string, // 施設名: "Mfg" | "Trade" | "Power" | "Control" | "Reception" | "Office" | "Dorm"
|
||||
...
|
||||
],
|
||||
"drones": string, // ドローンの使用, オプション, デフォルトは "_NotUse"
|
||||
// "_NotUse"、"Money"、"SyntheticJade"、"CombatRecord"、"PureGold"、"OriginStone"、"Chip"
|
||||
"threshold": float, // 宿舎に移動させる体力のしきい値 [0, 1.0], オプション, デフォルトは 0.3
|
||||
"replenish": bool, // 源石の欠片を自動で補充する, オプション, デフォルトは false
|
||||
}
|
||||
```
|
||||
|
||||
- `Visit`
|
||||
フレンドの基地訪問
|
||||
|
||||
```jsonc
|
||||
// 対応するタスクのパラメータ
|
||||
{
|
||||
"enable": bool // このタスクを有効にするかどうか, オプション, デフォルトは true
|
||||
}
|
||||
```
|
||||
|
||||
- `Mall`
|
||||
FPの回収と自動購入
|
||||
`buy_first` にあるリストリストに従った順序でアイテムを購入した後, `blacklist` の内容を無視して左から右の順番で購入します.
|
||||
|
||||
```jsonc
|
||||
// 対応するタスクのパラメータ
|
||||
{
|
||||
"enable": bool, // このタスクを有効にするかどうか, オプション, デフォルトは true
|
||||
"shopping": bool, // 購買所から購入するかどうか, オプション, デフォルトは false. 動作中に変更はできません.
|
||||
"buy_first": [ // アイテム購入の優先度, オプション. 動作中に変更はできません.
|
||||
string, // アイテム名, 例. "招聘许可" (Recruitment Permit/求人票), "龙门币" (LMD/龍門弊), その他.
|
||||
...
|
||||
],
|
||||
"blacklist": [ // ブラックリスト, オプション. 動作中に変更はできません.
|
||||
string, // アイテム名, 例. "加急许可" (Expedited Plan/緊急招集票), "家具零件" (Furniture Part/家具パーツ), その他.
|
||||
...
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
- `Award`
|
||||
報酬の受け取り.
|
||||
|
||||
```jsonc
|
||||
// 対応するタスクのパラメータ
|
||||
{
|
||||
"enable": bool // このタスクを有効にするかどうか, オプション, デフォルトは true
|
||||
}
|
||||
```
|
||||
|
||||
- `Roguelike`
|
||||
統合戦略
|
||||
|
||||
```jsonc
|
||||
{
|
||||
"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`
|
||||
自動戦闘 開発中機能
|
||||
|
||||
```jsonc
|
||||
{
|
||||
"enable": bool, // このタスクを有効にするかどうか, オプション, デフォルトは true
|
||||
"stage_name": string, // ステージ名, JSONの `stage_name` フィールドと同じです. 動作中に変更はできません.
|
||||
"filename": string, // タスクのJSONのファイル名とパス, 絶対/相対 パスのサポート. 動作中に変更はできません.
|
||||
"formation": bool // "quick build" を行うかどうか, オプション, デフォルトは false. 動作中に変更はできません.
|
||||
}
|
||||
```
|
||||
|
||||
自動操縦JSONの詳細については, [Copilot Schema](3.3-COPILOT_SCHEMA.md)を参照してください
|
||||
|
||||
- `Depot`
|
||||
倉庫アイテム認識
|
||||
|
||||
```jsonc
|
||||
// 対応するタスクのパラメータ
|
||||
{
|
||||
"enable": bool // このタスクを有効にするかどうか, オプション, デフォルトは true
|
||||
}
|
||||
```
|
||||
|
||||
### `AsstSetTaskParams`
|
||||
|
||||
#### Prototype
|
||||
|
||||
```c++
|
||||
bool ASSTAPI AsstSetTaskParams(AsstHandle handle, TaskId id, const char* params);
|
||||
```
|
||||
|
||||
#### Description
|
||||
|
||||
Set task parameters
|
||||
|
||||
#### Return Value
|
||||
|
||||
- `bool`
|
||||
パラメータが正常に設定されたかどうか.
|
||||
|
||||
#### Parameter Description
|
||||
|
||||
- `AsstHandle handle`
|
||||
Instance handle
|
||||
- `TaskId task`
|
||||
Task ID, the return value of `AsstAppendTask`
|
||||
- `const char* params`
|
||||
JSONのタスクパラメーター, `AsstAppendTask` と同じ
|
||||
"動作中に変更はできません" と記載されていないフィールドはランタイム中に変更することができます. そうでなければ、タスクの実行中にこれらの変更は無視される.
|
||||
|
||||
Reference in New Issue
Block a user