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

Light Theme

Dark Theme

FAggregator

Windows

MacOS

Linux

Inheritance Hierarchy

TSharedFromThis

FAggregator

References

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

Syntax

struct FAggregator : public TSharedFromThis< FAggregator >

Variables

	Name	Description
FAggregatorEval...	EvaluationMetaData	Custom meta data for the aggregator
int32	NetUpdateID	NetworkID that we had our last update from.
FOnAggregatorDi...	OnDirty
FOnAggregatorDi...	OnDirtyRecursive

Constructors

	Name	Description
	FAggregator ( float InBaseValue )

Destructors

	Name	Description
	~FAggregator()

Functions

	Name	Description
void	AddAggregatorMod ( float EvaluatedData, TEnumAsByte< EGameplayModOp::Type >..., EGameplayModEvaluationChannel Modif..., const FGameplayTagRequirements..., const FGameplayTagRequirements..., bool IsPredicted, FActiveGameplayEffectHandle ActiveH... )
void	AddDependent ( FActiveGameplayEffectHandle Handle )
void	AddModsFrom ( const FAggregator& SourceAggregato... )
float	Evaluate ( const FAggregatorEvaluateParameters... )	Evaluates the Aggregator with the internal base value and given parameters
float	EvaluateBonus ( const FAggregatorEvaluateParameters... )	Evaluates the Aggregator to compute its "bonus" (final - base) value
float	EvaluateContribution ( const FAggregatorEvaluateParameters..., FActiveGameplayEffectHandle ActiveH... )	Evaluates the contribution from the GE associated with ActiveHandle
void	EvaluateQualificationForAllMods ( const FAggregatorEvaluateParameters... )	Calls ::UpdateQualifies on each mod. Useful for when you need to manually inspect aggregators
float	EvaluateToChannel ( const FAggregatorEvaluateParameters..., EGameplayModEvaluationChannel Final... )	Evaluates the aggregator with the internal base value and given parameters, up to the specified evaluation channel (inclusive)
float	EvaluateWithBase ( float InlineBaseValue, const FAggregatorEvaluateParameters... )	Evaluates the Aggregator with an arbitrary base value
void	ExecModOnBaseValue ( TEnumAsByte< EGameplayModOp::Type >..., float EvaluatedMagnitude )
void	ForEachMod ( TFunction< void... )	Helper function for iterating through all mods within the aggregator
void	GetAllAggregatorMods ( OUTTMap< EGameplayModEvaluationChan... )	Populate a mapping of channel to corresponding mods
float	GetBaseValue()	Simple accessor to base value
void	OnActiveEffectDependenciesSwapped ( const TMap< FActiveGameplayEffectHa... )	Called when the aggregator's gameplay effect dependencies have potentially been swapped out for new ones, like when GE arrays are cloned.
void	RemoveAggregatorMod ( FActiveGameplayEffectHandle ActiveH... )	Removes all mods for the passed in handle and marks this as dirty to recalculate the aggregator
void	RemoveDependent ( FActiveGameplayEffectHandle Handle )
float	ReverseEvaluate ( float FinalValue, const FAggregatorEvaluateParameters... )	Works backwards to calculate the base value. Used on clients for doing predictive modifiers
void	SetBaseValue ( float NewBaseValue, bool BroadcastDirtyEvent )
float	StaticExecModOnBaseValue ( float BaseValue, TEnumAsByte< EGameplayModOp::Type >..., float EvaluatedMagnitude )
void	TakeSnapshotOf ( const FAggregator& AggToSnapshot )
void	UpdateAggregatorMod ( FActiveGameplayEffectHandle ActiveH..., const FGameplayAttribute& Attribut..., const FGameplayEffectSpec& Spec, bool bWasLocallyGenerated, FActiveGameplayEffectHandle InHandl... )	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

Deprecated Functions

		Name	Description
	void	DebugGetAllAggregatorMods ( OUTTMap< EGameplayModEvaluationChan... )	Use GetAllAggregatorMods

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

Take our survey

Dismiss