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::AttemptCalculateCapturedAttributeMagnitudeWithBase

Light Theme

Dark Theme

FGameplayEffectCustomExecutionParameters::AttemptCalculateCapturedAttributeMagnitudeWithBase

Attempts to calculate the magnitude of a 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/GameplayEffectExecutionCalculation.h
Include	#include "GameplayEffectExecutionCalculation.h"
Source	/Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Private/GameplayEffectExecutionCalculation.cpp

Syntax

bool AttemptCalculateCapturedAttributeMagnitudeWithBase
(
    const FGameplayEffectAttributeCaptureDefinition & InCaptureDef,
    const FAggregatorEvaluateParameters & InEvalParams,
    float InBaseValue,
    OUT float & OutMagnitude
) const

Remarks

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

Returns

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

Parameters

Parameter	Description
InCaptureDef	Attribute definition to attempt to calculate the magnitude of
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