FGameplayEffectAttributeCaptureSpec::AttemptCalculateAttributeMagnitudeWithBase

Attempts to calculate the magnitude of the captured attribute given the specified parameters, including a starting base value.

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 AttemptCalculateAttributeMagnitudeWithBase
(
    const FAggregatorEvaluateParameters & InEvalParams,
    float InBaseValue,
    OUT float & OutMagnitude
) const

Remarks

Attempts to calculate the magnitude of the captured attribute given the specified parameters, including a starting base value. Can fail if the spec doesn't have a valid capture yet.

Returns

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

Parameters

Parameter

Description

InEvalParams

Parameters to evaluate the attribute under

InBaseValue

Base value to evaluate the attribute under

OutMagnitude

[OUT] Computed 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