1. Epic GamesDeveloper
  3. UEditorValidatorBase

UEditorValidatorBase

The EditorValidatorBase is a class which verifies that an asset meets a specific ruleset.

API > API/Plugins > API/Plugins/DataValidation

Inheritance Hierarchy

References

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

Syntax

UCLASS (Abstract, Blueprintable, Meta=(ShowWorldContextPin), Config=Editor)  
class UEditorValidatorBase : public UObject

Remarks

The EditorValidatorBase is a class which verifies that an asset meets a specific ruleset. It should be used when checking engine-level classes, as UObject::IsDataValid requires overriding the base class. You can create project-specific version of the validator base, with custom logging and enabled logic.

C++ and Blueprint validators will be gathered on editor start, while python validators need to register themselves

Variables

  Type Name Description
Protected variable UProperty Config bool bIsConfigDisabled Allows disabling validators from config without checking in assets/modifying code.
Protected variable UProperty Category, EditAnywhere, Meta bool bIsEnabled  
Protected variable UProperty Category, EditAnywhere, Meta bool bOnlyPrintCustomMessage Whether we should also print out the source validator when printing validation errors.
Public variable const FText & InMessage  
Public variable const FText TArray< FText > & InOutErrors  
Public variable TArray< FText > & ValidationErrors  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddLegacyValidationErrors ( TArray< FText > InErrors
)

  
Public function UFunction BlueprintCallable, Category void

AssetFails ( const UObject* InAsset,
const FText& InMessage
)

 Marks the validation as failed and adds an error message.
Public function TSharedRef< FTokenizedMessage >

AssetMessage ( const FAssetData& InAssetData,
EMessageSeverity::Type InSeverity,
const FText& InText
)

 Add a tokenized message to the validation results.
Public function TSharedRef< FTokenizedMessage >

AssetMessage ( EMessageSeverity::Type InSeverity,
const FText& InText
)

  
Public function UFunction BlueprintCallable, Category void

AssetPasses ( const UObject* InAsset
)

 Marks the validation as successful.
Public function UFunction BlueprintCallable, Category void

AssetWarning ( const UObject* InAsset,
const FText& InMessage
)

 Adds a message to this validation but doesn't mark it as failed.
Public function Virtual Const bool

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

 Override this to determine whether or not you can use this validator given this context.
Public function Const EDataValidationResult

ExtractValidationState ( FDataValidationContext& InOutContext
)

  
Public function Const const TArray< FText > &  
Public function Virtual Const TArray< FAssetData >

GetAssetsToValidateFromChangelist ( UDataValidationChangelist* InChangelist,
FDataValidationContext& InContext
)

 Override this to return additional assets that need validation because of other changes in a changelist.
Public function Const UFunction BlueprintCallable, Category EDataValidationResult  
Public function Virtual Const bool  
Public function Const bool  
Public function Const UFunction Category blueprintnativeevent, displayname bool

K2_CanValidate ( const EDataValidationUsecase InUsecase
)

 Override this to determine whether or not you can use this validator given this usecase
Public function Const UFunction Category blueprintnativeevent, displayname bool

K2_CanValidateAsset ( UObject* InAsset
)

 Override this to determine whether or not you can validate a given asset with this validator
Public function UFunction Category blueprintnativeevent, displayname EDataValidationResult

K2_ValidateLoadedAsset ( UObject* InAsset
)

 Override this in blueprint to validate assets
Public function Virtual EDataValidationResult Declaration for above BlueprintNativeEvent.
Public function void  
Public function EDataValidationResult

ValidateLoadedAsset ( const FAssetData& InAssetData,
UObject* InAsset,
FDataValidationContext& Context
)

 Validation entry point - will dispatch to native and/or BP validation as appropriate and return results.
Public function Virtual EDataValidationResult

ValidateLoadedAsset_Implementation ( const FAssetData& InAssetData,
UObject* InAsset,
FDataValidationContext& Context
)

 Override this to validate in C++ with access to FDataValidationContext

Deprecated Functions

  Type Name Description
Public function Const  

UE_DEPRECATED ( "5.4",
"CanValidateAsset_Implementation(UObject* InAsset) is deprecated,
override CanValidateAsset_Implementation(UObject*InObject, FDataValidationContext&InContext) i...
)

  
Public function Const  

UE_DEPRECATED ( "5.4",
"This function has been replaced by the version AssetFails(UObject*, const FText&)"
)

  
Public function Const  

UE_DEPRECATED ( "5.4",
"CanValidate_Implementation(const EDataValidationUsecase InUsecase) is deprecated,
override CanValidateAsset_Implementation(UObject*InObject, FDataValidationContext&InContext) i...
)

  
Public function  

UE_DEPRECATED ( "5.4",
"ValidateLoadedAsset_Implementation(UObject* InAsset, TArray& ValidationErrors) is deprec...,
override ValidateLoadedAsset_Implementation(UObject*InAsset, FDataValidationContext&Context) i...
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page