1. Epic GamesDeveloper
  3. FGameplayEffectContextHandle

FGameplayEffectContextHandle

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

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 (BlueprintType )  
struct FGameplayEffectContextHandle

Remarks

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

Constructors

  Type Name Description
Public function    
Public function   Constructs from an existing context, should be allocated by new

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

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

 Add actors to the stored actor list
Public function void

AddHitResult ( const FHitResult& InHitResult,
bool bReset
)

 Add a hit result for targeting
Public function void

AddInstigator ( AActor* InInstigator,
AActor* InEffectCauser
)

 Sets the instigator and effect causer.
Public function void

AddOrigin ( FVector InOrigin
)

 Adds an origin point
Public function void

AddSourceObject ( const UObject* NewSourceObject
)

 Sets the object this effect was created from.
Public function void

Clear ()

  
Public function Const FGameplayEffectContextHandle Creates a deep copy of this handle, used before modifying
Public function FGameplayEffectContext *

Get ()

 Returns Raw effet context, may be null
Public function Const const FGameplayEffectContext *

Get ()

  
Public function Const const UGameplayAbility * Returns the Ability CDO
Public function Const const UGameplayAbility * Returns the Ability Instance (never replicated)
Public function Const int32 Returns level this was executed at
Public function 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 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 Const AActor * Should always return the original instigator that started the whole chain.
Public function Const UAbilitySystemComponent * Returns the ability system component of the instigator that started the whole chain
Public function Const void

GetOwnedGameplayTags ( OUTFGameplayTagContainer& ActorTagContainer,
OUTFGameplayTagContainer& SpecTagContainer
)

 Returns the list of gameplay tags applicable to this effect, defaults to the owner's tags
Public function 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 Const bool Returns if the instigator is locally controlled
Public function Const bool Returns if the instigator is locally controlled and a player
Public function Const bool

IsValid ()

  
Public function bool

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

 Custom serializer, handles polymorphism of context
Public function void

SetAbility ( const UGameplayAbility* InGameplayAbility
)

 Sets Ability instance and CDO parameters on context
Public function Const FString Returns debug string

Operators

  Type Name Description
Public function Const bool Comparison operator
Public function void Sets from an existing context, should be allocated by new
Public function Const bool Comparison operator

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page