Class IZagalaSpecScenarioFilter#

Inheritance Relationships#

Derived Type#

Class Documentation#

class IZagalaSpecScenarioFilter#

Decides, from the filter tags of a scenario alone, whether the scenario is listed when tests are gathered.

Implementations are used through their class default object, so they must be stateless. A filter only acts on scenarios that carry at least one of its handled tags.

Subclassed by UZagalaSpecDefaultScenarioFilter

Public Functions

FGameplayTagContainer GetHandledTags() const#

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

Returns:

The handled tags.

bool IsExcluded(const FGameplayTagContainer &ScenarioFilterTags) const#

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.

bool IsRequirementMet(const FGameplayTagContainer &ScenarioFilterTags) const#

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.

Protected Functions

virtual FGameplayTagContainer GetHandledTags_Implementation() const#

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

Returns:

The handled tags.

virtual bool IsExcluded_Implementation(const FGameplayTagContainer &ScenarioFilterTags) const#

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#

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.