1. Epic GamesDeveloper
  3. FAggregator

FAggregator

API > API/Plugins > API/Plugins/GameplayAbilities

Inheritance Hierarchy

References

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

Syntax

struct FAggregator : public TSharedFromThis< FAggregator >

Variables

  Type Name Description
Public variable FAggregatorEvaluateMetaData * EvaluationMetaData Custom meta data for the aggregator
Public variable int32 NetUpdateID NetworkID that we had our last update from.
Public variable FOnAggregatorDirty OnDirty  
Public variable FOnAggregatorDirty OnDirtyRecursive  

Constructors

  Type Name Description
Public function  

FAggregator ( float InBaseValue
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddAggregatorMod ( float EvaluatedData,
TEnumAsByte< EGameplayModOp::Type > ModifierOp,
EGameplayModEvaluationChannel ModifierChannel,
const FGameplayTagRequirements* SourceTagReqs,
const FGameplayTagRequirements* TargetTagReqs,
bool IsPredicted,
FActiveGameplayEffectHandle ActiveHandle
)

  
Public function void  
Public function void

AddModsFrom ( const FAggregator& SourceAggregator
)

  
Public function Const float

Evaluate ( const FAggregatorEvaluateParameters& Parameters
)

 Evaluates the Aggregator with the internal base value and given parameters
Public function Const float Evaluates the Aggregator to compute its "bonus" (final - base) value
Public function Const float Evaluates the contribution from the GE associated with ActiveHandle
Public function Const void Calls ::UpdateQualifies on each mod. Useful for when you need to manually inspect aggregators
Public function Const float Evaluates the aggregator with the internal base value and given parameters, up to the specified evaluation channel (inclusive)
Public function Const float

EvaluateWithBase ( float InlineBaseValue,
const FAggregatorEvaluateParameters& Parameters
)

 Evaluates the Aggregator with an arbitrary base value
Public function void

ExecModOnBaseValue ( TEnumAsByte< EGameplayModOp::Type > ModifierOp,
float EvaluatedMagnitude
)

  
Public function Const void Helper function for iterating through all mods within the aggregator
Public function Const void Populate a mapping of channel to corresponding mods
Public function Const float Simple accessor to base value
Public function void Called when the aggregator's gameplay effect dependencies have potentially been swapped out for new ones, like when GE arrays are cloned.
Public function void Removes all mods for the passed in handle and marks this as dirty to recalculate the aggregator
Public function void  
Public function Const float

ReverseEvaluate ( float FinalValue,
const FAggregatorEvaluateParameters& Parameters
)

 Works backwards to calculate the base value. Used on clients for doing predictive modifiers
Public function void

SetBaseValue ( float NewBaseValue,
bool BroadcastDirtyEvent
)

  
Public function Static float

StaticExecModOnBaseValue ( float BaseValue,
TEnumAsByte< EGameplayModOp::Type > ModifierOp,
float EvaluatedMagnitude
)

  
Public function void

TakeSnapshotOf ( const FAggregator& AggToSnapshot
)

  
Public function void

UpdateAggregatorMod ( FActiveGameplayEffectHandle ActiveHandle,
const FGameplayAttribute& Attribute,
const FGameplayEffectSpec& Spec,
bool bWasLocallyGenerated,
FActiveGameplayEffectHandle InHandle
)

 Updates the aggregators for the past in handle, this will handle it so the UAttributeSets stats only get one update for the delta change

Typedefs

Name Description
FOnAggregatorDirty  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page