1. Epic GamesDeveloper
  3. FGameplayEffectQuery

FGameplayEffectQuery

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

API > API/Plugins > API/Plugins/GameplayAbilities

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

   
Name FGameplayEffectQuery
Type struct
Header File /Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/GameplayEffect.h
Include Path #include "GameplayEffect.h"

Syntax

USTRUCT (BlueprintType )  
struct FGameplayEffectQuery

Constructors

Name Remarks Include Path Unreal Specifiers
  GameplayEffect.h  

FGameplayEffectQuery ( FActiveGameplayEffectQueryCustomMatch InCustomMatchDelegate
)

   GameplayEffect.h  
  GameplayEffect.h  
Ctors and operators GameplayEffect.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
CustomMatchDelegate FActiveGameplayEffectQueryCustomMatch Native delegate for providing custom matching conditions. GameplayEffect.h  
CustomMatchDelegate_BP FActiveGameplayEffectQueryCustomMatch_Dynamic BP-exposed delegate for providing custom matching conditions. GameplayEffect.h
  • BlueprintReadWrite
  • Category=Query
EffectDefinition TSubclassOf< UGameplayEffect > Matches on GameplayEffects with this definition GameplayEffect.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Query
EffectSource TObjectPtr< const UObject > Matches on GameplayEffects which come from this source GameplayEffect.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Query
EffectTagQuery FGameplayTagQuery Query that is matched against tags this GE has GameplayEffect.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Query
IgnoreHandles TArray< FActiveGameplayEffectHandle > Handles to ignore as matches, even if other criteria is met GameplayEffect.h  
ModifyingAttribute FGameplayAttribute Matches on GameplayEffects which modify given attribute. GameplayEffect.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Query
OwningTagQuery FGameplayTagQuery Query that is matched against tags this GE gives GameplayEffect.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Query
SourceAggregateTagQuery FGameplayTagQuery Query that is matched against all tags the source of this GE has GameplayEffect.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Query
SourceTagQuery FGameplayTagQuery Query that is matched against spec tags the source of this GE has GameplayEffect.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Query
  • DisplayName=SourceSpecTagQuery

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool IsEmpty()

 Returns true if the query is empty/default. E.g., it has no data set. GameplayEffect.h  

bool Matches ( const FActiveGameplayEffect& Effect
) const

 Returns true if Effect matches all specified criteria of this query, including CustomMatch delegates if bound. GameplayEffect.h  

bool Matches ( const FGameplayEffectSpec& Effect
) const

 Returns true if Effect matches all specified criteria of this query. GameplayEffect.h  

Static

Name Remarks Include Path Unreal Specifiers

static FGameplayEffectQuery MakeQuery_MatchAllEffectTags ( const FGameplayTagContainer& InTags
)

 Creates an effect query that will match if all of the given tags are in the ActiveGameplayEffect's tags GameplayEffect.h  

static FGameplayEffectQuery MakeQuery_MatchAllOwningTags ( const FGameplayTagContainer& InTags
)

 Creates an effect query that will match if all of the given tags are in the ActiveGameplayEffect's owning tags GameplayEffect.h  

static FGameplayEffectQuery MakeQuery_MatchAllSourceSpecTags ( const FGameplayTagContainer& InTags
)

 Creates an effect query that will match if all of the given tags are in the ActiveGameplayEffect's source spec tags GameplayEffect.h  

static FGameplayEffectQuery MakeQuery_MatchAnyEffectTags ( const FGameplayTagContainer& InTags
)

 Creates an effect query that will match if there are any common tags between the given tags and an ActiveGameplayEffect's tags GameplayEffect.h  

static FGameplayEffectQuery MakeQuery_MatchAnyOwningTags ( const FGameplayTagContainer& InTags
)

 Creates an effect query that will match if there are any common tags between the given tags and an ActiveGameplayEffect's owning tags GameplayEffect.h  

static FGameplayEffectQuery MakeQuery_MatchAnySourceSpecTags ( const FGameplayTagContainer& InTags
)

 Creates an effect query that will match if there are any common tags between the given tags and an ActiveGameplayEffect's source spec tags GameplayEffect.h  

static FGameplayEffectQuery MakeQuery_MatchNoEffectTags ( const FGameplayTagContainer& InTags
)

 Creates an effect query that will match if there are no common tags between the given tags and an ActiveGameplayEffect's tags GameplayEffect.h  

static FGameplayEffectQuery MakeQuery_MatchNoOwningTags ( const FGameplayTagContainer& InTags
)

 Creates an effect query that will match if there are no common tags between the given tags and an ActiveGameplayEffect's owning tags GameplayEffect.h  

static FGameplayEffectQuery MakeQuery_MatchNoSourceSpecTags ( const FGameplayTagContainer& InTags
)

 Creates an effect query that will match if there are no common tags between the given tags and an ActiveGameplayEffect's source spec tags GameplayEffect.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator!= ( const FGameplayEffectQuery& Other
) const

   GameplayEffect.h  
  GameplayEffect.h  
  GameplayEffect.h  

bool operator== ( const FGameplayEffectQuery& Other
) const

   GameplayEffect.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page