FAttributeBasedFloat

Struct representing a float whose magnitude is dictated by a backing attribute and a calculation policy, follows basic form of: (Coefficient * (PreMultiplyAdditiveValue + [Eval'd Attribute Value According to Policy])) + PostMultiplyAdditiveValue

Windows
MacOS
Linux

References

Module

GameplayAbilities

Header

/Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/GameplayEffect.h

Include

#include "GameplayEffect.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)()
struct FAttributeBasedFloat

Remarks

Struct representing a float whose magnitude is dictated by a backing attribute and a calculation policy, follows basic form of: (Coefficient * (PreMultiplyAdditiveValue + [Eval'd Attribute Value According to Policy])) + PostMultiplyAdditiveValue

Variables

Name Description

Public variable UProperty Category, EditDefaultsOnly

EAttributeBased...

 

AttributeCalculationType

Calculation policy in regards to the attribute

Public variable UProperty Category, EditDefaultsOnly

FCurveTableRowH...

 

AttributeCurve

If a curve table entry is specified, the attribute will be used as a lookup into the curve instead of using the attribute directly.

Public variable UProperty Category, EditDefaultsOnly

FGameplayEffect...

 

BackingAttribute

Attribute backing the calculation

Public variable UProperty Category, EditDefaultsOnly

FScalableFloat

 

Coefficient

Coefficient to the attribute calculation

Public variable UProperty Category, EditDefaultsOnly

EGameplayModEva...

 

FinalChannel

Channel to terminate evaluation on when using AttributeEvaluatedUpToChannel calculation type

Public variable UProperty Category, EditDefaultsOnly

FScalableFloat

 

PostMultiplyAdditiveValue

Additive value to the attribute calculation, added in after the coefficient applies

Public variable UProperty Category, EditDefaultsOnly

FScalableFloat

 

PreMultiplyAdditiveValue

Additive value to the attribute calculation, added in before the coefficient applies

Public variable UProperty Category, EditDefaultsOnly

FGameplayTagCon...

 

SourceTagFilter

Filter to use on source tags; If specified, only modifiers applied with all of these tags will factor into the calculation

Public variable UProperty Category, EditDefaultsOnly

FGameplayTagCon...

 

TargetTagFilter

Filter to use on target tags; If specified, only modifiers applied with all of these tags will factor into the calculation

Constructors

Name Description

Public function

FAttributeBasedFloat()

Constructor

Functions

Name Description

Public function Const

float

 

CalculateMagnitude

(
    const FGameplayEffectSpec& InRelev...
)

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

Operators

Name Description

Public function Const

bool

 

operator!=

(
    const FAttributeBasedFloat& Other
)

Public function Const

bool

 

operator==

(
    const FAttributeBasedFloat& Other
)

Equality/Inequality operators

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss