Unreal Engine 5 ドキュメントは Epic Developer Community に移動しました

エディタの機能である Data Validation プラグインを利用すると、デベロッパーがカスタム スクリプト ルールセットでアセットを検証できます。検証の一般的な使用例を以下に示します。

• アセットが命名規則を満たしていることを確かめるチェック

• 許容するスペースとパフォーマンスの適用

• 非循環依存のキャッチなど

プラグインで検証する

デフォルトで有効化されているビルトイン Data Validation プラグインを確認するには、メインメニューから [Edit (編集)] > [Plugins (プラグイン)] を選択して [Plugins (プラグイン)] メニューで「Data Validation」を検索します。

エディタを使用する

単一のアセットのテストからプロジェクトが含む全アセットの検証まで、デベロッパーはデータ検証システムをさまざまな方法で使用できます。

コマンド ラインを使用する

デベロッパーがコマンド ラインでプラグインを実行すると、継続的インテグレーション システム (CIS) の一部としてアセットを検証できます。次のコマンドレットでコマンド ライン検証を実行します。

UE4Editor-Cmd.exe <ProjectName>.uproject -run=DataValidation

検証ルール

現在、検証ルールを作成する方法は 2 つあります。

• IsDataValid をオーバーライドする、カスタム UObject の派生クラスを用意します。これはプロジェクトのカスタム クラスに最適です。
  

  • このメソッドを使用すると、 UEditorValidatorBase メソッドではアクセスできない Private/Protected のクラス データとクラス関数にアクセスできます。

  • ここでは独自のクラスを実装しているので、 IsDataValid が呼び出すように BlueprintImplementableEvent を設定することもできます。これにより C++ の検証ロジックに加えて、ブループリントや Python の検証ロジックを使用できます。

• C++、ブループリント、Python を使用して UEditorValidatorBase 派生クラスを作成します。ここで重要な 2 つの関数は CanValidateAsset と ValidateLoadedAsset で、どちらも引数として検証対象の UObject ポインタを取ります。このシステムは、デフォルトのエンジン クラスとカスタム クラスに基づくアセットを、両方とも検証できます。

  • ValidateLoadedAsset は実行パスごとに AssetPasses や AssetFails を呼び出す必要があります。

  • バリデータは IsEnabled をオーバーライドして有効化できます。これはデフォルトで Protected の変数 bIsEnabled を返し、詳細パネルにも公開します。

  • C++ とブループリントのバリデータはエディタの起動時に自動で検出されますが、Python のバリデータは AddValidator を使用して UEditorValidatorSubsystem に登録する必要があります。

    • デフォルトでは、ブループリント バリデータの自動登録はパフォーマンス上の理由により Fortnite では無効になっています。

どちらのタイプの検証も、CIS からアセットの保存時に (デフォルトで有効)、そしてエディタとコンテンツ ブラウザのメニュー オプションで実行されます。検証に失敗すると、エディタのメッセージ ログと CIS のコンソールにメッセージが表示されます。

UEditorValidatorSubsystem の呼び出しを実装する場合は、 ValidationErrors FText 配列の表示を処理する必要があります。 FAssetData やロードした UObject のアセット検証に必要な関数は、スクリプトでも使用できます。