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

Light Theme

Dark Theme

FAggregatorModChannelContainer

Struct representing a container of modifier channels

Windows

MacOS

Linux

References

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

Syntax

struct FAggregatorModChannelContainer

Remarks

Struct representing a container of modifier channels

Functions

	Name	Description
void	AddModsFrom ( const FAggregatorModChannelContaine... )	Adds the mods from specified container to this one
void	EvaluateQualificationForAllMods ( const FAggregatorEvaluateParameters... )	Calls ::UpdateQualifies on each mod
float	EvaluateWithBase ( float InlineBaseValue, const FAggregatorEvaluateParameters... )	Evaluates the result of the specified base value run through each existing evaluation channel's modifiers in numeric order with the specified evaluation parameters.
float	EvaluateWithBaseToChannel ( float InlineBaseValue, const FAggregatorEvaluateParameters..., EGameplayModEvaluationChannel Final... )	Similar to EvaluateWithBase (see comment there for details), but terminates early after evaluating the specified final channel instead of continuing through every possible channel
FAggregatorM...	FindOrAddModChannel ( EGameplayModEvaluationChannel Chann... )	Find or add a modifier channel for the specified enum value
void	ForEachMod ( TFunction< void... )	Helper function for iterating through all mods within the channel container
void	GetAllAggregatorMods ( OUTTMap< EGameplayModEvaluationChan... )	Populate a mapping of channel to corresponding mods for debugging purposes
int32	GetNumChannels()	Simple accessor to the current number of modifier channels active
void	OnActiveEffectDependenciesSwapped ( const TMap< FActiveGameplayEffectHa... )	Called when the container's gameplay effect dependencies have potentially been swapped out for new ones, like when GE arrays are cloned.
void	RemoveAggregatorMod ( const FActiveGameplayEffectHandle&... )	Removes any mods from every channel matching the specified handle
float	ReverseEvaluate ( float FinalValue, const FAggregatorEvaluateParameters... )	Evaluates a final value in reverse, attempting to determine a base value from the modifiers within all of the channels.

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