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

Light Theme

Dark Theme

FGameplayEffectAttributeCaptureSpec

Struct used to hold the result of a gameplay attribute capture; Initially seeded by definition data, but then populated by ability system component when appropriate

Choose your operating system:

Windows

macOS

Linux

References

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

Syntax

USTRUCT()
struct FGameplayEffectAttributeCaptureSpec

Remarks

Struct used to hold the result of a gameplay attribute capture; Initially seeded by definition data, but then populated by ability system component when appropriate

Constructors

	Name	Description
	FGameplayEffectAttributeCaptureSpec()	Constructors.
	FGameplayEffectAttributeCaptureSpec ( const FGameplayEffectAttributeCaptu... )

Functions

	Name	Description
bool	AttemptAddAggregatorModsToAggregator ( OUTFAggregator& OutAggregatorToAdd... )	Attempts to populate the specified aggregator with all of the mods of the backing captured aggregator.
bool	AttemptCalculateAttributeBaseValue ( OUT float& OutBaseValue )	Attempts to calculate the base value of the captured attribute given the specified parameters.
bool	AttemptCalculateAttributeBonusMagnitude ( const FAggregatorEvaluateParameters..., OUT float& OutBonusMagnitude )	Attempts to calculate the "bonus" magnitude (final - base value) of the captured attribute given the specified parameters.
bool	AttemptCalculateAttributeContributionMagnitude ( const FAggregatorEvaluateParameters..., FActiveGameplayEffectHandle ActiveH..., OUT float& OutBonusMagnitude )	Attempts to calculate the contribution of the specified GE to the captured attribute given the specified parameters.
bool	AttemptCalculateAttributeMagnitude ( const FAggregatorEvaluateParameters..., OUT float& OutMagnitude )	Attempts to calculate the magnitude of the captured attribute given the specified parameters.
bool	AttemptCalculateAttributeMagnitudeUpToChannel ( const FAggregatorEvaluateParameters..., EGameplayModEvaluationChannel Final..., OUT float& OutMagnitude )	Attempts to calculate the magnitude of the captured attribute given the specified parameters, up to the specified evaluation channel (inclusive).
bool	AttemptCalculateAttributeMagnitudeWithBase ( const FAggregatorEvaluateParameters..., float InBaseValue, OUT float& OutMagnitude )	Attempts to calculate the magnitude of the captured attribute given the specified parameters, including a starting base value.
bool	AttemptGatherAttributeMods ( const FAggregatorEvaluateParameters..., OUTTMap< EGameplayModEvaluationChan... )	Gathers made for a given capture.
bool	AttemptGetAttributeAggregatorSnapshot ( OUTFAggregator& OutAggregatorSnaps... )	Attempts to populate the specified aggregator with a snapshot of the backing captured aggregator.
const FGamep...	GetBackingDefinition()	Simple accessor to backing capture definition
bool	HasValidCapture()	Returns whether the spec actually has a valid capture yet or not
void	RegisterLinkedAggregatorCallback ( FActiveGameplayEffectHandle Handle )	Register this handle with linked aggregators
bool	ShouldRefreshLinkedAggregator ( const FAggregator* ChangedAggr... )	Return true if this capture should be recalculated if the given aggregator has changed
void	SwapAggregator ( FAggregatorRef From, FAggregatorRef To )	Swaps any internal references From aggregator To aggregator. Used when cloning
void	UnregisterLinkedAggregatorCallback ( FActiveGameplayEffectHandle Handle )	Unregister this handle with linked aggregators