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

Light Theme

Dark Theme

FGameplayEffectContextHandle

Handle that wraps a [FGameplayEffectContext](API\Plugins\GameplayAbilities\FGameplayEffectContext) or subclass, to allow it to be polymorphic and replicate properly

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 FGameplayEffectContextHandle

Remarks

Handle that wraps a FGameplayEffectContext or subclass, to allow it to be polymorphic and replicate properly

Constructors

	Name	Description
	FGameplayEffectContextHandle()
	FGameplayEffectContextHandle ( FGameplayEffectContext* DataPt... )	Constructs from an existing context, should be allocated by new

Destructors

	Name	Description
	~FGameplayEffectContextHandle()

Functions

	Name	Description
void	AddActors ( const TArray< TWeakObjectPtr< AActo..., bool bReset )	Add actors to the stored actor list
void	AddHitResult ( const FHitResult& InHitResult, bool bReset )	Add a hit result for targeting
void	AddInstigator ( AActor* InInstigator, AActor* InEffectCauser )	Sets the instigator and effect causer.
void	AddOrigin ( FVector InOrigin )	Adds an origin point
void	AddSourceObject ( const UObject* NewSourceObject )	Sets the object this effect was created from.
void	Clear()
FGameplayEff...	Duplicate()	Creates a deep copy of this handle, used before modifying
FGameplayEff...	Get()	Returns Raw effet context, may be null
const FGamep...	Get()
const UGamep...	GetAbility()	Returns the Ability CDO
const UGamep...	GetAbilityInstance_NotReplicated()	Returns the Ability Instance (never replicated)
int32	GetAbilityLevel()	Returns level this was executed at
const TArray...	GetActors()	Returns actor list, may be empty
AActor *	GetEffectCauser()	Returns the physical actor tied to the application of this effect
const FHitRe...	GetHitResult()	Returns hit result, this can be null
AActor *	GetInstigator()	Returns the immediate instigator that applied this effect
UAbilitySyst...	GetInstigatorAbilitySystemComponent()	Returns the ability system component of the instigator of this effect
const FVecto...	GetOrigin()	Returns origin point, may be invalid if HasOrigin is false
AActor *	GetOriginalInstigator()	Should always return the original instigator that started the whole chain.
UAbilitySyst...	GetOriginalInstigatorAbilitySystemComponent()	Returns the ability system component of the instigator that started the whole chain
void	GetOwnedGameplayTags ( OUTFGameplayTagContainer& ActorTag..., OUTFGameplayTagContainer& SpecTagC... )	Returns the list of gameplay tags applicable to this effect, defaults to the owner's tags
UObject *...	GetSourceObject()	Returns the object this effect was created from.
bool	HasOrigin()	Returns true if GetOrigin will give valid information
bool	IsLocallyControlled()	Returns if the instigator is locally controlled
bool	IsLocallyControlledPlayer()	Returns if the instigator is locally controlled and a player
bool	IsValid()
bool	NetSerialize ( FArchive& Ar, UPackageMap* Map, bool& bOutSuccess )	Custom serializer, handles polymorphism of context
void	SetAbility ( const UGameplayAbility* InGame... )	Sets Abilit instance and CDO parameters on context
FString	ToString()	Returns debug string

Operators

	Name	Description
bool	operator!= ( FGameplayEffectContextHandle const ... )	Comparison operator
void	operator= ( FGameplayEffectContext* DataPt... )	Sets from an existing context, should be allocated by new
bool	operator== ( FGameplayEffectContextHandle const ... )	Comparison operator

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

Take our survey

Dismiss