FAggregatorModChannel

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

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

Public function

void

 

AddMod

(
    float EvaluatedMagnitude,
    TEnumAsByte< EGameplayModOp::Type >...,
    const FGameplayTagRequirements*...,
    const FGameplayTagRequirements*...,
    bool bIsPredicted,
    const FActiveGameplayEffectHandle&...
)

Add a modifier to the channel

Public function

void

 

AddModsFrom

(
    const FAggregatorModChannel& Other
)

Add the specified channel's mods into this channel

Public function Const

float

 

EvaluateWithBase

(
    float InlineBaseValue,
    const FAggregatorEvaluateParameters...
)

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

Public function Const

void

 

ForEachMod

(
    FAggregatorModInfo& Info,
    TFunction< void...
)

Helper function for iterating through all mods within a channel

Public function Const

void

 

GetAllAggregatorMods

(
    EGameplayModEvaluationChannel Chann...,
    OUTTMap< EGameplayModEvaluationChan...
)

Populate a mapping of channel to corresponding mods

Public function

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.

Public function

void

 

RemoveModsWithActiveHandle

(
    const FActiveGameplayEffectHandle&...
)

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

Public function Const

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.

Public function Static

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

Public function Const

void

 

UpdateQualifiesOnAllMods

(
    const FAggregatorEvaluateParameters...
)

Runs UpdateQualifies on all mods

Deprecated Functions

Name Description

Public function Const

void

 

DebugGetAllAggregatorMods

(
    EGameplayModEvaluationChannel Chann...,
    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