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 > FGameplayEffectAttributeCaptureSpec > FGameplayEffectAttributeCaptureSpec::AttemptCalculateAttributeMagnitudeUpToChannel

Light Theme

Dark Theme

FGameplayEffectAttributeCaptureSpec::AttemptCalculateAttributeMagnitudeUpToChannel

Attempts to calculate the magnitude of the captured attribute given the specified parameters, up to the specified evaluation channel (inclusive).

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 AttemptCalculateAttributeMagnitudeUpToChannel
(
    const FAggregatorEvaluateParameters & InEvalParams,
    EGameplayModEvaluationChannel FinalChannel,
    OUT float & OutMagnitude
) const

Remarks

Attempts to calculate the magnitude of the captured attribute given the specified parameters, up to the specified evaluation channel (inclusive). 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
FinalChannel	Evaluation channel to terminate the calculation at
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