同期フィルタ

このドキュメントでは、UnrealGameSync (UGS) の同期フィルタの設定方法について説明します。

同期フィルタ を使用すると、デベロッパーは、UnrealGameSync (UGS) でカスタマイズできる構文でクライアント ワークスペースを更新することができます。UGS 用の同期フィルタの設定方法に詳細については、このドキュメントで説明します。

ユーザー インターフェース

[Sync Filter (同期フィルタ)] メニューにアクセスするには、UGS のメイン ウィンドウの右下にある [Options (オプション)] ドロップダウンをクリックして、[Sync Filter...(同期フィルタ...)] をクリックします。

UGS Sync Filters UI

この UI には、次を含む複数のオプションがあります。各オプションをご確認ください。

UGS Sync Filters UI Options

要素

名前

説明

1

Global Workspace Tab (グローバル ワークスペース)] タブ

この設定はすべてのワークスペースに適用されます。ただし、特定のワークスペースが競合し、その特定のワークスペースが優先される場合は適用されません。

2

Current Workspace Tab (現在のワークスペース)] タブ

この設定はグローバル設定と連動しています。競合する設定がある場合は、グローバル設定をオーバーライドします。

3

General Settings(全般)]

[Sync all projects in stream (ストリーム内のすべてのプロジェクトを同期する)] では、ストリームのコンテンツ全体を同期し、[Include all synced projects in solution (ソリューションにすべての同期されたプロジェクトを含める)] では、UGS でこのワークスペース向けのソリューションを生成するときに、同期されたすべてのプロジェクト (およびソリューション) が含まれます。

4

同期カテゴリのホワイトリスト

このリストでオンになっているカテゴリはすべて同期され、オフになっているカテゴリは同期の対象になりません。例えば、[Platform Support:PS4 (プラットフォーム サポート: PS4)] をオンにすると、UGS では PS4 プラットフォームのファイルを同期し、[Platform Support:XboxOne (プラットフォーム サポート: XboxOne)] をオフにすると、XboxOne プラットフォームのファイルは同期されません。

5

カスタム同期フィルタ

上記の構文、または [Syntax (構文)] ボタンの後ろのモーダル ダイアログに記載されている構文を使用して、このセクションで 1 行ずつカスタム フィルタを追加できます。

6

組み合わせたフィルタの表示]

このボタンをクリックすると、カスタム フィルタ、ホワイトリストされたフィルタ、デフォルトの除外フィルタ (カテゴリでオフになっている)、全般設定を含む、作成したすべてのフィルタの概要が表示されます。フィルタ リストの内容を正確に確認したい場合は、このボタンを使用してください。

カスタム フィルタ構文

UnrealGameSync.ini を直接編集する場合でも、UGS UI を使用する場合でも、カスタム同期フィルタを追加する際に注意する必要のある構文がいくつかあります。

Perforce スタイルのワイルドカード (1 行に 1 つ) を使用して、ストリームのカスタム ビューを指定します。

  • デフォルトではすべてのファイルが表示されます

  • パターンに一致するファイルを除外するには、そのファイルの前に '-' 文字を付けます (例: -/Engine/Documentation/...)。

  • パターンは任意のファイルの一部 (例: *.pdb) に一致する場合があります。または、ブランチにルート指定されている場合があります (例: /Engine/Binaries/.../*.pdb)

現在のワークスペースのビューは、すべてのワークスペースで共有されるビューに追加されます。

これらの構文ルールは、このページにその都度アクセスしなくても済むように、UGS UI 内でも表示されます。

UGS Sync Filters Syntax Rules

UnrealGameSync.ini

[Unreal Project Root Directory]\Build\UnrealGameSync.ini (そして Perforce にサブミットされる) にあり、Perforce に送信されるプロジェクト固有の`UnrealGameSync.ini` の作成と編集に関する入門ガイドについては、「Customizing for Your Project (プロジェクトをカスタマイズする)」を参照してください。

追加のリファレンス情報

いくつかのリファレンス項目には、次の追加が含まれています。

Sync ステップ

Sync (同期) ステップは、その後のコンパイル ステップの有無にかかわらず、同期操作の後に実行されます。これにより、カスタム バージョン ファイルの同期された変更リスト情報を更新することです。 

[Sync]
+Step=(FileName="$(ProjectDir)\\Path\\To\\SyncStep.bat", Arguments="/arg1")

Build ステップ

[Build]
+Step=(UniqueId="d9610e2f-7f6f-4898-bc98-d39dd7053d75", Description="Launch Game", StatusText="Launching Game...", EstimatedDuration="5", Type="Other", FileName="$(ProjectDir)\\Build\\BatchFiles\\Launch.bat", Arguments="", bUseLogWindow="False", OrderIndex="5", bNormalSync="False", bScheduledSync="False", bShowAsTool="True")

Build (ビルド) または Sync (同期) ステップを追加する際は、次の属性を上記の構文と併用できます。

属性

説明

UniqueId

ランダムに生成された GUID です。

OrderIndex

ステップ リストの順序でこのステップの位置を決定する昇順の値です。

Description

UGS UI で表示されます。

StatusText

このステップが実行されているときに表示されます。

EstimatedDuration

ステップの持続時間 (分単位) で表したもので、UGS UI の進捗バーを正しい分量だけ進めるために使用されます。

Type

Buid (ビルド) ステップが作成されると、そのステップには "Compile (コンパイル)" (デフォルト)、"Cook (クック)"、または "Other (その他)" のタイプが設定されます。このタイプは、どの属性を活用できるかを決定するために使用されます。詳細は後述の タイプ を参照してください。

bNormalSync

ステップを通常の (ユーザーが開始する) 同期ごとに実行するかどうかを決定するフラグを設定します。

bScheduledSync

スケジューリングされた同期ごとにステップを実行するかどうかを決定するフラグを設定します。

bShowAsTool

UGS のステータス パネルの [More Tools (その他のツール)] メニューでステップをツールとして表示するかどうかを決定するフラグを設定します。

タイプ

属性

説明

Type - Compile

  • Target は、コンパイル ステップのターゲットの名前です (例: "BlankGame")。

  • Platform は、コンパイル ステップが対象とするプラットフォームです (例: "Win64 "、"Linux")。

  • Configuration は、コンパイル ステップのコンフィギュレーションです (例: "Debug"、"Shipping")。

  • Arguments は、実行されるファイルまたはプロセスに渡す引数です。

Type - Cook

  • FileName は、このステップで実行するファイルのファイル名を含むパスです。

Type - Other

  • WorkingDir は、ファイルが実行されるディレクトリです。

  • bUseLogWindow は、ステップをレポートするときにログ ウィンドウを使用するかどうかを切り替えます。

  • Arguments と FileName は、Type - Cookで説明した属性と同じです。

安全に削除できるフォルダ

これらは、UGS で "Clean Workspace (クリーン ワークスペース) ツールを実行するときにデフォルトで確認される安全なパスです。 

[Default]
+SafeToDeleteFolders=FolderName
+SafeToDeleteFolders=Path/To/FolderName

Zip 圧縮されたバイナリの同期フィルタ

これらはプリコンパイルされたバイナリを使用している場合、同期から除外される必要のあるファイルです。 

[//UE4/Main/Samples/Games/ShooterGame/ShooterGame.uproject]
ZippedBinariesPath=//UE4/Dev-Binaries/++UE4+Main-Editor.zip
ZippedBinariesSyncFilter=-/FolderToFilter/...

UGS UI のカスタム フィルタと同じ構文を使用します。

Unreal Engine のドキュメントを改善するために協力をお願いします！どのような改善を望んでいるかご意見をお聞かせください。
調査に参加する
キャンセル