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

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.

   
Name UEditorValidatorSubsystem
Type class
Header File /Engine/Plugins/Editor/DataValidation/Source/DataValidation/Public/EditorValidatorSubsystem.h
Include Path #include "EditorValidatorSubsystem.h"

Syntax

UCLASS (MinimalAPI, Config=Editor)  
class UEditorValidatorSubsystem : public UEditorSubsystem

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UEditorValidatorSubsystem()

   EditorValidatorSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddValidator ( UEditorValidatorBase* InValidator
)

 Adds a validator to the list, making sure it is a unique instance EditorValidatorSubsystem.h
  • BlueprintCallable
  • Category="Validation"

virtual void Deinitialize()

   EditorValidatorSubsystem.h  

void ForEachEnabledValidator ( TFunctionRef< bool(UEditorValidatorBase*Validator)> Callback
) const

 Iterate the enabled set of validators. Return true to continue iteration, or false to stop. EditorValidatorSubsystem.h  

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

 From a changelist, return a list of assets to validate. EditorValidatorSubsystem.h  

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. EditorValidatorSubsystem.h  

virtual void Initialize ( FSubsystemCollectionBase& Collection
)

   EditorValidatorSubsystem.h  

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

 Loads the object referred to by the provided AssetData and runs registered validators on it. EditorValidatorSubsystem.h
  • BlueprintCallable
  • Category="Asset Validation"

virtual EDataValidationResult IsAssetValidWithContext ( const FAssetData& AssetData,
FDataValidationContext& InContext
) const

 Loads the object referred to by the provided AssetData and runs registered validators on it. EditorValidatorSubsystem.h  

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

 Runs registered validators on the provided object. EditorValidatorSubsystem.h
  • BlueprintCallable
  • Category="Asset Validation"
Runs registered validators on the provided object. EditorValidatorSubsystem.h  
Pop a previous request to temporarily disable "validate on save". EditorValidatorSubsystem.h  
Push a new request to temporarily disable "validate on save". EditorValidatorSubsystem.h  

void RemoveValidator ( UEditorValidatorBase* InValidator
)

 Removes a validator Should be called during module shutdown if a validator was added. EditorValidatorSubsystem.h
  • BlueprintCallable
  • Category="Validation"

virtual bool ShouldCreateSubsystem ( UObject* Outer
) const

   EditorValidatorSubsystem.h  

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

 Returns true if the given asset should be validated at all. EditorValidatorSubsystem.h  

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

 Called to validate assets from either the UI or a commandlet. EditorValidatorSubsystem.h
  • BlueprintCallable
  • Category="Asset Validation"
Called to validate assets from either the UI or a commandlet. EditorValidatorSubsystem.h
  • BlueprintCallable
  • Category="Asset Validation"

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

   EditorValidatorSubsystem.h
  • BlueprintCallable
  • Category="Asset Validation"

virtual void ValidateOnSave ( TArray< FAssetData > AssetDataList,
bool bProceduralSave
) const

 Called to validate from an interactive save EditorValidatorSubsystem.h  

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 EditorValidatorSubsystem.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AddValidator ( const FTopLevelAssetPath& InValidatorClass
)

 Adds a validator to the list making sure it is a unique instance, but wait for the first use to load the class (for Blueprints). EditorValidatorSubsystem.h  

void CleanupValidators()

   EditorValidatorSubsystem.h  

virtual bool IsPathExcludedFromValidation ( FStringView Path
) const

   EditorValidatorSubsystem.h  

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

   EditorValidatorSubsystem.h  

void OnAssetsAdded ( TConstArrayView< FAssetData > InAssets
)

 Handle Blueprint assets being added or removed ( EditorValidatorSubsystem.h  

void OnAssetsAddedOrRemoved ( TConstArrayView< FAssetData > InAssets,
TFunctionRef< void(const FTopLevelAssetPath&BPGC)> Callback
)

   EditorValidatorSubsystem.h  

void OnAssetsRemoved ( TConstArrayView< FAssetData > InAssets
)

   EditorValidatorSubsystem.h  

void OnNativeModulesChanged ( FName InModuleName,
EModuleChangeReason InModuleChangeReason
)

 Handle native modules being loaded or unloaded ( EditorValidatorSubsystem.h  

void RegisterBlueprintValidators()

   EditorValidatorSubsystem.h  

void RegisterNativeValidators()

   EditorValidatorSubsystem.h  

void RemoveValidator ( const FTopLevelAssetPath& InValidatorClass
)

 Remove any validators (active or pending) for the given class. EditorValidatorSubsystem.h  

bool ShouldValidateOnSave ( bool bProceduralSave
) const

   EditorValidatorSubsystem.h  
Apply any pending changes to the list of active validators ( EditorValidatorSubsystem.h  
  EditorValidatorSubsystem.h  

void ValidateAllSavedPackages()

 Handles validating all pending save packages EditorValidatorSubsystem.h  

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

 Validate a set of assets, adding the results to the log/output of a higher level task (e.g. changelist validation). EditorValidatorSubsystem.h  

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

 Validates changelist before SCC submit operation EditorValidatorSubsystem.h  

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

   EditorValidatorSubsystem.h  

void ValidateFilesPreSubmit ( TArray< FSourceControlStateRef >& States,
EDataValidationResult& OutResult,
TArray< FText >& ValidationErrors,
TArray< FText >& ValidationWarnings
) const

 Validates files before SCC submit operation EditorValidatorSubsystem.h  

EDataValidationResult ValidateObjectInternal ( const FAssetData& InAssetData,
UObject* InObject,
FDataValidationContext& InContext,
TMap< FTopLevelAssetPath, FValidatorStatistics >* ValidatorStatistics
) const

   EditorValidatorSubsystem.h  

void WaitForAssetCompilationIfNecessary ( EDataValidationUsecase InUsecase,
bool bShowProgress
) const

   EditorValidatorSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page