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 > FGameplayEffectModifierMagnitude

Light Theme

Dark Theme

FGameplayEffectModifierMagnitude

Struct representing the magnitude of a gameplay effect modifier, potentially calculated in numerous different ways

Choose your operating system:

Windows

macOS

Linux

References

Module	GameplayAbilities
Header	/Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/GameplayEffect.h
Include	#include "GameplayEffect.h"

Syntax

USTRUCT()
struct FGameplayEffectModifierMagnitude

Remarks

Struct representing the magnitude of a gameplay effect modifier, potentially calculated in numerous different ways

Variables

	Name	Description
FAttributeBased...	AttributeBasedMagnitude	Magnitude value represented by an attribute-based float (Coefficient * (PreMultiplyAdditiveValue + [Eval'd Attribute Value According to Policy])) + PostMultiplyAdditiveValue
FCustomCalculat...	CustomMagnitude	Magnitude value represented by a custom calculation class
EGameplayEffect...	MagnitudeCalculationType	Type of calculation to perform to derive the magnitude
FScalableFloat	ScalableFloatMagnitude	Magnitude value represented by a scalable float
FSetByCallerFlo...	SetByCallerMagnitude	Magnitude value represented by a SetByCaller magnitude

Constructors

	Name	Description
	FGameplayEffectModifierMagnitude()	Default Constructor
	FGameplayEffectModifierMagnitude ( const FScalableFloat& Value )	Constructors for setting value in code (for automation tests)
	FGameplayEffectModifierMagnitude ( const FAttributeBasedFloat& Value )
	FGameplayEffectModifierMagnitude ( const FCustomCalculationBasedFloat ... )
	FGameplayEffectModifierMagnitude ( const FSetByCallerFloat& Value )

Functions

	Name	Description
bool	AttemptCalculateMagnitude ( const FGameplayEffectSpec& InRelev..., OUT float& OutCalculatedMagnitude, bool WarnIfSetByCallerFail, float DefaultSetbyCaller )	Attempts to calculate the magnitude given the provided spec.
bool	AttemptRecalculateMagnitudeFromDependentAggregatorChange ( const FGameplayEffectSpec& InRelev..., OUT float& OutCalculatedMagnitude, const FAggregator* ChangedAggr... )	Attempts to recalculate the magnitude given a changed aggregator.
bool	CanCalculateMagnitude ( const FGameplayEffectSpec& InRelev... )	Determines if the magnitude can be properly calculated with the specified gameplay effect spec (could fail if relying on an attribute not present, etc.)
void	GetAttributeCaptureDefinitions ( OUTTArray< FGameplayEffectAttribute... )	Gather all of the attribute capture definitions necessary to compute the magnitude and place them into the provided array
TSubclassOf<...	GetCustomMagnitudeCalculationClass()	Returns the custom magnitude calculation class, if any, for this magnitude.
EGameplayEff...	GetMagnitudeCalculationType()
bool	GetSetByCallerDataNameIfPossible ( FName& OutDataName )	Returns the DataName associated with this magnitude if it is set by caller
const FSetBy...	GetSetByCallerFloat()	Returns SetByCaller data structure, for inspection purposes
bool	GetStaticMagnitudeIfPossible ( float InLevel, float& OutMagnitude, const FString* ContextString )	Returns the magnitude as it was entered in data.
FText	GetValueForEditorDisplay()
void	ReportErrors ( const FString& PathName )
bool	Serialize ( FArchive& Ar )	Implementing Serialize to clear references to assets that are not needed

Operators

		Name	Description
	bool	operator!= ( const FGameplayEffectModifierMagnit... )
	bool	operator== ( const FGameplayEffectModifierMagnit... )