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 > FGameplayEffectCustomExecutionParameters > FGameplayEffectCustomExecutionParameters::AttemptCalculateTransientAggregatorBonusMagnitude

Light Theme

Dark Theme

FGameplayEffectCustomExecutionParameters::AttemptCalculateTransientAggregatorBonusMagnitude

Attempts to calculate the bonus magnitude of a transient aggregator given the specified parameters.

Windows

MacOS

Linux

References

Module	GameplayAbilities
Header	/Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/GameplayEffectExecutionCalculation.h
Include	#include "GameplayEffectExecutionCalculation.h"
Source	/Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Private/GameplayEffectExecutionCalculation.cpp

Syntax

bool AttemptCalculateTransientAggregatorBonusMagnitude
(
    const FGameplayTag & InAggregatorIdentifier,
    const FAggregatorEvaluateParameters & InEvalParams,
    OUT float & OutBonusMagnitude
) const

Remarks

Attempts to calculate the bonus magnitude of a transient aggregator given the specified parameters.

Returns

True if the bonus magnitude was successfully calculated, false if it was not

Parameters

Parameter	Description
InAggregatorIdentifier	Tag identifying the transient aggregator to attempt to calculate the bonus magnitude of
InEvalParams	Parameters to evaluate the attribute under
OutBonusMagnitude	[OUT] Computed bonus magnitude

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss