バッチモードでUnityを実行するときの制限事項と回避方法

本記事は、拙著『Unity Test Framework完全攻略ガイド統合テスト編』の付録Bから抜粋したものです。

バッチモードとは

バッチモードとは、Unityエディターをコマンドラインから起動するときに -batchmode オプションを付けることでヘッドレス動作するモードです。ウィンドウモード*1のUnityエディターは実行中さまざまな、人間が応答しなければならないポップアップウィンドウが表示されますが、バッチモードでは表示されません。そのため、CIでテスト実行するときなどに使用されます。

バッチモードの制限事項

本記事執筆時点で判明している、バッチモード実行時の制限事項は次のとおりです。

スクリーンサイズは640×480
WaitForEndOfFrame を使用できない*2
InputSystem.TestFramework を長時間（数十秒）動作させたとき、途中で操作が止まってしまう
UnityEngine.InputSystem.LowLevel.InputEventTrace を使用できない
-testPlatform オプションでスタンドアロンプレイヤーを指定したとき、バッチモードでなく常にウィンドウモードで起動する

制限事項の回避方法1

バッチモード実行中であっても、EditorWindow.GetWindow() メソッドでUnityエディターのGameビューを開くことで前述の制限を回避できます。

ヘッドレスとは言ったがウィンドウを表示できないとは言っていない

とのこと。

次のコードは、テスト実行前にGameビューを開く ICallbacks の実装例です。

public class OpenGameViewAtRunStarted : ICallbacks
{
  [InitializeOnLoadMethod]
  private static void SetupTestCallbacks()
  {
    var api = ScriptableObject.CreateInstance<TestRunnerApi>();
    api.RegisterCallbacks(new OpenGameViewAtRunStarted());
  }

  public void RunStarted(ITestAdaptor testsToRun)
  {
    var assembly = Assembly.Load("UnityEditor.dll");
    var viewClass = Application.isBatchMode
        ? "UnityEditor.GameView"
        : "UnityEditor.PlayModeView";
    var gameView = assembly.GetType(viewClass);
    EditorWindow.GetWindow(gameView, false, null, true);
  }

  // snip
}