Unreal Editor　でソースコントロールを使用する | Unreal Engine 5.3 ドキュメンテーション

UE 内からソフトウェアとインターフェースする方法は、どのソースコントロールソフトウェアでも同じです。以下では、UE 内でのソースコントロールの使用について知っておくべきことを詳しく説明します。

Unreal Editor 内でのコラボレーションワークフロー

Unreal Engine では、プロジェクトで複数ユーザーが非常に簡単にコラボレーションできます。以下のセクションでは、Unreal Editor 内で様々なコラボレーションツールがどのように機能するかについて説明します。

Unreal Editor でファイルをチェックアウトする

共同作業者とコンテンツを共有する主な方法は、コンテンツブラウザを使用するやり方です。すべてのソースコントロール操作はファイルやフォルダのコンテキストメニューから利用できます。例えば、ファイルを チェックアウト (すなわち編集のためにロック) するには、コンテンツブラウザ でアセット上で 右クリック し、チェックアウト オプションを選択します。

保存時にファイルを自動的にチェックアウトするようにエディタを設定できます。これは、[Prompt for Checkout on Asset Modification (アセット変更時にチェックアウトするかを確認する)] を有効にして行います。以下の順序、Editor Preferences -> Loading & Saving -> Source Control に従いこうしたオプションを利用できます。

エディタ内で初めてファイルを保存したときにそれを自動的にソースコントロールに追加するように Unreal Editor を設定することもできます。以下の順序、 [Editor Preferences] -> [Loading & Saving] -> [Source Control] に従いこうしたオプションを利用できます。これを行うには、デフォルトでオンになっている [Add New Files when Modified (変更時に新しいファイルを追加)] オプションを有効にするだけです。アセットの編集を開始するとファイルのチェックアウトを求める通知が画面の右下隅に提示されます

これで編集前にアセットをチェックアウトできるようになります。[Check Out (チェックアウト)] をクリックすると、次のダイアログが表示されます。

番号	プロパティ名前	説明
1:	Check Out Selected	リストにチェックインされたファイルをチェックアウトします。
2:	Make Writable	リードオンリーフラグ (存在する場合) をクリアし、ローカルでファイル編集をできるようにします。
3:	Ask Me Later	作業を続けて、後でファイルをチェックアウトするようにできます。

コンテンツブラウザ でオブジェクトを 右クリック し、ソースコントロール オプションに進むと現在のアセットの状態を示す様々な記号が表示されているのがわかります。

アイコン	説明
	リストにチェックインされているファイルをチェックアウトします。
	ソースコントロールへの追加のマーク付けがされました。
	ソースコントロールにファイルの新しいバージョンがあります。
	ファイルはソースコントロール下にはありません。
	別のユーザーがチェックアウトしています (アセット上にマウスをかざすと誰がファイルをチェックアウトしたかがわかります)。
	ファイルはブランチ/コピーのためにチェックアウトされています (ファイルが別の場所からコピーされている場合、複数のプロバイダが表示されます)。

ソースコントロールにサブミットする

ソースコントロールに何もサブミットしないと作業内容、成果物が他のユーザーから見えないため、 UE 内のソースコントロールへのサブミットはソースコントロールプロセスの重要な部分です。多くの変更を伴う作業をする場合、または加えた変更を詳しくは追跡しない場合、以下のワークフローが便利です。エディタの [ファイル] メニューから [Submit to Source Control (ソースコントロールにサブミット)] オプションを選択します。

これで、アセットに加えられたサブミット可能な変更があるかについてプロジェクトとエンジンがスキャンされ、続いて Submit Files ダイアログが表示されます。

変更内容を入力し、OK をクリックします。次にソースコントロールにファイルをコミット/サブミットします。

ファイルを同期する

他の人が加えた変更を取得したい場合、コンテンツブラウザ 内のファイルまたはフォルダを 右クリック して [Sync] オプションを選択します。または、Perforce (P4V) などの外部プログラムを使用して Sync することもできます。しかし、これを行う場合はエディタをシャットダウンすることをお勧めします。開いていると編集できないようにファイルをロックする場合があるからです。

ファイルが Out of Sync (同期していない) (すなわち、ローカルにあるものよりも新しいバージョンがソースコントロールサーバーにある) の場合、アイコンが コンテンツブラウザ のアセットによって表示されます。

ファイルを追加する

チェックアウトのワークフローと同様に、[preferences] にある [Add New Files When Modified (変更があったら新規ファイルを追加)] オプションを使用して新規ファイルをソースコントロールに自動的に追加することができます。

追加されたファイルは記号が付けられて コンテンツブラウザ に表示されます。また、ファイルがチェックアウトされるのと同様にチェックインされます。

ファイルを削除する

既にソースコントロールにあるアセットを削除するのは手間がかかります。通常、他のアセットから参照されているからです。 コンテンツブラウザ でファイルを選択し、[Delete (削除)] (または 右クリック メニューから選択したら)、[Delete Assets] ダイアログが表示されます。

番号	名前	説明
1	Pending Deleted Assets	これは削除しようとしているアセットです。
2	Assets Referencing the Pending Deleted Assets	削除しようとしているアセットを参照しているアセットが表示されます。
3	Replace References	このアセットが削除されたらそれを参照する他のアセットにどのアセットを参照してほしいかを指定します。
4	Force Delete	ここでは、アセットの削除を強制できます。しかし、プロジェクトに非常にネガティブな影響を及ぼすおそれがあるため、強制的な削除を行う場合は注意を払ってください。他のものが何も機能しない場合の最終手段に限り、このオプションを使用するようにしてください。
5	Cancel	削除操作を取り消します。

削除の処理方法を選択したら、ファイルはリダイレクタという非表示の アセット で置き換えられます。アセット削除時に作成されるリダイレクタをクリーンアップしたい場合は、 コンテンツブラウザ にある フォルダ 上で右クリックし、[Fix Up Redirectors in Folders] を選択します。これでプロジェクト内の参照が修正され、リダイレクタを永久に削除し、ソースコントロールで削除のためにファイルをマーク付けします。現在、こうした削除をコミットするには、P4V または TortoiseSVN などの外部ツールを使用する必要があります。

レベルのファイル

レベルは他のアセットのように コンテンツブラウザ を介してソースコントロールで管理することができます。しかし、レベルは レベルブラウザ のメニューを介して作業することもできます。これには、ソースコントロール のサブメニューにあるソースコントロールのオプションも含まれます。

Config (.ini) ファイル

エディタとプロジェクトの多くのコンフィギュレーションオプションはコンフィギュレーションファイル、短縮すると config ファイルに格納されています。こうしたファイルの一部はソースコントロール下で維持する必要があります (ソースコントロールに Config/ ディレクトリを追加する場合は上記を参照)。エディタにある設定には、チームのメンバーが様々な設定を共有できるように、これらをチェックイン、チェックアウトする方法があります。例えば、[Edit] -> [Project Settings] では、以下のインジケータがあります。

ファイルをチェックアウトすると、こうした設定を編集できます。残念ながら現時点ではこうしたファイルをエディタからソースコントロールに戻してチェックインする方法はありません。そのため、 P4V や TortoiseSVN などの外部ツールを使用して Unreal Editor セッション外にこうしたファイルをチェックインする必要があります。

Unreal Editor 内でのコラボレーション ワークフロー