Class UZagalaSpecFeatureAsset#
Defined in File ZagalaSpecFeatureAsset.h
Inheritance Relationships#
Base Types#
public UPrimaryDataAssetpublic IZagalaSpecFeature(Class IZagalaSpecFeature)public IZagalaSpecTestabilityIndicator(Class IZagalaSpecTestabilityIndicator)public IZagalaSpecDescriptor(Class IZagalaSpecDescriptor)public IZagalaSpecEditController(Class IZagalaSpecEditController)public IZagalaSpecFeaturePropertyNames(Class IZagalaSpecFeaturePropertyNames)
Class Documentation#
-
class UZagalaSpecFeatureAsset : public UPrimaryDataAsset, public IZagalaSpecFeature, public IZagalaSpecTestabilityIndicator, public IZagalaSpecDescriptor, public IZagalaSpecEditController, public IZagalaSpecFeaturePropertyNames#
A user-facing aspect of the application that should be clearly defined and understood by all stakeholders before development begins.
This does not mean that is perfect, just that it is possible. The idea of its user story is to generate conversation/communication and with that everyone (not only devs) exposes what they understand of it. With this in mind, something better is created. Use INVEST: Independent (Can be implemented in any order) Negotiable (Can be changed completely when not executing it) Valuable (Has to bring concrete value to users) Estimable (Do not think about it; its time can be known by measuring its execution and extrapolate it for future ones) Small (In reality, Scalable, but it is better to say Small: Have to be small so they can be completed in less than two weeks) Testable (It is only considered finished when all its scenarios (tests) pass)
IZagalaSpecFeature interface
-
virtual const TArray<TObjectPtr<UObject>> &GetScenariosReference() const override#
Returns a reference to the scenarios array.
- Returns:
A const reference to the scenarios array.
Returns a reference to the shared context extensions array.
- Returns:
A const reference to the shared context extensions array.
IZagalaSpecFeaturePropertyNames interface
-
virtual FName GetIdentifierPropertyName() const override#
Name of the property that stores the feature’s gameplay tag (FGameplayTag).
- Returns:
The identifier property name.
-
virtual FName GetDescriptionPropertyName() const override#
Name of the property that stores the feature’s description (FString).
- Returns:
The description property name.
-
virtual FName GetIncludeInTestsPropertyName() const override#
Name of the property that stores whether the feature’s scenarios are included in tests (bool).
- Returns:
The include-in-tests property name.
-
virtual FName GetFeatureLinksPropertyName() const override#
Name of the property that stores the feature links (array of objects).
- Returns:
The feature links property name.
Name of the property that stores the shared context extensions (array of objects).
- Returns:
The shared context extensions property name.
-
virtual FName GetScenariosPropertyName() const override#
Name of the property that stores the scenarios (array of objects).
- Returns:
The scenarios property name.
IZagalaSpecTestabilityIndicator interface
-
virtual bool IsIncludedInTests_Implementation() const override#
Returns true if this feature’s scenarios should be registered in the test runner.
IZagalaSpecDescriptor interface
-
virtual FGameplayTag GetTag_Implementation() const override#
Returns the associated gameplay tag for this object.
- Returns:
The gameplay tag of this object.
-
virtual FString GetDescription_Implementation() const override#
Returns a textual description of this object.
- Returns:
The description of this object.
Public Functions
-
UZagalaSpecFeatureAsset(const FObjectInitializer &ObjectInitializer = FObjectInitializer::Get())#
-
virtual void PreSave(FObjectPreSaveContext ObjectSaveContext) override#
-
virtual EDataValidationResult IsDataValid(class FDataValidationContext &Context) const override#
-
virtual void PostEditChangeProperty(FPropertyChangedEvent &PropertyChangedEvent) override#
Protected Functions
-
virtual bool DoesAllowEditing_Implementation() override#
Returns whether this object currently allows editing.
- Returns:
True if editing is currently allowed, false otherwise.
-
virtual void AllowEditing_Implementation() override#
Tries setting EditController variable to true.
-
virtual void DisallowEditing_Implementation() override#
Tries setting EditController variable to false.
Protected Attributes
-
bool bIncludeAllScenariosInTests#
When false, none of this feature’s scenarios are registered in the test runner.
Context extensions shared across all scenarios of this feature.
These are prepended to the extension chain before each scenario’s own context extensions. Context receives duplicates; mark variables as UPROPERTY so they get copied over.
-
FGameplayTag Identifier#
Tag that represents the feature.
It is used to identify the feature in a unique way. It is recommended to use a hierarchical tag structure (e.g., “Feature.UserAuthentication”).
-
FString Description#
User story representing the feature.
-
TArray<TObjectPtr<UObject>> Scenarios#
Executable Examples distilled from the user story (Description).
-
bool bIsEditingAllowed#
Whether feature properties can be edited; toggled by AllowEditing() and DisallowEditing().
-
TArray<TObjectPtr<UObject>> FeatureLinks#
Objects that implement IZagalaSpecFeatureLink and react when this feature asset changes.
Friends
- friend class UZagalaSpecScenario
-
virtual const TArray<TObjectPtr<UObject>> &GetScenariosReference() const override#