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

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

   
Name UGameplayModMagnitudeCalculation
Type class
Header File /Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/GameplayModMagnitudeCalculation.h
Include Path #include "GameplayModMagnitudeCalculation.h"

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UGameplayModMagnitudeCalculation ( const FObjectInitializer& ObjectInitializer
)

   GameplayModMagnitudeCalculation.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

float CalculateBaseMagnitude ( const FGameplayEffectSpec& Spec
) const

 Calculate the base magnitude of the gameplay effect modifier, given the specified spec. GameplayModMagnitudeCalculation.h
  • BlueprintNativeEvent
  • Category="Calculation"

virtual FOnExternalGameplayModifierDependencyChange * GetExternalModifierDependencyMulticast ( const FGameplayEffectSpec& Spec,
UWorld* World
) const

 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. GameplayModMagnitudeCalculation.h  

bool ShouldAllowNonNetAuthorityDependencyRegistration()

 Simple accessor to bAllowNonNetAuthorityDependencyRegistration with some validation: Read the comment on that variable for usage!!! GameplayModMagnitudeCalculation.h  

Protected

Name Remarks Include Path Unreal Specifiers

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

 Convenience method to get attribute magnitude during a CalculateMagnitude call GameplayModMagnitudeCalculation.h  

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

 Extracts the Set by Caller Magnitude from a Gameplay Effect Spec GameplayModMagnitudeCalculation.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="Ability|GameplayEffect"

float GetSetByCallerMagnitudeByTag ( const FGameplayEffectSpec& EffectSpec,
const FGameplayTag& Tag
) const

 Extracts the Set by Caller Magnitude from a Gameplay Effect Spec GameplayModMagnitudeCalculation.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="Ability|GameplayEffect"

const FGameplayTagContainer & GetSourceActorTags ( const FGameplayEffectSpec& EffectSpec
) const

 Returns the source actor tags from a Gameplay Effect Spec GameplayModMagnitudeCalculation.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

FGameplayTagContainer GetSourceAggregatedTags ( const FGameplayEffectSpec& EffectSpec
) const

 Copies and returns the source aggregated tags from a Gameplay Effect Spec GameplayModMagnitudeCalculation.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="Ability|GameplayEffect"

const FGameplayTagContainer & GetSourceSpecTags ( const FGameplayEffectSpec& EffectSpec
) const

 Returns the source spec tags from a Gameplay Effect Spec GameplayModMagnitudeCalculation.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

const FGameplayTagContainer & GetTargetActorTags ( const FGameplayEffectSpec& EffectSpec
) const

 Returns the target actor tags from a Gameplay Effect Spec Useful for Modifier Magnitude Calculations GameplayModMagnitudeCalculation.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

FGameplayTagContainer GetTargetAggregatedTags ( const FGameplayEffectSpec& EffectSpec
) const

 Copies and returns the target aggregated tags from a Gameplay Effect Spec GameplayModMagnitudeCalculation.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="Ability|GameplayEffect"

const FGameplayTagContainer & GetTargetSpecTags ( const FGameplayEffectSpec& EffectSpec
) const

 Returns the target spec tags from a Gameplay Effect Spec Useful for Modifier Magnitude Calculations GameplayModMagnitudeCalculation.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

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

 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 GameplayModMagnitudeCalculation.h
  • BlueprintCallable
  • BlueprintPure=false
  • Category="Ability|GameplayEffect"
  • Meta=(DisplayName="Get Captured Attribute Magnitude", ScriptName="GetCapturedAttributeMagnitude")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page