Visual Studio に Unreal Engine のクラス、モジュール、プラグインを追加する

この記事では、Visual Studio Tools for Unreal Engine を使用して次のことを行う方法について説明します。

• Visual Studio に Unreal Engine モジュールを追加する
• Visual Studio に Unreal Engine クラスを追加する
• Visual Studio に Unreal Engine プラグインを追加する

前提条件

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

• Visual Studio バージョン 17.11 (17.11 プレビュー バージョンでも可) 以降。
• Unreal Engine バージョン 5 以降。
• Visual Studio Tools for Unreal Engine。 インストールの手順については、「Visual Studio Tools for Unreal Engine のインストール」を参照してください。
• Lyra ゲームをダウンロードしてビルドし、Visual Studio Tools for Unreal Engine を使用するように構成するには、 クイックスタート: Visual Studio Tools for Unreal Engine を完了します。

Visual Studio に Unreal Engine モジュールを追加する

Visual Studio 内から Unreal Engine モジュール を Unreal Engine プロジェクトに追加できるようになりました。 モジュールを追加するために Unreal Engine エディターと Visual Studio を切り替える必要がなくなり、後で Visual Studio ソリューションを Unreal Engine プロジェクト ファイルと同期する必要がなくなりました。

モジュールは、Unreal Engine でコードを整理する方法です。 これらは、関連するクラスとアセットをグループ化し、実行時にロードおよびアンロードできる自己完結型のユニットにコードを整理するのに役立ちます。 モジュールを手動で作成する場合は、構成ファイルの編集と定型コードの追加が必要になるため、面倒でエラーが発生しやすくなります。 Visual Studio では、プロセスをガイドし、構成と定型文の追加を自動的に行うダイアログが提供されるため、モジュールの作成が容易になります。

Visual Studio に Unreal Engine モジュールを追加するには、 「クイックスタート: Visual Studio Tools for Unreal Engine」 を完了した後、次の手順に従って Lyra ゲームをダウンロードし、ビルドします。 これらの手順では、Visual Studio で LyraStarterGame.sln ソリューションが開いていることを前提としています。

1. Solution Explorer で、新しいモジュールを配置するプロジェクト (LyraStarterGameなど) を選択します。
2. プロジェクトを右クリックし（フォルダーではなくプロジェクトが選択されていることを確認してください）、 追加>Unreal Engine アイテム... を選択して、Unreal Engine アイテムの 新しいアイテムの追加 ダイアログを開きます:
3. Unreal Engine モジュール を選択し、 名前 フィールドにモジュール名を入力してから、 追加 を選択して Unreal Engine モジュールの追加 ダイアログを開きます。

   

   [Unreal Engine モジュールの追加] ダイアログには、モジュール名のフィールド、モジュール タイプ ([ランタイム] を選択) およびモジュール読み込みフェーズ ([デフォルト] を選択) のドロップダウンがあります。 モジュール パス、ヘッダー、ソース、ビルド ファイル パスがリストされます。 Unreal Editor ツールを使用して IntelliSense 情報を更新するチェックボックスがオンになっています。

4. ドロップダウンを使用して、 モジュール タイプ と モジュール読み込みフェーズを選択します。
5. [OK] を選択して、モジュールをプロジェクトに追加し、Visual Studio ソリューション ファイルを更新します。

モジュールは、 Source フォルダ内、または Plugins フォルダ内のプラグインのモジュールとしてのみ作成できます。
ビルド パスは、 Build.cs ファイルが作成される場所を示します。 Build.cs ファイルにはモジュールの構成情報が含まれています。

Visual Studio に Unreal Engine クラスを追加する

Visual Studio 内から Unreal Engine プロジェクトに Unreal Engine クラスを追加できるようになりました。 クラスを追加するために Unreal Editor と Visual Studio を切り替える必要がなくなり、後で Visual Studio ソリューションを Unreal Engine プロジェクト ファイルと同期する必要がなくなりました。

Visual Studio に Unreal Engine クラスを追加するには、 「クイックスタート: Unreal Engine 用 Visual Studio ツール」 を完了した後、次の手順に従って Lyra ゲームをダウンロードし、ビルドします。 この手順では、Visual Studio で LyraStarterGame.sln ソリューションが開いていることを前提としています。

1. Solution Explorer で、新しいクラスを配置するフォルダーを選択します。 たとえば、LyraStarterGame プロジェクトでは、 LyraStarterGame>Source フォルダーに新しいクラスを追加できます。
2. フォルダを右クリックし、 追加>Unreal Engine アイテム... を選択して、 新しいアイテムの追加 ダイアログを開きます。

   

   Unreal Engine 共通クラス (選択済み)、空の Unreal Engine モジュール、および Unreal Engine プラグインを追加するためのオプションがあります。

3. Unreal Engine 共通クラス、 追加 の順に選択して、 Unreal Engine クラスの追加 ダイアログを開きます。

   

   アクター、キャラクターなどのベースを選択するためのオプションが表示されます。 クラス名用のフィールドと、クラスを追加するモジュールのドロップダウンがあります。 ヘッダー ファイルとソース ファイルへのパスがリストされます。 Unreal Editor ツールを使用して IntelliSense 情報を更新するためのチェックボックスが選択されています。

4. クラス名を選択します。 名前が既存のクラスまたはファイルと競合する場合、Visual Studio によって警告が表示されます。
5. 基本クラスを選択します。 基本クラスを選択すると、そのクラス タイプに適切なヘッダーとマクロが含まれるようになります。
6. 「クラスに追加するモジュールを選択」 ドロップダウンを使用して、クラスに追加するモジュールを選択します。 モジュール名は、モジュールが含まれているフォルダーの名前です。
7. Visual Studio が Unreal Editor ツールを使用して IntelliSense 情報を更新するかどうかを選択するには、 Unreal Editor ツールを使用して IntelliSense 情報を更新する チェックボックスをオンにします。 これを選択すると、Unreal Build Tool によって Visual Studio ソリューション ファイルを再生成します。
8. [OK] を選択して、新しいクラスのヘッダー ファイルとソース ファイルを作成し、Visual Studio ソリューション ファイルに追加します。 これにより、プロジェクトを再ロードするように求めるプロンプトが表示されます。 プロジェクトを再ロードするには、 再ロード を選択します。

Visual Studio に Unreal Engine プラグインを追加する

Visual Studio 内から Unreal Engine プロジェクトに Unreal Engine プラグインを追加できるようになりました。 プラグインを追加するために Unreal Editor と Visual Studio を切り替える必要がなくなり、その後 Visual Studio ソリューションを Unreal Engine プロジェクト ファイルと同期する必要がなくなりました。

Visual Studio に Unreal Engine プラグインを追加するには、 「クイックスタート: Unreal Engine 用 Visual Studio ツール」 を完了した後、次の手順に従って Lyra ゲームをダウンロードし、ビルドします。 この手順では、Visual Studio で LyraStarterGame.sln ソリューションが開いていることを前提としています。

1. Solution Explorerで、新しいプラグインを配置するフォルダーを選択します。 たとえば、LyraStarterGame プロジェクトでは、 LyraStarterGame>Source フォルダーに新しいプラグインを追加できます。
2. フォルダを右クリックし、 追加>Unreal Engine アイテム... を選択して、 新しいアイテムの追加 ダイアログを開きます。

   

   Unreal Engine 共通クラス、空の Unreal Engine モジュール、および Unreal Engine プラグイン (選択済み) を追加するためのオプションがあります。

3. Unreal Engine プラグイン を選択し、 追加 を選択して、 Unreal Engine プラグインの追加 ダイアログを開きます。

   

   プラグインの種類のリスト (詳細が選択されています) と、プラグイン名、パス、作成者、説明、URL のフィールドがあります。 [プラグインはベータ版ですか?] チェックボックス (チェックなし) と [Unreal Editor ツールを使用して IntelliSense 情報を更新しますか?] チェックボックス (チェックあり) があります。

4. プラグイン タイプ リストからプラグインのタイプを選択します。
5. プラグイン名、 プラグイン作成者、 プラグインの説明、 プラグインの URLを入力します。
6. 必要に応じて、 プラグインはベータ版ですか ボックスをチェックしてください。
7. Visual Studio が Unreal Editor ツールを使用して IntelliSense 情報を更新するかどうかを選択するには、 [Unreal Editor ツールを使用して IntelliSense 情報を更新する] チェックボックスをオンにします。 これにより、Unreal Build Tool によって Visual Studio ソリューション ファイルが再生成されます。
8. 追加 を選択して、新しいプラグインのプラグイン ヘッダーとソース ファイルを生成し、Visual Studio ソリューション ファイルに追加します。 これにより、プロジェクトを再ロードするように求めるプロンプトが表示されます。 プロジェクトを再ロードするには、 再ロード を選択します。

関連するコンテンツ

Visual Studio Tools for Unreal Engine
Visual Studio で Unreal Engine ブループリントを表示する
Visual Studio で Unreal Engine のログを表示する
Visual Studio で Unreal Engine マクロを表示する