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

Light Theme

Dark Theme

FGameplayEffectSpec

GameplayEffect Specification.

Windows

MacOS

Linux

References

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

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)([BlueprintType](Programming/UnrealArchitecture/Reference/Structs/Specifiers/BlueprintType))
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

	Name	Description
uint32: 1	bCompletedSourceAttributeCapture	Whether the spec has had its source attribute capture completed or not yet
uint32: 1	bCompletedTargetAttributeCapture	Whether the spec has had its target attribute capture completed or not yet
uint32: 1	bDurationLocked	Whether the duration of the spec is locked or not; If it is, attempts to set it will fail
FGameplayEffect...	CapturedRelevantAttributes	Attributes captured by the spec that are relevant to custom calculations, potentially in owned modifiers, etc.; NOT replicated to clients
FTagContainerAg...	CapturedSourceTags	Captured Source Tags on GameplayEffectSpec creation
FTagContainerAg...	CapturedTargetTags	Tags from the target, captured during execute
float	ChanceToApplyToTarget	The chance, in a 0.0-1.0 range, that this GameplayEffect will be applied to the target Attribute or GameplayEffect
const UGameplay...	Def	GameplayEfect definition. The static data that this spec points to.
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
FGameplayTagCon...	DynamicAssetTags	Tags that are on this effect spec and that did not come from the UGameplayEffect def.
FGameplayTagCon...	DynamicGrantedTags	Tags that are granted and that did not come from the UGameplayEffect def.
TArray< FGamepl...	GrantedAbilitySpecs	List of abilities granted by this effect
TArray< FGamepl...	ModifiedAttributes	A list of attributes that were modified during the application of this spec
TArray< FModifi...	Modifiers	The calcuated modifiers for this effect
float	Period	The period in seconds of this effect, nonperiodic effects should have a period of FGameplayEffectConstants::NO_PERIOD
TMap< FName, fl...	SetByCallerNameMagnitudes	Map of set by caller magnitudes
TMap< FGameplay...	SetByCallerTagMagnitudes
int32	StackCount	Total number of stacks of this effect
TArray< FGamepl...	TargetEffectSpecs	Other effects that need to be applied to the target if this effect is successful

Constructors

	Name	Description
	FGameplayEffectSpec()	IMPORTANT: Any state added to FGameplayEffectSpec must be handled in the move/copy constructor/operator!
	FGameplayEffectSpec ( const FGameplayEffectSpec& Other )
	FGameplayEffectSpec ( FGameplayEffectSpec&& Other )
	FGameplayEffectSpec ( const FGameplayEffectSpec& Other, const FGameplayEffectContextHandle ... )
	FGameplayEffectSpec ( const UGameplayEffect* InDef, const FGameplayEffectContextHandle ..., float Level )

Functions

	Name	Description
FGameplayEff...	AddModifiedAttribute ( const FGameplayAttribute& Attribut... )	Adds a new modified attribute struct, will always add so check to see if it exists first
bool	AttemptCalculateDurationFromDef ( OUT float& OutDefDuration )	Helper function to attempt to calculate the duration of the spec from its GE definition
float	CalculateModifiedDuration()	Helper function that returns the duration after applying relevant modifiers from the source and target ability system components
void	CalculateModifierMagnitudes()	Fills out the modifier magnitudes inside the Modifier Specs
void	CaptureAttributeDataFromTarget ( UAbilitySystemComponent* Targe... )
void	CopySetByCallerMagnitudes ( const FGameplayEffectSpec& Origina... )	Copies SetbyCallerMagnitudes from OriginalSpec into this
void	DuplicateEffectContext()
void	GetAllAssetTags ( OUTFGameplayTagContainer& Containe... )	Appends all tags that apply to this gameplay effect spec
void	GetAllGrantedTags ( OUTFGameplayTagContainer& Containe... )	Appends all tags granted by this gameplay effect spec
float	GetChanceToApplyToTarget()
FGameplayEff...	GetContext()
float	GetDuration()
const FGamep...	GetEffectContext()
float	GetLevel()
const FGamep...	GetModifiedAttribute ( const FGameplayAttribute& Attribut... )	Looks for an existing modified attribute struct, may return NULL
FGameplayEff...	GetModifiedAttribute ( const FGameplayAttribute& Attribut... )	Looks for an existing modified attribute struct, may return NULL
float	GetModifierMagnitude ( int32 ModifierIdx, bool bFactorInStackCount )	Get the computed magnitude of the modifier on the spec with the specified index
float	GetPeriod()
float	GetSetByCallerMagnitude ( FName DataName, bool WarnIfNotFound, float DefaultIfNotFound )	Returns the magnitude of a SetByCaller modifier.
float	GetSetByCallerMagnitude ( FGameplayTag DataTag, bool WarnIfNotFound, float DefaultIfNotFound )	Returns the magnitude of a SetByCaller modifier.
bool	HasValidCapturedAttributes ( const TArray< FGameplayEffectAttrib... )	Determines if the spec has capture specs with valid captures for all of the specified definitions.
void	Initialize ( const UGameplayEffect* InDef, const FGameplayEffectContextHandle ..., float Level )	Can be called manually but it is preferred to use the 3 parameter constructor
void	InitializeFromLinkedSpec ( const UGameplayEffect* InDef, const FGameplayEffectSpec& Origina... )	Initialize the spec as a linked spec.
void	MergeSetByCallerMagnitudes ( const TMap< FGameplayTag, float >&... )	Copies SetbuCallerMagnitudes, but only if magnitudes don't exist in our map (slower but preserves data)
void	PrintAll()
void	RecaptureAttributeDataForClone ( UAbilitySystemComponent* Origi..., UAbilitySystemComponent* NewAS... )	Recapture attributes from source and target for cloning
void	RecaptureSourceActorTags()	Recaptures source actor tags of this spec without modifying anything else
void	SetContext ( FGameplayEffectContextHandle NewEff... )	Set the context info: who and where this spec came from.
void	SetDuration ( float NewDuration, bool bLockDuration )	Sets duration.
void	SetLevel ( float InLevel )
void	SetSetByCallerMagnitude ( FName DataName, float Magnitude )	Sets the magnitude of a SetByCaller modifier
void	SetSetByCallerMagnitude ( FGameplayTag DataTag, float Magnitude )	Sets the magnitude of a SetByCaller modifier
void	SetupAttributeCaptureDefinitions()	Helper function to initialize all of the capture definitions required by the spec
FString	ToSimpleString()

Operators

		Name	Description
	FGameplayEff...	operator= ( const FGameplayEffectSpec& Other )
	FGameplayEff...	operator= ( FGameplayEffectSpec&& Other )

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

Take our survey

Dismiss