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 > FCustomCalculationBasedFloat > FCustomCalculationBasedFloat::CalculateMagnitude

Light Theme

Dark Theme

FCustomCalculationBasedFloat::CalculateMagnitude

Calculate and return the magnitude of the float given the specified gameplay effect spec.

Choose your operating system:

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

float CalculateMagnitude
(
const FGameplayEffectSpec & InRelevantSpec
) const

Remarks

Calculate and return the magnitude of the float given the specified gameplay effect spec.

@note This function assumes (and asserts on) the existence of the required captured attribute within the spec. It is the responsibility of the caller to verify that the spec is properly setup before calling this function.

Returns

Evaluated magnitude based upon the spec & calculation policy

Parameters

Parameter	Description
InRelevantSpec	Gameplay effect spec providing the backing attribute capture