1. Epic GamesDeveloper
  3. FGameplayEffectContext

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

API > API/Plugins > API/Plugins/GameplayAbilities

References

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

Syntax

USTRUCT&40;&41;  
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

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

Constructors

  Type Name Description
Public function    
Public function  

FGameplayEffectContext ( AActor* InInstigator,
AActor* InEffectCauser
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual void

AddActors ( const TArray< TWeakObjectPtr< AActor >>& IActor,
bool bReset
)

 Add actors to the stored actor list
Public function Virtual void

AddHitResult ( const FHitResult& InHitResult,
bool bReset
)

 Add a hit result for targeting
Public function Virtual void

AddInstigator ( AActor* InInstigator,
AActor* InEffectCauser
)

 Sets the instigator and effect causer.
Public function Virtual void

AddOrigin ( FVector InOrigin
)

 Adds an origin point
Public function Virtual void

AddSourceObject ( const UObject* NewSourceObject
)

 Sets the object this effect was created from.
Protected function Static bool  
Public function Virtual Const FGameplayEffectContext * Creates a copy of this context, used to duplicate for later modifications
Public function Const const UGameplayAbility * Returns the CDO of the ability used to instigate this context
Public function Const const UGameplayAbility * Returns the specific instance that instigated this, may not always be set
Public function Const int32 Gets the ability level this was evaluated at
Public function Virtual Const const TArray< TWeakObjectPtr< AActor > > & Returns actor list, may be empty
Public function Virtual Const AActor * Returns the physical actor tied to the application of this effect
Public function Virtual FHitResult * Returns hit result, this can be null
Public function Virtual Const const FHitResult * Returns hit result, this can be null
Public function Virtual Const AActor * Returns the immediate instigator that applied this effect
Public function Virtual Const UAbilitySystemComponent * Returns the ability system component of the instigator of this effect
Public function Virtual Const const FVector & Returns origin point, may be invalid if HasOrigin is false
Public function Virtual Const AActor * Should always return the original instigator that started the whole chain.
Public function Virtual Const UAbilitySystemComponent * Returns the ability system component of the instigator that started the whole chain
Public function Virtual Const void

GetOwnedGameplayTags ( FGameplayTagContainer& ActorTagContainer,
FGameplayTagContainer& SpecTagContainer
)

 Returns the list of gameplay tags applicable to this effect, defaults to the owner's tags.
Public function Virtual Const UScriptStruct * Returns the actual struct used for serialization, subclasses must override this!
Public function Virtual Const UObject * Returns the object this effect was created from.
Public function Virtual Const bool Returns true if GetOrigin will give valid information
Public function Virtual Const bool True if this was instigated by a locally controlled actor
Public function Virtual Const bool True if this was instigated by a locally controlled player
Public function Virtual bool

NetSerialize ( FArchive& Ar,
UPackageMap* Map,
bool& bOutSuccess
)

 Custom serialization, subclasses must override this
Public function Virtual void

SetAbility ( const UGameplayAbility* InGameplayAbility
)

 Sets the ability that was used to spawn this
Public function void

SetEffectCauser ( AActor* InEffectCauser
)

 Modify the effect causer actor, useful when that information is added after creation
Public function Virtual Const FString Returns debug string

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page