1. Epic GamesDeveloper
  3. FGameplayEffectAttributeCaptureSpec

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

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

  Type Name Description
Public function   Constructors.
Public function    

Functions

  Type Name Description
Public function Const bool Attempts to populate the specified aggregator with all of the mods of the backing captured aggregator.
Public function Const bool

AttemptCalculateAttributeBaseValue ( float& OutBaseValue
)

 Attempts to calculate the base value of the captured attribute given the specified parameters.
Public function Const bool

AttemptCalculateAttributeBonusMagnitude ( const FAggregatorEvaluateParameters& InEvalParams,
float& OutBonusMagnitude
)

 Attempts to calculate the "bonus" magnitude (final - base value) of the captured attribute given the specified parameters.
Public function Const bool

AttemptCalculateAttributeContributionMagnitude ( const FAggregatorEvaluateParameters& InEvalParams,
FActiveGameplayEffectHandle ActiveHandle,
float& OutBonusMagnitude
)

 Attempts to calculate the contribution of the specified GE to the captured attribute given the specified parameters.
Public function Const bool

AttemptCalculateAttributeMagnitude ( const FAggregatorEvaluateParameters& InEvalParams,
float& OutMagnitude
)

 Attempts to calculate the magnitude of the captured attribute given the specified parameters.
Public function Const bool Attempts to calculate the magnitude of the captured attribute given the specified parameters, up to the specified evaluation channel (inclusive).
Public function Const bool

AttemptCalculateAttributeMagnitudeWithBase ( const FAggregatorEvaluateParameters& InEvalParams,
float InBaseValue,
float& OutMagnitude
)

 Attempts to calculate the magnitude of the captured attribute given the specified parameters, including a starting base value.
Public function Const bool Gathers made for a given capture.
Public function Const bool Attempts to populate the specified aggregator with a snapshot of the backing captured aggregator.
Public function Const const FGameplayEffectAttributeCaptureDefinition & Simple accessor to backing capture definition
Public function Const bool Returns whether the spec actually has a valid capture yet or not
Public function Const void Register this handle with linked aggregators
Public function Const bool

ShouldRefreshLinkedAggregator ( const FAggregator* ChangedAggregator
)

 Return true if this capture should be recalculated if the given aggregator has changed
Public function void Swaps any internal references From aggregator To aggregator. Used when cloning
Public function Const void Unregister this handle with linked aggregators

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page