Class UZagalaSpecDefaultScenarioFilter#

Inheritance Relationships#

Base Types#

Derived Types#

Class Documentation#

class UZagalaSpecDefaultScenarioFilter : public UObject, public IZagalaSpecScenarioFilter#

Base for scenario filters that map named environments (e.g.

Editor, Development) to the Require and Exclude tags ZagalaSpec.ScenarioFilter.Require.[Environment] and ZagalaSpec.ScenarioFilter.Exclude.[Environment]. Derive and override GetEnvironments() and IsEnvironmentActive(). Without overrides the filter handles nothing.

Subclassed by UZagalaSpecBuildConfigScenarioFilter, UZagalaSpecEditorScenarioFilter

IZagalaSpecScenarioFilter interface

virtual FGameplayTagContainer GetHandledTags_Implementation() const override#

Returns the scenario filter tags (Require and Exclude) this filter reacts to.

Returns:

The handled tags.

virtual bool IsExcluded_Implementation(const FGameplayTagContainer &ScenarioFilterTags) const override#

Checks whether any of the Exclude tags handled by this filter applies to the current environment.

Parameters:

ScenarioFilterTags – The filter tags of the scenario.

Returns:

True when the scenario must be removed from the tests.

virtual bool IsRequirementMet_Implementation(const FGameplayTagContainer &ScenarioFilterTags) const override#

Checks whether the Require tags handled by this filter are satisfied by the current environment.

Parameters:

ScenarioFilterTags – The filter tags of the scenario.

Returns:

True when the requirement is met or the scenario has no Require tag handled by this filter.

Public Functions

UZagalaSpecDefaultScenarioFilter(const FObjectInitializer &ObjectInitializer = FObjectInitializer::Get())#
TArray<FName> GetEnvironments() const#

Returns the names of the environments this filter knows about.

Returns:

Environment names, e.g. Editor.

bool IsEnvironmentActive(FName Environment) const#

Tells whether the environment is the one the tests are currently running in.

Parameters:

Environment – One of the names returned by GetEnvironments().

Returns:

True when the environment is active.

Protected Functions

virtual TArray<FName> GetEnvironments_Implementation() const#

Returns the names of the environments this filter knows about.

Returns:

Environment names, e.g. Editor.

virtual bool IsEnvironmentActive_Implementation(FName Environment) const#

Tells whether the environment is the one the tests are currently running in.

Parameters:

Environment – One of the names returned by GetEnvironments().

Returns:

True when the environment is active.