| AdditionalValidationErrorMessages |
TArray< FString > |
Additional error messages to print when this validation fails |
Logic/Validators/ValidatorDefinition.h |
|
| AppliesToCLRegex |
FString |
Regex to test paths to check if this validator should be applied Replaces IncludeFilesWithExtension & IncludeFilesInDirectory |
Logic/Validators/ValidatorDefinition.h |
|
| bAcceptDeletedFiles |
bool |
If this Validator runs on files marked for delete |
Logic/Validators/ValidatorDefinition.h |
|
| bAllowSkippingOnMemoryFail |
bool |
|
Logic/Validators/ValidatorDefinition.h |
|
| bAppendAddendumOnAnyResult |
bool |
If true, addendum will be appended as long as the validation has been run, even on failure |
Logic/Validators/ValidatorDefinition.h |
|
| bBlocksPreflightStart |
bool |
|
Logic/Validators/ValidatorDefinition.h |
|
| bCanBeDisabledByUser |
bool |
If false, this validator won't have the disable button available |
Logic/Validators/ValidatorDefinition.h |
|
| bCanBeStoppedByUser |
bool |
If false, this validator won't have the Stop button available |
Logic/Validators/ValidatorDefinition.h |
|
| bIncludeWarningsInErrorSummary |
bool |
Whether to include or not the output warnings in the error summary window |
Logic/Validators/ValidatorDefinition.h |
|
| bInvalidatesWhenOutOfDate |
bool |
|
Logic/Validators/ValidatorDefinition.h |
|
| bIsDisabled |
bool |
If true, this validator will be disabled |
Logic/Validators/ValidatorDefinition.h |
|
| bIsStealthMode |
bool |
This is a mode that will make the validator not report any errors or warnings to the program/user but still log them to telemetry It doesn't matter if it fails, it will always report as succeed and never block submission. |
Logic/Validators/ValidatorDefinition.h |
|
| bRegisterFailureInCLDescription |
bool |
When enabled this validator failures will be registered in the #FailedValidations tag |
Logic/Validators/ValidatorDefinition.h |
|
| bRequireCompleteWhenOptional |
bool |
Whether the validator is required to finish running before allowing submission |
Logic/Validators/ValidatorDefinition.h |
|
| bRequireShelveOperation |
bool |
If true, this validator will have submit tool perform a shelve operation before running if it's required. |
Logic/Validators/ValidatorDefinition.h |
|
| bRequiresSTLaunchedFromEditor |
bool |
This validator will only be applicable when running from editor (-from-editor is present) |
Logic/Validators/ValidatorDefinition.h |
|
| bRequiresSTLaunchedStandalone |
bool |
This validator will only be applicable when NOT running from editor (-from-editor is not present) |
Logic/Validators/ValidatorDefinition.h |
|
| bSkipWhenAddendumInDescription |
bool |
Skip this validator when the addendum is already present in the CL description |
Logic/Validators/ValidatorDefinition.h |
|
| bSkipWhenCalledFromEditor |
bool |
Skip this validator when Submit tool is invoked from editor (has the -from-editor cmdline flag) |
Logic/Validators/ValidatorDefinition.h |
|
| bTreatWarningsAsErrors |
bool |
If this Validator should treat warnings as errors |
Logic/Validators/ValidatorDefinition.h |
|
| bUsesIncrementalCache |
bool |
If this validator maintains a local cache of results per file between runs on the same CL, used for incremental validations |
Logic/Validators/ValidatorDefinition.h |
|
| ChangelistDescriptionAddendum |
FString |
This text will be added to the description if this validation passes |
Logic/Validators/ValidatorDefinition.h |
|
| CheckFileExists |
TArray< FString > |
Checks if all these files exists as an additional requirement for this validator to run |
Logic/Validators/ValidatorDefinition.h |
|
| CustomName |
FString |
Name of this instance of the validator that will be used for display |
Logic/Validators/ValidatorDefinition.h |
|
| DependsOn |
TArray< FName > |
List of Validator Ids that needs to succeed before this validator runs |
Logic/Validators/ValidatorDefinition.h |
|
| ExcludeWhenFileInHierarchy |
FString |
Wildcard pattern: Opposite of RequireFileInHierarchy this validator will not apply to files that the pattern is matched at any level in the parent hierarchy i.e: *.uproject -> validator will never include files/paths with a uproject in their parent folder structure |
Logic/Validators/ValidatorDefinition.h |
|
| ExecutionBlockGroups |
TArray< FName > |
List of execution groups this Validator is part of. |
Logic/Validators/ValidatorDefinition.h |
|
| IncludeFilesInDirectory |
FString |
Incompatible with AppliesToCLRegex Only run this validator for files under this directory |
Logic/Validators/ValidatorDefinition.h |
|
| IncludeFilesInDirectoryPerExtension |
TArray< FPathPerExtension > |
Only run this validator for files with this extension under these directories |
Logic/Validators/ValidatorDefinition.h |
|
| IncludeFilesWithExtension |
TArray< FString > |
Incompatible with AppliesToCLRegex Files with any of these extensions will be included |
Logic/Validators/ValidatorDefinition.h |
|
| IsRequired |
bool |
Whether the validator is required to allow submission or not, a failing required validation will always block submission |
Logic/Validators/ValidatorDefinition.h |
|
| MinMemoryGBRequired |
int32 |
|
Logic/Validators/ValidatorDefinition.h |
|
| NotApplicableToCLMessage |
FString |
Optional message to print when the validator doesn't apply to CL to give more context to AppliesToCLRegex |
Logic/Validators/ValidatorDefinition.h |
|
| NotEnoughMemoryMessage |
FString |
|
Logic/Validators/ValidatorDefinition.h |
|
| PopupMessageWhenFailed |
FString |
Only usable when optional - If this property is specified and the validator has failed, submit tool will show a pop up with all the failed validator messages that the user has to confirm through. |
Logic/Validators/ValidatorDefinition.h |
|
| PreflightTemplate |
FString |
|
Logic/Validators/ValidatorDefinition.h |
|
| RequireFileInHierarchy |
FString |
Wildcard pattern: only apply this validator to files/path which the specified pattern is matched at any level in the parent hierarchy i.e: *.uproject -> validator will only include files/paths with a uproject in their parent folder structure |
Logic/Validators/ValidatorDefinition.h |
|
| SkipForbiddenFiles |
TArray< FString > |
Skip is forbidden when the CL contains any of these filepatterns |
Logic/Validators/ValidatorDefinition.h |
|
| SkipForbiddenStreams |
TArray< FString > |
Skip is forbidden when the CL contains any file in the specified streams |
Logic/Validators/ValidatorDefinition.h |
|
| SkipForbiddenTags |
TArray< FString > |
Skip is forbidden when this text if found in the CL description |
Logic/Validators/ValidatorDefinition.h |
|
| TaskArea |
ETaskArea |
Area this validator works on, if an area is updated, the validator state will be automatically resetted { Everything, LocalFiles, ShelvedFiles, LocalAndShelvedFiles, Changelist } |
Logic/Validators/ValidatorDefinition.h |
|
| TimeoutLimit |
float |
Maximum time that a validator will run before being cancelled out |
Logic/Validators/ValidatorDefinition.h |
|
| ToolTip |
FString |
Tooltip when hovering over the Validator |
Logic/Validators/ValidatorDefinition.h |
|
| Type |
FString |
Type of the validator, this is restricted to the classes that are implemented and derive from FValidatorBase examples include CustomValidator, TagValidator, UBTValidator and others |
Logic/Validators/ValidatorDefinition.h |
|