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

Light Theme

Dark Theme

FActiveGameplayEffectHandle

This handle is required for things outside of [FActiveGameplayEffectsContainer](API\Plugins\GameplayAbilities\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.

Windows

MacOS

Linux

References

Module	GameplayAbilities
Header	/Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/GameplayEffectTypes.h
Include	#include "GameplayEffectTypes.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)([BlueprintType](Programming/UnrealArchitecture/Reference/Structs/Specifiers/BlueprintType))
struct FActiveGameplayEffectHandle

Remarks

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.

Constructors

	Name	Description
	FActiveGameplayEffectHandle()
	FActiveGameplayEffectHandle ( int32 InHandle )

Functions

	Name	Description
FActiveGamep...	GenerateNewHandle ( UAbilitySystemComponent* Ownin... )	Creates a new handle, will be set to successfully applied
UAbilitySyst...	GetOwningAbilitySystemComponent()	Returns the ability system component that created this handle
const UAbili...	GetOwningAbilitySystemComponent()	Returns the ability system component that created this handle
void	Invalidate()
bool	IsValid()	True if this is tracking an active ongoing gameplay effect
void	RemoveFromGlobalMap()	Remove this from the GetOwningAbilitySystemComponent map
void	ResetGlobalHandleMap()	Resets the map that supports GetOwningAbilitySystemComponent
FString	ToString()
bool	WasSuccessfullyApplied()	True if this applied a gameplay effect.

Operators

		Name	Description
	bool	operator!= ( const FActiveGameplayEffectHandle&... )
	bool	operator== ( const FActiveGameplayEffectHandle&... )

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

Take our survey

Dismiss