Unreal Engine でゲームコードを管理する | Unreal Engine 5.3 ドキュメンテーション

Windows

macOS

Linux

ユーザープロジェクトファイル

Unreal Engine (UE) では、プロジェクトを「ネイティブ」および「外部」という 2 つのタイプで認識します。

ネイティブプロジェクト

ネイティブプロジェクト とは、作成に使用したエンジンと同じルートディレクトリ内に存在するプロジェクトです。これらのプロジェクトのディレクトリ構造は結果的に次のようになります。


.
└── ROOT/
    ├── Engine/
    │   ├── Binaries/
    │   ├── Build/
    │   ├── Config/
    │   └── ...
    ├── PROJECT1/
    │   ├── Binaries/
    │   ├── Build/
    │   ├── Config/
    │   ├── ...
    │   └── PROJECT1.uproject
    ├── PROJECT2/
    │   ├── Binaries/
    │   ├── Build/
    │   ├── Config/
    │   ├── ...
    │   └── PROJECT2.uproject
    ├── ...
    ├── Default.uprojectdirs
    ├── GenerateProjectFiles.bat
    └── ...

この構造に含まれる PROJECT1 と PROJECT2 はいずれもネイティブプロジェクトです。このディレクトリ構造を持つプロジェクトでは、使用するエディタを定義するための追加設定は必要ありません。これらのプロジェクトでは、ルートディレクトリ内にビルドされているエディタが自動的に検出されます。これは、UE のソースビルドまたはバイナリビルドのいずれを使用していても同じです。

プロジェクトは、ルートフォルダ、または Default.uprojectdirs で定義されたサブフォルダ (ROOT/Games など) のいずれかに保存できます。.uprojectdirs ファイルは、ROOT のサブディレクトリ内にあるプロジェクトを発見するようエンジンに指示を出すヘルパーファイルです。同じ ROOT ディレクトリ内には複数の .uprojectdirs ファイルを含めることができます。これらのファイル名を Default.uprojectdirs にする必要はありません。ファイルの拡張子が .uprojectdirs であれば、自由に名前を付けることができます。

外部プロジェクト

外部プロジェクト とは、エンジンのディレクトリと同じルートディレクトリ以外の場所にプロジェクトディレクトリを持つプロジェクトです。構造の例としては次のようになります。


├── UE/
│   ├── Engine/
│   │   ├── Binaries
│   │   ├── Build
│   │   ├── Config
│   │   └── ...
│   ├── ...
│   ├── Default.uprojectdirs
│   ├── GenerateProjectFiles.bat
│   └── ...
├── PROJECT1/
│   ├── Binaries
│   ├── Build
│   ├── Config
│   ├── ...
│   └── PROJECT1.uproject
├── PROJECT2/
│   ├── Binaries
│   ├── Build
│   ├── Config
│   ├── ...
│   └── PROJECT2.uproject
└── ...

ランチャー (バイナリ) ビルドから外部プロジェクトを作成した場合は、その .uproject ファイル内の EngineAssociation フィールドが、その作成に使用したランチャーエンジンのバージョン番号に設定されます。Unreal Editor のソースビルドバージョンからプロジェクトを作成した場合は、そのエディタの グローバル一意識別子 (GUID) が使用されます。この GUID は、ソースビルドエディタを初めて起動した際に自動的に生成され、コンピュータに保存されます。これが保存される場所はオペレーティングシステムによって異なります。

Windows：
- Registry: Computer\HKEY_CURRENT_USER\SOFTWARE\Epic Games\Unreal Engine\Builds
Mac：
- File: ~Library/Application Support/Epic/UnrealEngine/Install.ini
Linux：
- File: ` ~/.config/Epic/UnrealEngine/Install.ini`

たとえば、PROJECT1 を Unreal Editor のソースビルドバージョンから作成した場合、その「PROJECT1.uproject」ファイルは次のような構造になります。


{
	"FileVersion": 3,
	"EngineAssociation": "{5FFE8984-EA6F-49EC-859E-6CB8C10FE54D}",
	"Category": "",
	"Description": "",
	"Modules": [
		...
	],
	"Plugins": [
		...
	],
	"TargetPlatforms": [
		...
	]
}

5FFE8984-EA6F-49EC-859E-6CB8C10FE54D は、プロジェクトの作成に使用した Unreal Editor のソースビルドバージョンに関連付けられた GUID です。それとは対照的に、PROJECT2 が Unreal Editor の UE 5.1 ランチャーバージョンで作成された場合、その「PROJECT2.uproject」ファイルは次のようになります。


{
	"FileVersion": 3,
	"EngineAssociation": "5.1",
	"Category": "",
	"Description": "",
	"Modules": [
		...
	],
	"Plugins": [
		...
	],
	"TargetPlatforms": [
		...
	]
}

プロジェクトの Unreal Engine バージョンを変更する

プロジェクトを開く際に使用する Unreal Engine のバージョンを変更できます。変更するには、プロジェクトの .uproject ファイルを右クリックして [Switch Unreal Engine version... (Unreal Engine のバージョンを切り替え...)] を選択します。これにより、このプロジェクトを開く UE バージョンを選択できるドロップダウンメニューを備えたダイアログボックスが表示されます。このダイアログボックスを最初に開いた際は、このプロジェクトを開くように設定された現在の Unreal Engine バージョンが表示されます。このドロップダウンメニューに含まれる各ランチャービルドはそのバージョン番号 (4.27 または 5.0 など) で識別され、各ソースビルドは バイナリビルド または ソースビルド として識別されて、その後にビルドのディレクトリが続きます。このディレクトリは、.uproject ファイルの EngineAssociation フィールドと関連付けれられた GUID キーに関連する値です。エンジンバージョンを切り替えるには、ドロップダウンメニューから希望の Unreal Engine バージョンを選択します。システムにより、この変更を実装するためにプロジェクトファイルが再生成されます。

コードをプロジェクトに追加する

C++ クラスウィザード

[C++ Class Wizard (C++ クラスウィザード)] では、独自の機能で拡張するために、ネイティブ C++ コードクラスを高速かつ簡単に追加することができます。これにより、コンテンツのみのプロジェクトをコードプロジェクトへ変換することができます。次の手順に従って C++ クラスウィザードにアクセスし、新規 C++ クラスを作成できます。

「Visual Studio をセットアップする」を参照し、互換性のあるバージョンの Visual Studio がインストールされていることを確認してから作業を始めてください。Xcode の正しいバージョンについては、Unreal Engine リリースノートを参照してください。

メインエディタで、[Tools (ツール)] > [New C++ Class... (新規 C++ クラス...)] の順に選択します。
[C++ Class Wizard]に [Common Classes (よく使うクラス)] クラス がデフォルトで表示されます。探しているクラスが見つからない場合、[All Classes (すべてのクラス)] を選択することで、クラスの階層リスト全体を表示できます。

よく使うクラスすべてのクラス
追加するクラスを選択します。このデモでは、新しい Actor クラスを作成するために選択します。Actor クラスを選択し、[Next > (次へ)] をクリックします。
新しいクラスの名前の入力を求められます。名前を入力して [Create Class] をクリックします。ヘッダファイル (.h) とソース (.cpp) ファイルが作成されました。

クラス名には英数字のみを使用してください。スペースを含むことはできません。無効な名前を入力すると、通知が表示されます。
Unreal Engine は、Live Coding はデフォルトで有効になっています。[Live Coding] ウィンドウが開き、作成された新しいクラスファイルをコンパイルします。
Visual Studio で直接コードが開いて編集が可能となります。

Xcode で直接コードが開いて編集が可能となります。


よく使うクラス	すべてのクラス

開発環境

コードファイルを Visual Studio で作成し、ソリューションエクスプローラー を介してこれを従来の方法でゲームプロジェクトに追加できます。また、コードファイルを Visual Studio 以外の適切なフォルダに追加して、そのソリューションファイルとプロジェクトファイルを自動的に再ビルドすることもできます。これにより、オペレーティングシステム UI を介して大量のファイルをすばやく追加しやすくなるだけでなく、ソリューションファイルとプロジェクトファイルをチームメンバー間で同期する必要がなくなるため、チームによる共同作業がより容易になります。それぞれのメンバーは、コードファイルを同期してプロジェクトファイルをローカルで再ビルドするだけで済みます。

コードファイルを Xcode で作成し、Project Navigator (プロジェクトナビゲータ) を介してこれを従来の方法でゲームプロジェクトに追加できます。また、コードファイルを Xcode 以外の適切なフォルダに追加して、そのプロジェクトファイルを自動的に再ビルドすることもできます。これにより、オペレーティングシステム UI を介して大量のファイルをすばやく追加しやすくなるだけでなく、ソリューションファイルとプロジェクトファイルをチームメンバー間で同期する必要がなくなるため、チームによる共同作業がより容易になります。それぞれのメンバーは、コードファイルを同期してプロジェクトファイルをローカルで再ビルドするだけで済みます。

プロジェクトを開発環境で開く

プロジェクトをすでに Unreal Editor で開いている場合は、[Tools (ツール)] メニューの [Open Visual Studio (Visual Studio を開く)] を選択することで、プロジェクトを簡単に Visual Studio で開くことができます。

また、Windows エクスプローラーか、Visual Studio の [File (ファイル)] > [Open (開く)] > [Project/Solution (プロジェクト/ソリューション)] を使ってプロジェクトを Visual Studio で開くこともできます。

プロジェクトが UE ルートディレクトリ内にある場合：

* UE ルートディレクトリ内にある「UE5.sln」 Visual Studio ソリューションを開きます。

プロジェクトが UE ルートディレクトリ外にある場合：

* プロジェクトディレクトリのルートにある「PROJECT_NAME.sln」 Visual Studio ソリューションを開きます。

プロジェクトをすでにエディタで開いている場合は、[File (ファイル)] メニューの [Open in Xcode (Xcode で開く)] を選択することで、プロジェクトを簡単に Xcode で開くことができます。

また、Finder か、Xcode の [File] > [Open] を使ってプロジェクトを Xcode で開くこともできます。

* プロジェクトディレクトリのルートにある「PROJECT_NAME.xcodeproj」 Xcode プロジェクトを開きます。

プロジェクトファイルを生成する

プロジェクトファイルは「中間ファイル」として扱われ、「PROJECT_DIRECTORY\Intermediate\ProjectFiles」に保存されます。つまり、「Intermediate」フォルダを削除した場合は、プロジェクトファイルを再生成する必要があることを意味しています。

.uproject ファイル

プロジェクトが UE ルートディレクトリ外にある場合：

1.Windows エクスプローラーで「PROJECT_NAME.uproject」の場所まで移動します。

1.「PROJECT_NAME.uproject」を一度 左クリック して、これを選択している状態にします。「PROJECT_NAME.uproject」を 右クリック して [Generate Visual Studio Files (Visual Studio ファイルを生成)] を選択します。