Class IZagalaSpecFeature#

Inheritance Relationships#

Derived Type#

Class Documentation#

class IZagalaSpecFeature#

Implemented by objects that represent a feature (a business side section of the application that it is expected to exist).

Each feature is composed of scenarios (see ZagalaSpecScenarioInterface), which are examples of the expected behavior within the feature. Shared Context Extensions are additional steps that provide extra functionality or data that all scenarios share within the feature.

A Feature is 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)

Subclassed by UZagalaSpecFeatureAsset

Public Functions

TArray<UObject*> GetSharedContextExtensions() const#

Returns the context extensions (steps) which add additional functionality or data to the scenario.

Returns:

The shared context extensions of this feature.

TArray<UObject*> GetScenarios() const#

Returns the scenarios (examples of behavior) associated with this feature.

Returns:

The scenarios of this feature.

UObject *GetScenario(const FGameplayTag &ScenarioTag) const#

Tries to find a scenario by its tag.

Returns nullptr if not found.

Parameters:

ScenarioTag – The gameplay tag of the scenario to find.

Returns:

A pointer to the scenario if found, nullptr otherwise.

virtual const TArray<TObjectPtr<UObject>> &GetSharedContextExtensionsReference() const = 0#

Returns a reference to the shared context extensions array.

Returns:

A const reference to the shared context extensions array.

virtual const TArray<TObjectPtr<UObject>> &GetScenariosReference() const = 0#

Returns a reference to the scenarios array.

Returns:

A const reference to the scenarios array.

TObjectPtr<UObject> GetScenarioPtr(const FGameplayTag &ScenarioTag) const#

Tries to find a scenario by its tag.

Returns nullptr if not found.

Parameters:

ScenarioTag – The gameplay tag of the scenario to find.

Returns:

A pointer to the scenario if found, nullptr otherwise.

Protected Functions

TArray<TObjectPtr<UObject>> GetSharedContextExtensions_Implementation() const#

Returns the context extensions (steps) which add additional functionality or data to the scenario.

Returns:

The shared context extensions of this feature.

TArray<TObjectPtr<UObject>> GetScenarios_Implementation() const#

Returns the scenarios (examples of behavior) associated with this feature.

Returns:

The scenarios of this feature.

UObject *GetScenario_Implementation(const FGameplayTag &ScenarioTag) const#

Tries to find a scenario by its tag.

Returns nullptr if not found.

Parameters:

ScenarioTag – The gameplay tag of the scenario to find.

Returns:

A pointer to the scenario if found, nullptr otherwise.