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 > FActiveGameplayEffectQuery

Light Theme

Dark Theme

FActiveGameplayEffectQuery

Generic querying data structure for active GameplayEffects.

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)()
struct FActiveGameplayEffectQuery

Remarks

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".

Variables

	Name	Description
FActiveGameplay...	CustomMatch	Bind this to override the default query-matching code.
const UGameplay...	EffectDef	Matches on GameplayEffects with this definition
const UObject &...	EffectSource	Matches on GameplayEffects which come from this source
const FGameplay...	EffectTagContainer	Used to match with InheritableGameplayEffectTags
const FGameplay...	EffectTagContainer_Rejection	Used to reject matches with InheritableGameplayEffectTags
TArray< FActive...	IgnoreHandles	Handles to ignore as matches, even if other criteria is met
FGameplayAttrib...	ModifyingAttribute	Matches on GameplayEffects which modify given attribute
const FGameplay...	OwningTagContainer	Used to match with InheritableOwnedTagsContainer
const FGameplay...	OwningTagContainer_Rejection	Used to reject matches with InheritableOwnedTagsContainer

Constructors

	Name	Description
	FActiveGameplayEffectQuery()
	FActiveGameplayEffectQuery ( const FGameplayTagContainer* I... )

Functions

		Name	Description
	bool	Matches ( const FActiveGameplayEffect& Effec... )	Returns true if Effect matches the criteria of this query, which will be overridden by CustomMatch if it is bound.

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

Take our survey

Dismiss