Class UZagalaSpecTextStep#
Defined in File ZagalaSpecTextStep.h
Inheritance Relationships#
Base Types#
public UObjectpublic IZagalaSpecConfigStep(Class IZagalaSpecConfigStep)public IZagalaSpecExportableStep(Class IZagalaSpecExportableStep)public IZagalaSpecImportableStep(Class IZagalaSpecImportableStep)public IZagalaSpecStepClassAccessor(Class IZagalaSpecStepClassAccessor)
Class Documentation#
-
class UZagalaSpecTextStep : public UObject, public IZagalaSpecConfigStep, public IZagalaSpecExportableStep, public IZagalaSpecImportableStep, public IZagalaSpecStepClassAccessor#
Used to define text that should match a step with a text pattern and allow optional capture group customization.
IZagalaSpecConfigStep
-
virtual FZagalaSpecStepCreationData CreateStepData_Implementation() const override#
Creates the data needed to instantiate and set up the configured execution step.
- Returns:
The step creation data, including the step class and its execution data.
IZagalaSpecExportableStep
-
virtual FString GetAsText_Implementation() const override#
Returns the text representation of this step.
- Returns:
The step as text.
IZagalaSpecImportableStep
-
virtual void ResolveFromText_Implementation(const FString &Text) override#
Configures this step from its text representation.
- Parameters:
Text – The text to resolve the step from.
IZagalaSpecStepClassAccessor
-
virtual UClass *GetStepClass_Implementation() const override#
Returns the class of the step.
- Returns:
The step class, or nullptr if none is assigned.
Public Functions
-
UZagalaSpecTextStep(const FObjectInitializer &ObjectInitializer = FObjectInitializer::Get())#
-
const FString &GetDefinition() const#
Returns the step text definition.
- Returns:
The step text.
-
void SetDefinition(const FString &NewDefinition)#
Sets the step text definition and performs matching against the step registry.
- Parameters:
NewDefinition – The new step text.
-
const TObjectPtr<UZagalaSpecCaptureGroupCustomizer> &GetCaptureGroupCustomizer() const#
Returns the capture group customizer for the matched pattern.
- Returns:
The capture group customizer.
-
void SetCaptureGroupCustomizer(TObjectPtr<UZagalaSpecCaptureGroupCustomizer> NewCustomizer)#
Sets the capture group customizer; when preserving previous values, copies the existing group configuration into it.
- Parameters:
NewCustomizer – The new capture group customizer.
-
void PerformMatching()#
Matches Definition against the step registry and rebuilds the capture group customizer on a match.
-
void DiscardPreviousCaptureGroupValues()#
Makes later customizer updates replace the previous capture group configuration.
-
void PreservePreviousCaptureGroupValues()#
Makes later customizer updates keep the previous capture group configuration.
-
virtual void PostEditChangeProperty(FPropertyChangedEvent &PropertyChangedEvent) override#
-
virtual EDataValidationResult IsDataValid(class FDataValidationContext &Context) const override#
Fails when Definition is empty, no step entry matched, or the capture group customizer is null or invalid.
Protected Attributes
-
FString Definition#
The text that should match a pattern definition for this step.
-
FString SearchingMatchText#
Visible only while a match search is in progress.
-
TObjectPtr<UZagalaSpecCaptureGroupCustomizer> CaptureGroupCustomizer#
Optional capture group customizer for this step.
Catches the capture groups defined in the text pattern, if any, to allow to further configure them.
-
bool bPreservePreviousCaptureGroupValues#
Whether to preserve previous capture group values when setting a new capture group customizer (which happens when ‘Definition’ changes).
When true, the new customizer will copy over the GroupData from the previous customizer (until the size of the new customizer group data array) for any matching capture groups. When false, the new customizer will be assigned as-is, and any previous capture group values will be discarded. Setting this to true is useful when you want to keep the previous capture group values for a new customizer that has the same capture groups. Setting it to false is useful when you want to ensure that the new customizer starts with a clean slate and does not inherit any previous values. Default is true, meaning that previous capture group values will be preserved when setting a new customizer.
-
FSoftObjectPath MatchedStepEntry#
The matched step entry (implementing IZagalaSpecRegexIdentity) that corresponds to the current Definition.
Empty if the Definition does not match any step entry.
-
bool bIsPerformingMatch#
Whether a match search is currently in progress.
-
virtual FZagalaSpecStepCreationData CreateStepData_Implementation() const override#