Navigation
API > API/Plugins > API/Plugins/GameplayAbilities
Generic querying data structure for active GameplayEffects. Lets us ask things like: Give me duration/magnitude of active gameplay effects with these tags Give me handles to all activate gameplay effects modifying this attribute.
Any requirements specified in the query are required: must meet "all" not "one".
| Name | FActiveGameplayEffectQuery |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/GameplayEffect.h |
| Include Path | #include "GameplayEffect.h" |
Syntax
USTRUCT ()
struct FActiveGameplayEffectQuery
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| GameplayEffect.h | |||
FActiveGameplayEffectQuery
(
const FGameplayTagContainer* InOwningTagContainer |
GameplayEffect.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CustomMatch | FActiveGameplayEffectQueryCustomMatch | Bind this to override the default query-matching code. | GameplayEffect.h | |
| EffectDef | const UGameplayEffect * | Matches on GameplayEffects with this definition | GameplayEffect.h | |
| EffectSource | const UObject * | Matches on GameplayEffects which come from this source | GameplayEffect.h | |
| EffectTagContainer | const FGameplayTagContainer * | Used to match with InheritableGameplayEffectTags | GameplayEffect.h | |
| EffectTagContainer_Rejection | const FGameplayTagContainer * | Used to reject matches with InheritableGameplayEffectTags | GameplayEffect.h | |
| 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 | |
| OwningTagContainer | const FGameplayTagContainer * | Used to match with InheritableOwnedTagsContainer | GameplayEffect.h | |
| OwningTagContainer_Rejection | const FGameplayTagContainer * | Used to reject matches with InheritableOwnedTagsContainer | GameplayEffect.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool Matches
(
const FActiveGameplayEffect& Effect |
Returns true if Effect matches the criteria of this query, which will be overridden by CustomMatch if it is bound. | GameplayEffect.h |