1. Epic GamesDeveloper
  3. FAggregatorModChannel

FAggregatorModChannel

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

API > API/Plugins > API/Plugins/GameplayAbilities

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

   
Name FAggregatorModChannel
Type struct
Header File /Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/GameplayEffectAggregator.h
Include Path #include "GameplayEffectAggregator.h"

Syntax

struct FAggregatorModChannel

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Mods TArray< FAggregatorMod > Collection of modifers within the channel, organized by modifier operation GameplayEffectAggregator.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddMod ( float EvaluatedMagnitude,
TEnumAsByte< EGameplayModOp::Type > ModOp,
const FGameplayTagRequirements* SourceTagReqs,
const FGameplayTagRequirements* TargetTagReqs,
bool bIsPredicted,
const FActiveGameplayEffectHandle& ActiveHandle
)

 Add a modifier to the channel GameplayEffectAggregator.h  

void AddModsFrom ( const FAggregatorModChannel& Other
)

 Add the specified channel's mods into this channel GameplayEffectAggregator.h  

float EvaluateWithBase ( float InlineBaseValue,
const FAggregatorEvaluateParameters& Parameters
) const

 Evaluates the channel's mods with the specified base value and evaluation parameters GameplayEffectAggregator.h  

void ForEachMod ( FAggregatorModInfo& Info,
TFunction< void(const FAggregatorModInfo&) > Func
) const

 Helper function for iterating through all mods within a channel GameplayEffectAggregator.h  

void GetAllAggregatorMods ( EGameplayModEvaluationChannel Channel,
TMap< EGameplayModEvaluationChannel, const TArray< FAggregatorMod >* >& OutMods
) const

 Populate a mapping of channel to corresponding mods GameplayEffectAggregator.h  
Called when the mod channel's gameplay effect dependencies have potentially been swapped out for new ones, like when GE arrays are cloned. GameplayEffectAggregator.h  

void RemoveModsWithActiveHandle ( const FActiveGameplayEffectHandle& Handle
)

 Remove all mods from the channel that match the specified gameplay effect handle GameplayEffectAggregator.h  

bool ReverseEvaluate ( float FinalValue,
const FAggregatorEvaluateParameters& Parameters,
float& ComputedValue
) const

 Evaluates a final value in reverse, attempting to determine a base value from the modifiers within the channel. GameplayEffectAggregator.h  

void UpdateQualifiesOnAllMods ( const FAggregatorEvaluateParameters& Parameters
) const

 Runs UpdateQualifies on all mods GameplayEffectAggregator.h  

Static

Name Remarks Include Path Unreal Specifiers

static float SumMods ( const TArray< FAggregatorMod >& InMods,
float Bias,
const FAggregatorEvaluateParameters& Parameters
)

 Helper function to sum all of the mods in the specified array, using the specified modifier bias and evaluation parameters GameplayEffectAggregator.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page