Navigation
API > API/Plugins > API/Plugins/GameplayAbilities
| Name | FAggregator |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/GameplayEffectAggregator.h |
| Include Path | #include "GameplayEffectAggregator.h" |
Syntax
struct FAggregator : public TSharedFromThis< FAggregator >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FAggregator
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAggregator
(
float InBaseValue |
GameplayEffectAggregator.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FAggregator() |
GameplayEffectAggregator.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnAggregatorDirty | TMulticastDelegate_OneParam< void, FAggregator * > | GameplayEffectAggregator.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| EvaluationMetaData | FAggregatorEvaluateMetaData * | Custom meta data for the aggregator | GameplayEffectAggregator.h | |
| NetUpdateID | int32 | NetworkID that we had our last update from. | GameplayEffectAggregator.h | |
| OnDirty | FOnAggregatorDirty | GameplayEffectAggregator.h | ||
| OnDirtyRecursive | FOnAggregatorDirty | GameplayEffectAggregator.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BaseValue | float | GameplayEffectAggregator.h | ||
| BroadcastingDirtyCount | int32 | GameplayEffectAggregator.h | ||
| Dependents | TArray< FActiveGameplayEffectHandle > | ActiveGE handles that we need to notify if we change. NOT copied over during snapshots. | GameplayEffectAggregator.h | |
| ModChannels | FAggregatorModChannelContainer | GameplayEffectAggregator.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddAggregatorMod
(
float EvaluatedData, |
GameplayEffectAggregator.h | ||
void AddDependent
(
FActiveGameplayEffectHandle Handle |
GameplayEffectAggregator.h | ||
void AddModsFrom
(
const FAggregator& SourceAggregator |
GameplayEffectAggregator.h | ||
float Evaluate
(
const FAggregatorEvaluateParameters& Parameters |
Evaluates the Aggregator with the internal base value and given parameters | GameplayEffectAggregator.h | |
float EvaluateBonus
(
const FAggregatorEvaluateParameters& Parameters |
Evaluates the Aggregator to compute its "bonus" (final - base) value | GameplayEffectAggregator.h | |
float EvaluateContribution
(
const FAggregatorEvaluateParameters& Parameters, |
Evaluates the contribution from the GE associated with ActiveHandle | GameplayEffectAggregator.h | |
void EvaluateQualificationForAllMods
(
const FAggregatorEvaluateParameters& Parameters |
Calls ::UpdateQualifies on each mod. Useful for when you need to manually inspect aggregators | GameplayEffectAggregator.h | |
float EvaluateToChannel
(
const FAggregatorEvaluateParameters& Parameters, |
Evaluates the aggregator with the internal base value and given parameters, up to the specified evaluation channel (inclusive) | GameplayEffectAggregator.h | |
float EvaluateWithBase
(
float InlineBaseValue, |
Evaluates the Aggregator with an arbitrary base value | GameplayEffectAggregator.h | |
void ExecModOnBaseValue
(
TEnumAsByte< EGameplayModOp::Type > ModifierOp, |
GameplayEffectAggregator.h | ||
void ForEachMod
(
TFunction< void(const FAggregatorModInfo&) > |
Helper function for iterating through all mods within the aggregator | GameplayEffectAggregator.h | |
void GetAllAggregatorMods
(
TMap< EGameplayModEvaluationChannel, const TArray< FAggregatorMod >* >& OutMods |
Populate a mapping of channel to corresponding mods | GameplayEffectAggregator.h | |
float GetBaseValue() |
Simple accessor to base value | GameplayEffectAggregator.h | |
void OnActiveEffectDependenciesSwapped
(
const TMap< FActiveGameplayEffectHandle, FActiveGameplayEffectHandle >& SwappedDependencies |
Called when the aggregator's gameplay effect dependencies have potentially been swapped out for new ones, like when GE arrays are cloned. | GameplayEffectAggregator.h | |
void RemoveAggregatorMod
(
FActiveGameplayEffectHandle ActiveHandle |
Removes all mods for the passed in handle and marks this as dirty to recalculate the aggregator | GameplayEffectAggregator.h | |
void RemoveDependent
(
FActiveGameplayEffectHandle Handle |
GameplayEffectAggregator.h | ||
float ReverseEvaluate
(
float FinalValue, |
Works backwards to calculate the base value. Used on clients for doing predictive modifiers | GameplayEffectAggregator.h | |
void SetBaseValue
(
float NewBaseValue, |
GameplayEffectAggregator.h | ||
void TakeSnapshotOf
(
const FAggregator& AggToSnapshot |
GameplayEffectAggregator.h | ||
void UpdateAggregatorMod
(
FActiveGameplayEffectHandle ActiveHandle, |
Updates the aggregators for the past in handle, this will handle it so the UAttributeSets stats only get one update for the delta change | GameplayEffectAggregator.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static float StaticExecModOnBaseValue
(
float BaseValue, |
GameplayEffectAggregator.h |