Class IZagalaSpecScenarioInterface#

Inheritance Relationships#

Derived Type#

Class Documentation#

class IZagalaSpecScenarioInterface#

Implemented by objects that represent feature scenarios (a sequence of steps that are expected to occur).

Context Extensions are additional steps that provide extra functionality or data to the scenario in order to fulfill the scenario’s expectations. Expectations are the core steps that define what is expected to occur in the scenario.

Subclassed by UZagalaSpecScenario

Public Functions

TArray<UObject*> GetContextExtensions() const#

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

Returns:

The context extensions of this scenario.

TArray<UObject*> GetExpectations() const#

Returns the expectations (steps) associated with this scenario.

Returns:

The expectations of this scenario.

FGameplayTagContainer GetFilterTags() const#

Returns the scenario filter tags (ZagalaSpec.ScenarioFilter.

*) that control whether this scenario is listed when tests are gathered. The tags are copied into the ZagalaSpec feature settings when the owning feature is saved. They are not imported or exported.

Returns:

The filter tags of this scenario. Empty by default.

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

Read-only access to the expectations array.

Returns:

A const reference to the expectations array.

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

Read-only access to the context extensions array.

Returns:

A const reference to the context extensions array.

Protected Functions

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

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

Returns:

The context extensions of this scenario.

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

Returns the expectations (steps) associated with this scenario.

Returns:

The expectations of this scenario.

virtual FGameplayTagContainer GetFilterTags_Implementation() const#

Returns the scenario filter tags (ZagalaSpec.ScenarioFilter.

*) that control whether this scenario is listed when tests are gathered. The tags are copied into the ZagalaSpec feature settings when the owning feature is saved. They are not imported or exported.

Returns:

The filter tags of this scenario. Empty by default.