FGameplayEffectQuery

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

Windows
MacOS
Linux

References

Module

GameplayAbilities

Header

/Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/GameplayEffect.h

Include

#include "GameplayEffect.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)([BlueprintType](Programming/UnrealArchitecture/Reference/Structs/Specifiers/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

Public variable

FActiveGameplay...

 

CustomMatchDelegate

Native delegate for providing custom matching conditions.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FActiveGameplay...

 

CustomMatchDelegate_BP

BP-exposed delegate for providing custom matching conditions.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

TSubclassOf< UG...

 

EffectDefinition

Matches on GameplayEffects with this definition

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

const UObject &...

 

EffectSource

Matches on GameplayEffects which come from this source

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FGameplayTagQue...

 

EffectTagQuery

Query that is matched against tags this GE has

Public variable

TArray< FActive...

 

IgnoreHandles

Handles to ignore as matches, even if other criteria is met

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FGameplayAttrib...

 

ModifyingAttribute

Matches on GameplayEffects which modify given attribute.

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FGameplayTagQue...

 

OwningTagQuery

Query that is matched against tags this GE gives

Public variable UProperty Category, EditAnywhere BlueprintReadWrite

FGameplayTagQue...

 

SourceTagQuery

Query that is matched against tags the source of this GE has

Constructors

Functions

Name Description

Public function Const

bool

 

IsEmpty()

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

Public function Static

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

Public function Static

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

Public function Static

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

Public function Static

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

Public function Static

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

Public function Static

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

Public function Static

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

Public function Static

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

Public function Static

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

Public function Const

bool

 

Matches

(
    const FActiveGameplayEffect& Effec...
)

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

Public function Const

bool

 

Matches

(
    const FGameplayEffectSpec& Effect
)

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

Operators

Name Description

Public function

FGameplayEff...

 

operator=

(
    FGameplayEffectQuery&& Other
)

Public function

FGameplayEff...

 

operator=

(
    const FGameplayEffectQuery& Other
)

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss