1. Epic GamesDeveloper
  3. UEditorValidatorSubsystem

UEditorValidatorSubsystem

[UEditorValidatorSubsystem](API\Plugins\DataValidation\UEditorValidatorSubsystem) manages all the asset validation in the engine.

API > API/Plugins > API/Plugins/DataValidation

Inheritance Hierarchy

References

   
Module DataValidation
Header /Engine/Plugins/Editor/DataValidation/Source/DataValidation/Public/EditorValidatorSubsystem.h
Include #include "EditorValidatorSubsystem.h"

Syntax

UCLASS (Config=Editor)  
class UEditorValidatorSubsystem : public UEditorSubsystem

Remarks

UEditorValidatorSubsystem manages all the asset validation in the engine.

The first validation handled is UObject::IsDataValid and its overridden functions. Those validations require custom classes and are most suited to project-specific classes.

The next validation set is of all registered UEditorValidationBases. These validators have a function to determine if they can validate a given asset, and if they are currently enabled. They are good candidates for validating engine classes or very specific project logic.

Finally, this subsystem may be subclassed to change the overally behavior of validation in your project. If a subclass exist in your project module, it will supercede the engine validation subsystem.

Variables

  Type Name Description
Protected variable UProperty Config bool bAllowBlueprintValidators Specifies whether or not to allow Blueprint validators
Protected variable bool bNeedLoadingOfValidators  
Protected variable UProperty Meta Config bool bValidateOnSave Whether it should validate assets on save inside the editor
Protected variable UProperty Config TArray< FDirectoryPath > ExcludedDirectories Directories to ignore for data validation. Useful for test assets
Protected variable TArray< FName > SavedPackagesToValidate List of saved package names to validate next frame
Protected variable UProperty Transient TMap< FTopLevelAssetPath, TObjectPtr< UEditorValidatorBase > > Validators  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function void

AddValidator ( const FAssetData& InValidatorAssetData
)

 Adds a validator to the list making sure it is a unique instance, but wait for the first use to load the assets.
Public function UFunction BlueprintCallable, Category void Adds a validator to the list, making sure it is a unique instance
Protected function void  
Public function Virtual void  
Public function Const void Iterate the enabled set of validators. Return true to continue iteration, or false to stop.
Public function Virtual Const void

GatherAssetsToValidateFromChangelist ( UDataValidationChangelist* InChangelist,
const FValidateAssetsSettings& Settings,
TSet< FAssetData >& OutAssets,
FDataValidationContext& InContext
)

 From a changelist, return a list of assets to validate.
Public function TArray< FAssetData >

GetAssetsResolvingRedirectors ( FARFilter& InFilter
)

 Retrieve all assets matching the given filter from the asset registry and then recursively resolve redirectors to produce a single set of assets.
Public function Virtual void

Initialize ( FSubsystemCollectionBase& Collection
)

  
Public function Virtual Const UFunction BlueprintCallable, Category EDataValidationResult

IsAssetValid ( const FAssetData& AssetData,
TArray< FText >& ValidationErrors,
TArray< FText >& ValidationWarnings,
const EDataValidationUsecase InValidationUsecase
)

 Loads the object referred to by the provided AssetData and runs registered validators on it.
Public function Virtual Const EDataValidationResult

IsAssetValidWithContext ( const FAssetData& AssetData,
FDataValidationContext& InContext
)

 Loads the object referred to by the provided AssetData and runs registered validators on it.
Public function Virtual Const UFunction BlueprintCallable, Category EDataValidationResult

IsObjectValid ( UObject* InObject,
TArray< FText >& ValidationErrors,
TArray< FText >& ValidationWarnings,
const EDataValidationUsecase InValidationUsecase
)

 Runs registered validators on the provided object. Does not add anything to any FMessageLog tabs.
Public function Virtual Const EDataValidationResult

IsObjectValidWithContext ( UObject* InObject,
FDataValidationContext& InContext
)

 Runs registered validators on the provided object. Does not add anything to any FMessageLog tabs.
Protected function Virtual Const bool

IsPathExcludedFromValidation ( FStringView Path
)

  
Protected function Const void  
Protected function void  
Protected function Const void

LogAssetValidationSummary ( FMessageLog& DataValidationLog,
const FValidateAssetsSettings& InSettings,
EDataValidationResult Result,
const FValidateAssetsResults& Results
)

  
Protected function void  
Public function UFunction BlueprintCallable, Category void Removes a validator Should be called during module shutdown if a validator was added.
Public function Virtual Const bool

ShouldCreateSubsystem ( UObject* Outer
)

  
Public function Virtual Const bool

ShouldValidateAsset ( const FAssetData& Asset,
const FValidateAssetsSettings& Settings,
FDataValidationContext& InContext
)

 Returns true if the given asset should be validated at all.
Protected function void Handles validating all pending save packages
Protected function Const EDataValidationResult

ValidateAssetsInternal ( FMessageLog& DataValidationLog,
TSet< FAssetData > Assets,
const FValidateAssetsSettings& InSettings,
FValidateAssetsResults& OutResults
)

 Validate a set of assets, adding the results to the log/output of a higher level task (e.g. changelist validation).
Public function Virtual Const UFunction BlueprintCallable, Category int32

ValidateAssetsWithSettings ( const TArray< FAssetData >& AssetDataList,
const FValidateAssetsSettings& InSettings,
FValidateAssetsResults& OutResults
)

 Called to validate assets from either the UI or a commandlet.
Public function Virtual Const UFunction BlueprintCallable, Category EDataValidationResult Called to validate assets from either the UI or a commandlet.
Protected function Const void

ValidateChangelistPreSubmit ( FSourceControlChangelistPtr Changelist,
EDataValidationResult& OutResult,
TArray< FText >& ValidationErrors,
TArray< FText >& ValidationWarnings
)

 Validates changelist before SCC submit operation
Public function Virtual Const UFunction BlueprintCallable, Category EDataValidationResult

ValidateChangelists ( const TArray< UDataValidationChangelist* > InChangelists,
const FValidateAssetsSettings& InSettings,
FValidateAssetsResults& OutResults
)

  
Protected function Const EDataValidationResult

ValidateChangelistsInternal ( TConstArrayView< UDataValidationChangelist* > InChangelists,
const FValidateAssetsSettings& InSettings,
FValidateAssetsResults& OutResults
)

  
Protected function Const EDataValidationResult

ValidateObjectInternal ( const FAssetData& InAssetData,
UObject* InObject,
FDataValidationContext& InContext
)

  
Public function Virtual Const void

ValidateOnSave ( TArray< FAssetData > AssetDataList,
bool bProceduralSave
)

 Called to validate from an interactive save
Public function Virtual void

ValidateSavedPackage ( FName PackageName,
bool bProceduralSave
)

 Schedule a validation of a saved package, this will activate next frame by default so it can combine them
Protected function Const void

WaitForAssetCompilationIfNecessary ( EDataValidationUsecase InUsecase,
bool bShowProgress
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page