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

Light Theme

Dark Theme

FGameplayEffectContext

Data structure that stores an instigator and related data, such as positions and targets Games can subclass this structure and add game-specific information It is passed throughout effect execution so it is a great place to track transient information about an execution

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

Remarks

Data structure that stores an instigator and related data, such as positions and targets Games can subclass this structure and add game-specific information It is passed throughout effect execution so it is a great place to track transient information about an execution

Variables

	Name	Description
TWeakObjectPtr<...	AbilityCDO	The ability CDO that is responsible for this effect context (replicated)
TWeakObjectPtr<...	AbilityInstanceNotReplicated	The ability instance that is responsible for this effect context (NOT replicated)
int32	AbilityLevel	The level this was executed at
TArray< TWeakOb...	Actors	Actors referenced by this context
uint8: 1	bHasWorldOrigin
uint8: 1	bReplicateSourceObject	True if the SourceObject can be replicated. This bool is not replicated itself.
TWeakObjectPtr<...	EffectCauser	The physical actor that actually did the damage, can be a weapon or projectile
TSharedPtr< FHi...	HitResult	Trace information - may be nullptr in many cases
TWeakObjectPtr<...	Instigator	Instigator actor, the actor that owns the ability system component
TWeakObjectPtr<...	InstigatorAbilitySystemComponent	The ability system component that's bound to instigator
TWeakObjectPtr<...	SourceObject	Object this effect was created from, can be an actor or static object.
FVector	WorldOrigin	Stored origin, may be invalid if bHasWorldOrigin is false

Constructors

	Name	Description
	FGameplayEffectContext()
	FGameplayEffectContext ( AActor* InInstigator, AActor* InEffectCauser )

Destructors

	Name	Description
	~FGameplayEffectContext()

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.
FGameplayEff...	Duplicate()	Creates a copy of this context, used to duplicate for later modifications
const UGamep...	GetAbility()	Returns the CDO of the ability used to instigate this context
const UGamep...	GetAbilityInstance_NotReplicated()	Returns the specific instance that instigated this, may not always be set
int32	GetAbilityLevel()	Gets the ability level this was evaluated 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
FHitResult &...	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
UScriptStruc...	GetScriptStruct()	Returns the actual struct used for serialization, subclasses must override this!
UObject *...	GetSourceObject()	Returns the object this effect was created from.
bool	HasOrigin()	Returns true if GetOrigin will give valid information
bool	IsLocallyControlled()	True if this was instigated by a locally controlled actor
bool	IsLocallyControlledPlayer()	True if this was instigated by a locally controlled player
bool	NetSerialize ( FArchive& Ar, UPackageMap* Map, bool& bOutSuccess )	Custom serialization, subclasses must override this
void	SetAbility ( const UGameplayAbility* InGame... )	Sets the ability that was used to spawn this
void	SetEffectCauser ( AActor* InEffectCauser )	Modify the effect causer actor, useful when that information is added after creation
FString	ToString()	Returns debug string

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

Take our survey

Dismiss