はじめに
久しぶりに Unity を触ってみようと思い立ったは良いものの、デバッグ実行の仕方も分からなくなっていた(以前は MonoDevelop を使っていました)ので、改めて調べながら動くところまで漕ぎ着けたので情報を整理して残します。
また、大まかな流れは以下だけです。
1. Unity 側で Visual Studio Code との紐付けをする
2. Visual Studio Code でデバッガ用の拡張機能を入れ、プロジェクトを読み込み、実行状態にする
動作環境
- macOS Catalina (10.15.5)
- Unity (2019.2.12f1)
- Visual Studio Code (1.49.1)
- C# for Visual Studio Code (1.23.2)
- Unity Debugger Extension for Visual Studio Code (2.7.5)
- .NET Core 3.1 SDK
前提条件
- Unity のインストールが終わっていること
- Visual Studio Code のインストールが終わっていること
- 適当な Unity のプロジェクトがあること
私は Unity NavMesh : Basics のサンプルプロジェクトを使いました。
https://learn.unity.com/tutorial/unity-navmesh
Unity 側の設定
- [Unity] -> [Preferences...] -> [External Tools] -> [External Script Editor] のプルダウンメニューから Visual Studio Code を選択する。
Visual Studio Code 側の設定
-
左側にある Extensions タブ(四角いブロックみたいなアイコン)を選択し、
C# for Visual Studio Code
とUnity Debugger Extension for Visual Studio Code
を検索し、インストールする。(※図はインストール済みの状態。また、私の環境では .NET 系の警告が出ていたため、指示に従って .NET Core 3.1 SDK Core 3.1 SDK も合わせてインストールしています)
-
左側にある Run タブ(虫&再生ボタンみたいなアイコン)を選択し、Open a file~ の部分をクリックして、Unity のプロジェクトを読み込ませる。
先の Unity NavMesh のサンプルプロジェクトを読み込むとこんな感じになりました。
-
引き続き Run タブから、create a launch.json file. の部分をクリックして、Unity Debugger を選び launch.json を作成する。
作成に成功すると、Run タブの UI が変化し、デバッグ実行可能な状態となるので、図にある「▷マーク」をクリックして実行します。(※Unity アプリが立ち上がる訳ではないので、Unit 側は別途立ち上げ・実行する必要があります)
デバッグ実行中はエディタ上によくあるステップ実行等のボタンが表示され、
左から「実行/一時停止」「ステップオーバー」「ステップイン」「ステップアウト」「再起動」「停止」
実行例
以上でデバッガを動作させるまでの手順は完了です。
ここからは、実際にブレークポイントを貼って動かした際の例となりますので、不要な方はここで読み終えて頂ければと思います。
- 以下は Unity NavMesh のサンプル実行画面(画面をクリックするとレイを飛ばして、筒状のキャラクターがその位置まで移動すると言うものです)
画面をクリックした時に通過する場所に貼ったブレークポイントでしっかり止まってくれました。
変数の中身もちゃんと覗けているようです。
という事で、最低限動作するところまでは確認できました。
おわりに
Visual Studio Code には Unity 用の便利な拡張機能があるようなので、少しずつ試してみたいと思います。
拡張機能の検索欄に unity と打ち込むだけでも相当数出てくるので、どれが良いものなのか判断に困るのですが..。
参考文献
UnityでVisual Studio Codeを使用できるようにするまでの手順
Unity での C# コードのデバッグ(リファレンス)
https://code.visualstudio.com/docs/editor/debugging#_global-launch-configuration