FActiveGameplayEffectHandle | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/GameplayAbilities

This handle is required for things outside of FActiveGameplayEffectsContainer to refer to a specific active GameplayEffect For example if a skill needs to create an active effect and then destroy that specific effect that it created, it has to do so through a handle. a pointer or index into the active list is not sufficient. These are not synchronized between clients and server.


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

Syntax

USTRUCT (BlueprintType )  
struct FActiveGameplayEffectHandle

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FActiveGameplayEffectHandle ()		ActiveGameplayEffectHandle.h
FActiveGameplayEffectHandle ( int32 InHandle )		ActiveGameplayEffectHandle.h

Variables

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
bPassedFiltersAndWasExecuted	bool		ActiveGameplayEffectHandle.h
Handle	int32		ActiveGameplayEffectHandle.h

Functions

Public

Name	Remarks	Include Path
UAbilitySystemComponent * GetOwningAbilitySystemComponent()	Returns the ability system component that created this handle	ActiveGameplayEffectHandle.h
void Invalidate()		ActiveGameplayEffectHandle.h
bool IsValid()	True if this is tracking an active ongoing gameplay effect	ActiveGameplayEffectHandle.h
void RemoveFromGlobalMap()	Remove this from the GetOwningAbilitySystemComponent map	ActiveGameplayEffectHandle.h
FString ToString()		ActiveGameplayEffectHandle.h
bool WasSuccessfullyApplied ()	True if this applied a gameplay effect.	ActiveGameplayEffectHandle.h

Static

Name	Remarks	Include Path	Unreal Specifiers
static FActiveGameplayEffectHandle GenerateNewHandle ( UAbilitySystemComponent* OwningComponent )	Creates a new handle, will be set to successfully applied	ActiveGameplayEffectHandle.h
static void ResetGlobalHandleMap()	Resets the map that supports GetOwningAbilitySystemComponent	ActiveGameplayEffectHandle.h

Operators

Name	Remarks	Include Path	Unreal Specifiers
bool operator!= ( const FActiveGameplayEffectHandle& Other ) const		ActiveGameplayEffectHandle.h
bool operator== ( const FActiveGameplayEffectHandle& Other ) const		ActiveGameplayEffectHandle.h

Navigation