FGameplayEffectAttributeCaptureSpec::AttemptCalculateAttributeContributionMagnitude

Attempts to calculate the contribution of the specified GE to the captured attribute given the specified parameters.

Windows
MacOS
Linux

References

Module

GameplayAbilities

Header

/Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/GameplayEffect.h

Include

#include "GameplayEffect.h"

Source

/Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Private/GameplayEffect.cpp

Syntax

bool AttemptCalculateAttributeContributionMagnitude
(
    const FAggregatorEvaluateParameters & InEvalParams,
    FActiveGameplayEffectHandle ActiveHandle,
    OUT float & OutBonusMagnitude
) const

Remarks

Attempts to calculate the contribution of the specified GE to the captured attribute given the specified parameters. Can fail if the spec doesn't have a valid capture yet.

Returns

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

Parameters

Parameter

Description

InEvalParams

Parameters to evaluate the attribute under

ActiveHandle

Handle of the gameplay effect to query about

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