1. Epic GamesDeveloper
  3. UGameplayModMagnitudeCalculation

UGameplayModMagnitudeCalculation

Class used to perform custom gameplay effect modifier calculations, either via blueprint or native code

API > API/Plugins > API/Plugins/GameplayAbilities

Inheritance Hierarchy

References

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

Syntax

UCLASS (BlueprintType, Blueprintable, Abstract)  
class UGameplayModMagnitudeCalculation : public UGameplayEffectCalculation

Remarks

Class used to perform custom gameplay effect modifier calculations, either via blueprint or native code

Variables

  Type Name Description
Protected variable UProperty Category, EditDefaultsOnly, AdvancedDisplay bool bAllowNonNetAuthorityDependencyRegistration Whether the calculation allows non-net authorities to register the external dependency multi-cast delegate or not; Effectively whether clients are allowed to perform the custom calculation themselves or not

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const UFunction Category blueprintnativeevent float Calculate the base magnitude of the gameplay effect modifier, given the specified spec.
Protected function Const bool

GetCapturedAttributeMagnitude ( const FGameplayEffectAttributeCaptureDefinition& Def,
const FGameplayEffectSpec& Spec,
const FAggregatorEvaluateParameters& EvaluationParameters,
OUT float& Magnitude
)

 Convenience method to get attribute magnitude during a CalculateMagnitude call
Public function Virtual Const FOnExternalGameplayModifierDependencyChange * If the magnitude resultant from the custom calculation depends on game code-specific conditions that are not under the purview of the ability system, this method should be overridden to provide a multicast delegate that will fire when the reliant conditions change, so that the magnitude can be recalculated and updated.
Protected function Const UFunction BlueprintCallable, BlueprintPure, Category float

GetSetByCallerMagnitudeByName ( const FGameplayEffectSpec& EffectSpec,
const FName& MagnitudeName
)

 Extracts the Set by Caller Magnitude from a Gameplay Effect Spec
Protected function Const UFunction BlueprintCallable, BlueprintPure, Category float Extracts the Set by Caller Magnitude from a Gameplay Effect Spec
Protected function Const UFunction BlueprintCallable, Category const FGameplayTagContainer &

GetSourceActorTags ( const FGameplayEffectSpec& EffectSpec
)

 Returns the source actor tags from a Gameplay Effect Spec
Protected function Const UFunction BlueprintCallable, BlueprintPure, Category FGameplayTagContainer Copies and returns the source aggregated tags from a Gameplay Effect Spec
Protected function Const UFunction BlueprintCallable, Category const FGameplayTagContainer &

GetSourceSpecTags ( const FGameplayEffectSpec& EffectSpec
)

 Returns the source spec tags from a Gameplay Effect Spec
Protected function Const UFunction BlueprintCallable, Category const FGameplayTagContainer &

GetTargetActorTags ( const FGameplayEffectSpec& EffectSpec
)

 Returns the target actor tags from a Gameplay Effect Spec Useful for Modifier Magnitude Calculations
Protected function Const UFunction BlueprintCallable, BlueprintPure, Category FGameplayTagContainer Copies and returns the target aggregated tags from a Gameplay Effect Spec
Protected function Const UFunction BlueprintCallable, Category const FGameplayTagContainer &

GetTargetSpecTags ( const FGameplayEffectSpec& EffectSpec
)

 Returns the target spec tags from a Gameplay Effect Spec Useful for Modifier Magnitude Calculations
Protected function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta float

K2_GetCapturedAttributeMagnitude ( const FGameplayEffectSpec& EffectSpec,
FGameplayAttribute Attribute,
const FGameplayTagContainer& SourceTags,
const FGameplayTagContainer& TargetTags
)

 Gets the captured magnitude value for the given Attribute For this to work correctly, the Attribute needs to be added to the Relevant Attributes to Capture array
Public function Const bool Simple accessor to bAllowNonNetAuthorityDependencyRegistration with some validation: Read the comment on that variable for usage!!!

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page