ブレインを作る

ブレインとは

既定はエンジン本来のコンピューターで、それはエンジンの中にあり続けます。ブレインがプレイするのはコンピューターの席1つで、それもプレイヤーが設定した席だけです。ブレインのIDが空なら、それは内蔵コンピューターを意味します。ブレインのない席、合わないブレイン、停止したブレインの席は、どれも同じ内蔵コンピューターがプレイします。ClassicはLuaで書かれ、内蔵コンピューターと同じようにプレイします。これは内蔵コンピューターを記述したもので、置き換えるものではありません。

スクリプトを実行するのはコンピューターを席に着かせたマシンだけなので、ほかのプレイヤーは何もインストールする必要がありません。ほかのプレイヤーのマシンは、その席のユニットをミラーするだけです。録画を再生するときは、スクリプトを実行しません。ブレインはLuaのソースとデータで、ネイティブコード、ファイル、ネットワーク、時計を持ちません。全視界はマニフェストのフラグです。ブレインはこれを設定でき、ネットワーク対戦でも使え、席にはそのフラグが表示されます。

パッケージ

ブレインは1つの.oabrainファイル、またはそのファイルを展開したフォルダーです。マニフェストはMODプロファイルと同じ厳格なYAMLで、ドキュメントは1つ、最上位は1つのマッピング、アンカーとブロックスカラーは使えません。パッケージの最上位にはoabrain.yamlを置きます。その隣に置けるファイルは、次のいずれかです。このリストにないファイルは拒否されます。

比較ではASCII文字の大文字と小文字を区別しません。ただし、規格がバイトの一致を求める箇所は除きます。entryが別のファイルを指定しているとき、brain.luaはリスト外になります。Luaファイル1つは最大1 MiBです。アイコンは正方形のPNGで、1辺は最大256ピクセル、サイズは最大256 KiBです。OAは、ブレインをBrains/の下の、マニフェストのIDのフォルダーにインストールします。

マニフェスト

読み取り側は違反しているルールをすべて集めます。1つでも違反があれば、マニフェストは変更されずに残ります。規格にないキーは拒否されます。プロファイルのキーはMODに書くものです。ミューテータのキーは、ミューテータのキーとして拒否されます。バージョンは引用符で囲んでください。ただの1.0は数値になります。星印も引用符で囲んでください。ただの星印はYAMLのエイリアスになります。

9つのタグ

タグはこの9つのいずれかで、バイト単位で比較されます。共通のタグルールを満たしていても、4個を超えていれば、それ自体が独立した問題として扱われます。9つにないタグは拒否されます。

レベルと難易度

levelsは1〜6個のマッピングのリストです。それぞれid、name、difficultyのちょうど3つで、すべて必須です。idは1〜32バイトの小文字のケバブケースで、重複は不可。nameは制御文字を含まない1〜64バイト。difficultyはeasy、medium、hardのいずれかで、バイト単位で一致する必要があります。

この3つの名前は、値0、1、2にあたります。レベルを選んだ席は、その値を収入ルールに使います。ゲームがすでに使っているのと同じ難易度です。

全視界

fullAwarenessはtrueかfalseです。省略するとfalseです。このフラグを持つブレインは、内蔵コンピューターと同じく、霧の中の席には見えないユニットまで見え、建設地点の確認に配置するプレイヤーを必要としません。このフラグはネットワーク対戦でも使えます。ライブラリにはTotal Annihilation本来のコンピューターと同じく、マップ上の全ユニットが見えると表示されます。フラグはマニフェスト自身のもので、パッケージのIDによって与えられるものではなく、Classicだけに与えられるものの1つでもありません。

ブレインが動く場所

パッケージが必要なのは、コンピューターを席に着かせたマシンだけで、スクリプトを実行するのもそのマシンだけです。席とは、そのマシンのコンピューターのことです。人間の席は拒否されます。game.modeはskirmish、campaign、networkのいずれかです。

席がプレイするブレインは、シミュレーションハッシュの入力に含まれません。どのブレインを席に着かせたかだけが違う2つの対戦は、同じ対戦状態ハッシュを保ちます。MODのai.*ハックの値は、そのハッシュが対象とするMODプロファイルの一部なので、変わらずすべてのマシンに届きます。

ランタイムの予算

ブレインは1つのサンドボックス内でLuaとして実行されます。2つのブレインが、モジュール、グローバル変数、予算を共有することはありません。スクリプトはファイル、時計、環境変数、プロセス、ネットワークを持ちません。チャンクはすべてテキストとして読み込まれます。pcallやxpcallで、使い切ったフェーズを生き延びさせることはできません。ターンとは、ユニットの巡回処理の後、席のコントローラー処理の時点で行われる、貯めた予算を使う1回の呼び出しです。フックが出した命令は次のティックで有効になります。

ブレインが停止するとき

ブレインが停止するのは、フックかタイマーでのエラー、命令数の上限の使い切り、実時間の安全上限、Luaのメモリ上限、65,536バイトを超える文字列、席が拒否する読み込みのいずれかが起きたときです。失敗したターンは、そのターンが戻る前にサンドボックスを閉じ、フックを消去します。失敗したターン自体はプレイ済みとして数えられます。次の命令ティックにはフックがないので、内蔵コンピューターがそれを引き継ぎます。拒否された、開始に失敗した、または合わないブレインはフックを持たないので、最初から内蔵コンピューターがプレイします。通知にはマニフェストの名前と、160バイトで切った理由が使われます：

- `{brain} stopped ({reason}); the engine plays this seat on`
- `{brain} could not start ({reason}); the engine plays this seat`
- `{brain} does not fit this game ({reason}); the engine plays this seat`

席に固有の理由がない場合、理由はthe brain could not be seatedです。敗北したプレイヤーは、単にそれ以降呼び出されなくなります。サンドボックスは対戦の終了とともに閉じます。