1. Epic GamesDeveloper
  3. FGameplayEffectSpec

FGameplayEffectSpec

GameplayEffect Specification.

API > API/Plugins > API/Plugins/GameplayAbilities

References

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

Syntax

USTRUCT&40;BlueprintType&41;  
struct FGameplayEffectSpec

Remarks

GameplayEffect Specification. Tells us: -What UGameplayEffect (const data) -What Level -Who instigated

FGameplayEffectSpec is modifiable. We start with initial conditions and modifications be applied to it. In this sense, it is stateful/mutable but it is still distinct from an FActiveGameplayEffect which in an applied instance of an FGameplayEffectSpec.

Variables

  Type Name Description
Public variable UProperty notreplicated uint32: 1 bCompletedSourceAttributeCapture Whether the spec has had its source attribute capture completed or not yet
Public variable UProperty notreplicated uint32: 1 bCompletedTargetAttributeCapture Whether the spec has had its target attribute capture completed or not yet
Public variable UProperty notreplicated uint32: 1 bDurationLocked Whether the duration of the spec is locked or not; If it is, attempts to set it will fail
Public variable UProperty notreplicated FGameplayEffectAttributeCaptureSpecContainer CapturedRelevantAttributes Attributes captured by the spec that are relevant to custom calculations, potentially in owned modifiers, etc.; NOT replicated to clients
Public variable UProperty notreplicated FTagContainerAggregator CapturedSourceTags Captured Source Tags on GameplayEffectSpec creation
Public variable UProperty notreplicated FTagContainerAggregator CapturedTargetTags Tags from the target, captured during execute
Public variable UProperty TObjectPtr< const UGameplayEffect > Def GameplayEfect definition. The static data that this spec points to.
Public variable UProperty float Duration The duration in seconds of this effect instantaneous effects should have a duration of FGameplayEffectConstants::INSTANT_APPLICATION effects that last forever should have a duration of FGameplayEffectConstants::INFINITE_DURATION
Public variable UProperty FGameplayTagContainer DynamicGrantedTags Tags that are granted and that did not come from the UGameplayEffect def.
Public variable UProperty TArray< FGameplayEffectModifiedAttribute > ModifiedAttributes A list of attributes that were modified during the application of this spec
Public variable UProperty TArray< FModifierSpec > Modifiers The calculated modifiers for this effect
Public variable UProperty float Period The period in seconds of this effect, nonperiodic effects should have a period of FGameplayEffectConstants::NO_PERIOD
Public variable TMap< FName, float > SetByCallerNameMagnitudes Map of set by caller magnitudes
Public variable TMap< FGameplayTag, float > SetByCallerTagMagnitudes  

Constructors

  Type Name Description
Public function   IMPORTANT: Any state added to FGameplayEffectSpec must be handled in the move/copy constructor/operator!
Public function    
Public function    
Public function  

FGameplayEffectSpec ( const FGameplayEffectSpec& Other,
const FGameplayEffectContextHandle& InEffectContext
)

  
Public function  

FGameplayEffectSpec ( const UGameplayEffect* InDef,
const FGameplayEffectContextHandle& InEffectContext,
float Level
)

  

Functions

  Type Name Description
Public function void

AddDynamicAssetTag ( const FGameplayTag& TagToAdd
)

 Dynamically add an asset tag not originally from the source GE definition; Added to DynamicAssetTags as well as injected into the captured source spec tags
Public function FGameplayEffectModifiedAttribute * Adds a new modified attribute struct, will always add so check to see if it exists first
Public function void Dynamically append asset tags not originally from the source GE definition; Added to DynamicAssetTags as well as injected into the captured source spec tags
Public function Const bool

AttemptCalculateDurationFromDef ( float& OutDefDuration
)

 Helper function to attempt to calculate the duration of the spec from its GE definition
Public function Const float Helper function that returns the duration after applying relevant modifiers from the source and target ability system components
Public function void Fills out the modifier magnitudes inside the Modifier Specs
Public function void

CaptureAttributeDataFromTarget ( UAbilitySystemComponent* TargetAbilitySystemComponent
)

  
Public function void Copies SetbyCallerMagnitudes from OriginalSpec into this
Public function void  
Public function Const void Appends all tags that apply to this gameplay effect spec
Public function Const void Appends all blocked ability tags granted by this gameplay effect spec
Public function Const void Appends all tags granted by this gameplay effect spec
Public function Const FGameplayEffectContextHandle  
Public function Const float  
Public function Const const FGameplayTagContainer & Simple const accessor to the dynamic asset tags
Public function Const const FGameplayEffectContextHandle &  
Public function Const float  
Public function FGameplayEffectModifiedAttribute * Looks for an existing modified attribute struct, may return NULL
Public function Const const FGameplayEffectModifiedAttribute * Looks for an existing modified attribute struct, may return NULL
Public function Const float

GetModifierMagnitude ( int32 ModifierIdx,
bool bFactorInStackCount
)

 Get the computed magnitude of the modifier on the spec with the specified index
Public function Const float  
Public function Const float

GetSetByCallerMagnitude ( FGameplayTag DataTag,
bool WarnIfNotFound,
float DefaultIfNotFound
)

 Returns the magnitude of a SetByCaller modifier.
Public function Const float

GetSetByCallerMagnitude ( FName DataName,
bool WarnIfNotFound,
float DefaultIfNotFound
)

 Returns the magnitude of a SetByCaller modifier.
Public function Const int32 Returns the stack count for this GE spec.
Public function Const bool Determines if the spec has capture specs with valid captures for all of the specified definitions.
Public function void

Initialize ( const UGameplayEffect* InDef,
const FGameplayEffectContextHandle& InEffectContext,
float Level
)

 Can be called manually but it is preferred to use the 3 parameter constructor
Public function void

InitializeFromLinkedSpec ( const UGameplayEffect* InDef,
const FGameplayEffectSpec& OriginalSpec
)

 Initialize the spec as a linked spec.
Public function void

MergeSetByCallerMagnitudes ( const TMap< FGameplayTag, float >& Magnitudes
)

 Copies SetbuCallerMagnitudes, but only if magnitudes don't exist in our map (slower but preserves data)
Public function Const void  
Public function void Recapture attributes from source and target for cloning
Public function void Recaptures source actor tags of this spec without modifying anything else
Public function void

SetContext ( FGameplayEffectContextHandle NewEffectContext,
bool bSkipRecaptureSourceActorTags
)

 Set the context info: who and where this spec came from.
Public function void

SetDuration ( float NewDuration,
bool bLockDuration
)

 Sets duration.
Public function void

SetLevel ( float InLevel
)

  
Public function void

SetSetByCallerMagnitude ( FName DataName,
float Magnitude
)

 Sets the magnitude of a SetByCaller modifier
Public function void

SetSetByCallerMagnitude ( FGameplayTag DataTag,
float Magnitude
)

 Sets the magnitude of a SetByCaller modifier
Public function void

SetStackCount ( int32 NewStackCount
)

 Sets the stack count for this GE to NewStackCount if stacking is supported.
Public function void Helper function to initialize all of the capture definitions required by the spec
Public function Const FString  

Operators

  Type Name Description
Public function FGameplayEffectSpec &  
Public function FGameplayEffectSpec &

operator= ( const FGameplayEffectSpec& Other
)

  

Deprecated Variables

  Type Name Description
Public variable UProperty float ChanceToApplyToTarget This variable no longer has any effect. See UChanceToApplyGameplayEffectComponent
Public variable UProperty FGameplayTagContainer DynamicAssetTags This member will be made private. Please use AddDynamicAssetTag, AppendDynamicAssetTags, or GetDynamicAssetTags as appropriate. Note that dynamic asset tag removal will no longer be supported.
Public variable UProperty TArray< FGameplayAbilitySpecDef > GrantedAbilitySpecs This variable will be removed in favor of (immutable) GASpecs that live on GameplayEffectComponents (e.g. AbilitiesGameplayEffectComponent)
Public variable UProperty int32 StackCount This member will be moved to private in the future. Use GetStackCount and SetStackCount.
Public variable TArray< FGameplayEffectSpecHandle > TargetEffectSpecs These TargetEffectSpecs are not replicated, thus can only apply to the server. Use UAdditionalGameplayEffectComponent instead (or roll your own solution)

Deprecated Functions

  Type Name Description
Public function Const float This no longer applies. Use UChanceToApplyGameplayEffectComponent instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page