Class UZagalaSpecImportExportSettings#
Defined in File ZagalaSpecImportExportSettings.h
Inheritance Relationships#
Base Type#
public UDeveloperSettings
Class Documentation#
-
class UZagalaSpecImportExportSettings : public UDeveloperSettings#
Project-level settings for ZagalaSpec BDD import/export.
Accessible via: Project Settings -> Plugins -> ZagalaSpec Import/Export.
The keyword vocabulary arrays are used by parsers to map framework-specific synonyms onto EZagalaSpecStepPhase values, and by exporters to detect the phase from a step text prefix when StepPhase is UnknownStepPhase.
Export settings
-
FDirectoryPath DefaultExportFilesystemPath#
Default filesystem path where exported BDD files are saved during commandline export.
Leave empty to use {ProjectDir}/Exported/Features.
-
bool OverwriteExistingFiles = false#
Whether to overwrite existing BDD files during commandline export.
If false, export will skip files that already exist on disk.
Step-phase keyword vocabulary
-
TArray<FString> GivenKeywords = {TEXT("Given"), TEXT("Arrange"), TEXT("Precondition"), TEXT("Setup")}#
Words that map a step to EZagalaSpecStepPhase::Given.
First word of the step text is matched case-insensitively.
-
TArray<FString> WhenKeywords = {TEXT("When"), TEXT("Act"), TEXT("Trigger"), TEXT("Action")}#
Words that map a step to EZagalaSpecStepPhase::When.
First word of the step text is matched case-insensitively.
-
TArray<FString> ThenKeywords = {TEXT("Then"), TEXT("Assert"), TEXT("Postcondition"), TEXT("Verify")}#
Words that map a step to EZagalaSpecStepPhase::Then.
First word of the step text is matched case-insensitively.
-
TArray<FString> ConjunctionKeywords = {TEXT("And"), TEXT("But"), TEXT("Or")}#
Words that map a step to EZagalaSpecStepPhase::Conjunction.
First word of the step text is matched case-insensitively.
Public Functions
-
UZagalaSpecImportExportSettings(const FObjectInitializer &ObjectInitializer = FObjectInitializer::Get())#
Public Members
-
FString ImportTagParentPath = TEXT("ZagalaSpec.Import.Features")#
Parent GameplayTag path under which imported feature/scenario tags are created.
-
FDirectoryPath DefaultImportContentPath#
Default content browser path where imported feature assets are saved.
Leave empty to prompt the user each time.
-
int32 BatchImportMaxDepth = 10#
Maximum directory depth when the ZagalaSpec.Import console command scans a folder.
Prevents runaway recursion on large trees.
-
bool OverwriteExistingAssets = false#
Whether to overwrite existing feature assets during commandline import.
If false, import will skip features that already exist in the content browser.
Public Static Functions
-
static const UZagalaSpecImportExportSettings *Get()#
Returns the singleton instance.
- Returns:
The default settings object.
-
static const FString InitialDefaultImportContentPath()#
Returns the built-in default import content path.
- Returns:
The built-in import content path.
-
static const FString InitialDefaultExportFilesystemPath()#
Returns the built-in default export filesystem path.
- Returns:
The built-in export filesystem path.
-
static const FString &GetImportTagParentPath()#
Returns the configured parent path for imported GameplayTags.
- Returns:
The configured GameplayTag parent path.
-
static const FString &GetDefaultImportContentPath()#
Returns the configured default import content path.
- Returns:
The configured import content path.
-
static const FString &GetDefaultExportFilesystemPath()#
Returns the configured default export filesystem path.
- Returns:
The configured export filesystem path.
-
static const FString ResolveImportContentPath()#
Returns the configured import content path, or the built-in default if empty.
- Returns:
The effective import content path.
-
static const FString ResolveExportFilesystemPath()#
Returns the configured export filesystem path, or the built-in default if empty.
- Returns:
The effective export filesystem path.
-
static void SetDefaultImportContentPath(FString NewPath)#
Sets the default import content path.
- Parameters:
NewPath – New content path.
-
static void SetDefaultExportFilesystemPath(FString NewPath)#
Sets the default export filesystem path.
- Parameters:
NewPath – New filesystem path.
-
static bool GetOverwriteExistingFiles()#
Returns whether existing files are overwritten on export.
- Returns:
True when export overwrites existing files.
-
static void SetOverwriteExistingFiles(bool bNewValue)#
Sets whether existing files are overwritten on export.
- Parameters:
bNewValue – New overwrite setting.
-
static TArray<FString> GetPossibleBDDKeywords(bool bIncludeStarKeyword = true, bool bIncludeAndKeyword = true)#
Returns the configured Given, When, and Then keywords.
- Parameters:
bIncludeStarKeyword – Whether to append
*.bIncludeAndKeyword – Whether to append
And.
- Returns:
The combined keyword list.
-
FDirectoryPath DefaultExportFilesystemPath#