1. Epic GamesDeveloper
  3. FGameplayEffectModifierMagnitude

FGameplayEffectModifierMagnitude

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

API > API/Plugins > API/Plugins/GameplayAbilities

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

  Type Name Description
Protected variable UProperty Category, EditDefaultsOnly FAttributeBasedFloat AttributeBasedMagnitude Magnitude value represented by an attribute-based float (Coefficient * (PreMultiplyAdditiveValue + [Eval'd Attribute Value According to Policy])) + PostMultiplyAdditiveValue
Protected variable UProperty Category, EditDefaultsOnly FCustomCalculationBasedFloat CustomMagnitude Magnitude value represented by a custom calculation class
Protected variable UProperty Category, EditDefaultsOnly EGameplayEffectMagnitudeCalculation MagnitudeCalculationType Type of calculation to perform to derive the magnitude
Protected variable UProperty Category, EditDefaultsOnly FScalableFloat ScalableFloatMagnitude Magnitude value represented by a scalable float
Protected variable UProperty Category, EditDefaultsOnly FSetByCallerFloat SetByCallerMagnitude Magnitude value represented by a SetByCaller magnitude

Constructors

  Type Name Description
Public function   Default Constructor
Public function   Constructors for setting value in code (for automation tests)
Public function    
Public function    
Public function    

Functions

  Type Name Description
Public function Const bool

AttemptCalculateMagnitude ( const FGameplayEffectSpec& InRelevantSpec,
OUT float& OutCalculatedMagnitude,
bool WarnIfSetByCallerFail,
float DefaultSetbyCaller
)

 Attempts to calculate the magnitude given the provided spec.
Public function Const bool

AttemptRecalculateMagnitudeFromDependentAggregatorChange ( const FGameplayEffectSpec& InRelevantSpec,
OUT float& OutCalculatedMagnitude,
const FAggregator* ChangedAggregator
)

 Attempts to recalculate the magnitude given a changed aggregator.
Public function Const bool

CanCalculateMagnitude ( const FGameplayEffectSpec& InRelevantSpec
)

 Determines if the magnitude can be properly calculated with the specified gameplay effect spec (could fail if relying on an attribute not present, etc.)
Public function Const void Gather all of the attribute capture definitions necessary to compute the magnitude and place them into the provided array
Public function Const TSubclassOf< UGameplayModMagnitudeCalculation > Returns the custom magnitude calculation class, if any, for this magnitude.
Public function Const EGameplayEffectMagnitudeCalculation  
Public function Const bool Returns the DataName associated with this magnitude if it is set by caller
Public function Const const FSetByCallerFloat & Returns SetByCaller data structure, for inspection purposes
Public function Const bool

GetStaticMagnitudeIfPossible ( float InLevel,
float& OutMagnitude,
const FString* ContextString
)

 Returns the magnitude as it was entered in data.
Public function Const FText  
Public function Const void

ReportErrors ( const FString& PathName
)

  
Public function bool Implementing Serialize to clear references to assets that are not needed

Operators

  Type Name Description
Public function Const bool  
Public function Const bool  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page