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

Light Theme

Dark Theme

FAggregatorModChannel

Struct representing an individual aggregation channel/depth. Contains mods of all mod op types.

Choose your operating system:

Windows

macOS

Linux

References

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

Syntax

struct FAggregatorModChannel

Remarks

Struct representing an individual aggregation channel/depth. Contains mods of all mod op types.

Functions

	Name	Description
void	AddMod ( float EvaluatedMagnitude, TEnumAsByte< EGameplayModOp::Type >..., const FGameplayTagRequirements..., const FGameplayTagRequirements..., bool bIsPredicted, const FActiveGameplayEffectHandle&... )	Add a modifier to the channel
void	AddModsFrom ( const FAggregatorModChannel& Other )	Add the specified channel's mods into this channel
float	EvaluateWithBase ( float InlineBaseValue, const FAggregatorEvaluateParameters... )	Evaluates the channel's mods with the specified base value and evaluation parameters
void	ForEachMod ( FAggregatorModInfo& Info, TFunction< void... )	Helper function for iterating through all mods within a channel
void	GetAllAggregatorMods ( EGameplayModEvaluationChannel Chann..., OUTTMap< EGameplayModEvaluationChan... )	Populate a mapping of channel to corresponding mods
void	OnActiveEffectDependenciesSwapped ( const TMap< FActiveGameplayEffectHa... )	Called when the mod channel's gameplay effect dependencies have potentially been swapped out for new ones, like when GE arrays are cloned.
void	RemoveModsWithActiveHandle ( const FActiveGameplayEffectHandle&... )	Remove all mods from the channel that match the specified gameplay effect handle
bool	ReverseEvaluate ( float FinalValue, const FAggregatorEvaluateParameters..., OUT float& ComputedValue )	Evaluates a final value in reverse, attempting to determine a base value from the modifiers within the channel.
float	SumMods ( const TArray< FAggregatorMod >& In..., float Bias, const FAggregatorEvaluateParameters... )	Helper function to sum all of the mods in the specified array, using the specified modifier bias and evaluation parameters
void	UpdateQualifiesOnAllMods ( const FAggregatorEvaluateParameters... )	Runs UpdateQualifies on all mods

Deprecated Functions

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