クイック スタート: Visual Studio Tools for Unreal Engine

  • [アーティクル]

この記事では、Unreal Engine (UE) ゲーム サンプルをダウンロードし、Visual Studio Tools for Unreal Engine を使用して次の操作を行います。

前提条件

以下がインストールされている必要があります。

  • Visual Studio バージョン 17.7 以降
  • Unreal Engine バージョン 5 以降。このクイック スタートで使用する例には UE5 以降が必要であるため。
  • Visual Studio Tools for Unreal Engine。 インストールの手順については、「Visual Studio Tools for Unreal Engine のインストール」を参照してください。

Visual Studio で Lyra ゲーム サンプルをダウンロードしてビルドする

Lyra は、Unreal Engine のフレームワークについて学習するためのサンプル 3D ゲーム プロジェクトです。 ダウンロード手順については、Lyra Sample Game の「Downloading the Lyra Starter Game」 (Lyra Starter Game のダウンロード) セクションを参照してください。

Visual Studio Tools for Unreal Engine を使用するように Lyra ゲーム サンプルを構成する

ゲーム サンプルをダウンロードしたら、Visual Studio Tools プラグインを使用するように LyraStarterGame.uproject を更新します。 これは、Unreal Editor のメイン メニューの [Edit]>[Plugins] で Visual Studio Integration プラグインを見つけて、その横にあるボックスをオンにすることでも行えます。 しかし、ここでは次の手順に従って行います。

  1. テキスト エディターで LyraStarterGame.uproject ファイルを開きます。 これは、ゲーム サンプルをインストールしたディレクトリにあります。

  2. Plugins セクションの末尾に次を追加します。

     ,{
 	"Name": "VisualStudioTools",
 	"Enabled": true
 }

  3. Unreal Engine で Lyra プロジェクトを開きます。

  4. Unreal Engine エディターのメイン メニューから、[Tools]>[Refresh Visual Studio Project] を選択します。 これにより、Visual Studio のソリューション ファイルが作成または更新されます。

  5. Unreal Engine エディターのメイン メニューから、[Tools]>[Open Visual Studio] を選択します。 これにより、Visual Studio でゲームが開きます。 コンピューターに複数のバージョンの Visual Studio がある場合は、Visual Studio のメイン メニューから、[ヘルプ]>[Microsoft Visual Studio のバージョン情報] を選択して、適切なバージョンが開かれていることを確認します。 Visual Studio 2022 バージョン 17.7 以降を使用する必要があります。 適切なバージョンが開いていない場合は、正しいバージョンの Visual Studio で LyraStarterGame.sln を手動で開きます。

  6. Visual Studio のメイン メニューから、[ビルド]>[ソリューションのビルド] を選択してゲームをビルドします。

  7. [ソリューション構成] ドロップダウンを [開発エディター] に変更します。 これにより、ブループリント Visual Studio Tools for Unreal Engineが有効になります。Screenshot of Visual Studio with the Solutions Configurations dropdown expanded and Development Editor selected.

Visual Studio で UE ブループリントを表示する

Visual Studio 内から UE ブループリントを表示することはできますが、編集することはできません。 これは、Unreal Editor と Visual Studio を切り替えることなく UE ブループリントを表示できるため便利です。 試すには、次の手順に従います。

  1. Visual Studio で LyraCharacter.h を開きます。 ソリューション エクスプローラーの [検索] ペインでそのファイルを検索するか、[ゲーム]>[LyraStarterGame]>[ソース]>[LyraGame]>[Character]>[LyraCharacter.h] でファイルを見つけます
  2. LyraCharacter.h の 96 行目に移動します。 次のクラスが表示されます。class LYRAGAME_API ALyraCharacter : public AModularCharacter ...
  3. このクラスを拡張するブループリント クラスは 4 つあります。 ALyraCharacter クラス定義のすぐ上に、4 derived Blueprint classes というリンクが表示されます。 そのリンクをクリックすると、このクラスを拡張する 4 つのブループリント クラスが表示されます。 Screenshot of the blueprints link above the Alyra Character class. It lists related blueprints.
  4. Character_Default_C ブループリントのプロパティを表示するには、それをダブルクリックしてブループリント資産ビューアーを開きます。 ブループリントのさまざまなプロパティを表示することはできますが、変更することはできません。 Screenshot of the Character_Default_C Blueprint asset viewer. It shows properties such as Actor, Camera, Character, Collision, and so on.

Visual Studio 内で UE ログを表示する

Visual Studio Tools for Unreal Engine を使用して、Visual Studio 内で UE ログを表示できます。 これは、Unreal Editor と Visual Studio を切り替えることなく UE ログを表示できるため便利です。 試すには、次の手順に従います。

  1. Visual Studio で LyraGameplayAbility_RangedWeapon.cpp を開きます。 ソリューション エクスプローラーの [検索] ペインでそのファイルを検索するか、[ゲーム]>[LyraStarterGame]>[ソース]>[LyraGame]>[Weapons]>[LyraGameplayAbility_RangedWeapon.cpp] でファイルを見つけます。

  2. LyraGameplayAbility_RangedWeapon.cpp の 477 行目に移動します。 次の関数が表示されます。void ULyraGameplayAbility_RangedWeapon::OnTargetDataReadyCallback

  3. 関数の先頭に次のコード UE_LOG(LogLyra, Log, TEXT("shot fired")); を挿入します。これにより、この関数が呼び出されたときに shot fired がログされる、カテゴリ LogLyra に関連付けられたログ エントリが作成されます。

  4. [デバッグ]>[デバッグの開始] を選択して、Visual Studio でサンプル ゲームを実行します。 Unreal Editor が Lyra ゲームで開きます。 読み込むのに少し時間がかかります。

  5. Visual Studio で、Visual Studio のメイン メニューから [表示]>[その他のウィンドウ]>[Unreal Engine ログ] を選択して、UE ログ ウィンドウを開きます。

  6. Unreal Editor で、ツール バー (または Alt+p) の [Play] ボタンを選択してゲームを開始します。

  7. Lyra ゲームで、w、a、s、d キーを使用してプレイヤーを左側の Elimination ポータルに移動します。 プレイヤーをエントリ ポータル上に配置してゲームを読み込みます。

  8. ゲームが実行されたら、マウス ボタンをクリックして起動します。 これにより、LogLyra カテゴリにいくつかのログ エントリが作成されます。 これで、次のステップのカテゴリ フィルターに LogLyra が表示されます。

  9. 次のように、UE ログ ウィンドウで LogLyra カテゴリ イベントを除くすべてのイベントをフィルター処理して、ログ ノイズを低減します。[カテゴリ] ドロップダウンを選択します。 一覧の上部にある (すべて選択) を選択して、すべてのログ ソースをクリアします。 次に、[LogLyra] を選択します。 UE ログ ウィンドウに、ログ メッセージ shot fired が表示されます。

    A screenshot of the Unreal Engine Log window showing 'shot fired' events and the Categories dropdown with LogLyra selected.

    イベントはログの一番下に表示されるため、表示するには下にスクロールする必要がある場合があります。 [クリア] ボタンを選択してログをクリアし、再度起動してログ メッセージを表示することもできます。

フォントの色が読みにくい場合は、[ツール]>[オプション]>[環境]>[フォントと色] で調整できます。 [設定の表示:] ドロップダウンを [Unreal Engine ログ] に変更します。 [表示項目:] で、[ログ] を選択し、[項目の前景色] を見やすい色に変更します。

デバッグ中に UE ログ ウィンドウを開いたままにしておくと、それらを確認するために Unreal Editor に切り替える必要がないため、便利です。

Visual Studio で UE マクロを表示する

長い UE マクロは読みにくい場合があります。 Visual Studio Tools for Unreal Engine では、読みやすくするために UE マクロが展開されます。 必要に応じて、展開されたマクロをコピーできます。 それをオンラインで検索したり、別のマクロと比較したりすることもできます。 これらの機能を試すには、次の手順に従います。

  1. Visual Studio で LyraGameplayAbility_RangedWeapon.cpp を開きます。 ソリューション エクスプローラーの [検索] ペインでそのファイルを検索するか、[ゲーム]>[LyraStarterGame]>[ソース]>[LyraGame]>[Weapons]>[LyraGameplayAbility_RangedWeapon.cpp] でファイルを見つけます。

  2. LyraGameplayAbility_RangedWeapon.cpp の 41 行目に移動します。 次のマクロが表示されます。UE_DEFINE_GAMEPLAY_TAG_STATIC(TAG_WeaponFireBlocked, "Ability.Weapon.NoFiring");

  3. UE_DEFINE_GAMEPLAY_TAG_STATIC の上にマウス ポインターを置くと、マクロ定義ウィンドウが表示されます。A screenshot in Visual Studio of the UE macro tooltip. There are options at the bottom to copy, expand inline, visualize expansion, and search online. 下部には、マクロをクリップボードにコピーする、マクロをインラインで展開する、マクロの展開を視覚化する、マクロをオンラインで検索する、各オプションがあります。

  4. [インライン展開] を選択すると、マクロとすべての入れ子になったマクロがコード ウィンドウに展開されます。 A screenshot of the expanded contents of the UE_DEFINE_GAMEPLAY_TAG_STATIC macro. 展開を元に戻すには、Ctrl+z キーを押します。

  5. [オンライン検索] を選択すると、ブラウザーが開きます。 マクロを見つけるための検索が入力された状態で開きます。 前の例では、C++ #define UE_DEFINE_GAMEPLAY_TAG_STATIC(TagName, Tag) static FNativeGameplayTag TagName(UE_PLUGIN_NAME, UE_MODULE_NAME, … を検索するためのブラウザーが開きます。

  6. [展開の視覚化] を選択すると、[マクロ展開] ウィンドウが開きます。 大きなマクロの一部である入れ子になったマクロは、一度に 1 ステップずつ展開できます。 展開の最後までスクロールすると、ウィンドウの右上隅にマクロ展開矢印が表示されます。 右矢印を選択すると、次の入れ子になったマクロが展開されます。 左矢印を選択すると、展開された最後の入れ子になったマクロが折りたたまれます。

    A screenshot of the macro expansion window showing the expanded contents of the UE_DEFINE_GAMEPLAY_TAG_STATIC macro.

このクイック スタートでは、Visual Studio Tools for Unreal Engine を使用して、UE マクロの理解、UE ログの表示、UE ブループリントの表示を容易にする方法について説明しました。 UE 開発作業がより生産的で楽しいものになることを願っています。

次のステップ

Visual Studio Tools for Unreal Engine の機能の概要については、「Visual Studio Tools for Unreal Engine」を参照してください。