Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > GameplayAbilities > FGameplayEffectQuery

Light Theme

Dark Theme

FGameplayEffectQuery

Every set condition within this query must match in order for the query to match.

Choose your operating system:

Windows

macOS

Linux

References

Module	GameplayAbilities
Header	/Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/GameplayEffect.h
Include	#include "GameplayEffect.h"

Syntax

USTRUCT(BlueprintType)
struct FGameplayEffectQuery

Remarks

Every set condition within this query must match in order for the query to match. i.e. individual query elements are ANDed together.

Variables

	Name	Description
FActiveGameplay...	CustomMatchDelegate	Native delegate for providing custom matching conditions.
FActiveGameplay...	CustomMatchDelegate_BP	BP-exposed delegate for providing custom matching conditions.
TSubclassOf< UG...	EffectDefinition	Matches on GameplayEffects with this definition
const UObject &...	EffectSource	Matches on GameplayEffects which come from this source
FGameplayTagQue...	EffectTagQuery	Query that is matched against tags this GE has
TArray< FActive...	IgnoreHandles	Handles to ignore as matches, even if other criteria is met
FGameplayAttrib...	ModifyingAttribute	Matches on GameplayEffects which modify given attribute.
FGameplayTagQue...	OwningTagQuery	Query that is matched against tags this GE gives
FGameplayTagQue...	SourceTagQuery	Query that is matched against tags the source of this GE has

Constructors

	Name	Description
	FGameplayEffectQuery()	Ctors and operators
	FGameplayEffectQuery ( const FGameplayEffectQuery& Other )
	FGameplayEffectQuery ( FActiveGameplayEffectQueryCustomMat... )
	FGameplayEffectQuery ( FGameplayEffectQuery&& Other )

Functions

	Name	Description
bool	IsEmpty()	Returns true if the query is empty/default. E.g., it has no data set.
FGameplayEff...	MakeQuery_MatchAllEffectTags ( const FGameplayTagContainer& InTag... )	Creates an effect query that will match if all of the given tags are in the ActiveGameplayEffect's tags
FGameplayEff...	MakeQuery_MatchAllOwningTags ( const FGameplayTagContainer& InTag... )	Creates an effect query that will match if all of the given tags are in the ActiveGameplayEffect's owning tags
FGameplayEff...	MakeQuery_MatchAllSourceTags ( const FGameplayTagContainer& InTag... )	Creates an effect query that will match if all of the given tags are in the ActiveGameplayEffect's source tags
FGameplayEff...	MakeQuery_MatchAnyEffectTags ( const FGameplayTagContainer& InTag... )	Creates an effect query that will match if there are any common tags between the given tags and an ActiveGameplayEffect's tags
FGameplayEff...	MakeQuery_MatchAnyOwningTags ( const FGameplayTagContainer& InTag... )	Creates an effect query that will match if there are any common tags between the given tags and an ActiveGameplayEffect's owning tags
FGameplayEff...	MakeQuery_MatchAnySourceTags ( const FGameplayTagContainer& InTag... )	Creates an effect query that will match if there are any common tags between the given tags and an ActiveGameplayEffect's source tags
FGameplayEff...	MakeQuery_MatchNoEffectTags ( const FGameplayTagContainer& InTag... )	Creates an effect query that will match if there are no common tags between the given tags and an ActiveGameplayEffect's tags
FGameplayEff...	MakeQuery_MatchNoOwningTags ( const FGameplayTagContainer& InTag... )	Creates an effect query that will match if there are no common tags between the given tags and an ActiveGameplayEffect's owning tags
FGameplayEff...	MakeQuery_MatchNoSourceTags ( const FGameplayTagContainer& InTag... )	Creates an effect query that will match if there are no common tags between the given tags and an ActiveGameplayEffect's source tags
bool	Matches ( const FActiveGameplayEffect& Effec... )	Returns true if Effect matches all specified criteria of this query, including CustomMatch delegates if bound.
bool	Matches ( const FGameplayEffectSpec& Effect )	Returns true if Effect matches all specified criteria of this query.

Operators

		Name	Description
	FGameplayEff...	operator= ( FGameplayEffectQuery&& Other )
	FGameplayEff...	operator= ( const FGameplayEffectQuery& Other )