1. Epic GamesDeveloper
  3. FGameplayEffectCustomExecutionParameters

FGameplayEffectCustomExecutionParameters

Struct representing parameters for a custom gameplay effect execution.

Unreal Engine C++ API Reference > Plugins > GameplayAbilities

References

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

Syntax

USTRUCT (BlueprintType )  
struct FGameplayEffectCustomExecutionParameters

Remarks

Struct representing parameters for a custom gameplay effect execution. Should not be held onto via reference, used just for the scope of the execution

Constructors

  Type Name Description
Public function   Constructors.
Public function  

FGameplayEffectCustomExecutionParameters ( FGameplayEffectSpec& InOwningSpec,
const TArray< FGameplayEffectExecutionScopedModifierInfo >& InScopedMods,
UAbilitySystemComponent* InTargetAbilityComponent,
const FGameplayTagContainer& InPassedIntags,
const FPredictionKey& InPredictionKey
)

  
Public function  

FGameplayEffectCustomExecutionParameters ( FGameplayEffectSpec& InOwningSpec,
const TArray< FGameplayEffectExecutionScopedModifierInfo >& InScopedMods,
UAbilitySystemComponent* InTargetAbilityComponent,
const FGameplayTagContainer& InPassedIntags,
const FPredictionKey& InPredictionKey,
const TArray< FActiveGameplayEffectHandle >& InIgnoreHandles
)

  

Functions

  Type Name Description
Public function Const bool Attempts to calculate the base value of a captured attribute given the specified parameters.
Public function Const bool

AttemptCalculateCapturedAttributeBonusMagnitude ( const FGameplayEffectAttributeCaptureDefinition& InCaptureDef,
const FAggregatorEvaluateParameters& InEvalParams,
OUT float& OutBonusMagnitude
)

 Attempts to calculate the bonus magnitude of a captured attribute given the specified parameters.
Public function Const bool Attempts to calculate the magnitude of a captured attribute given the specified parameters.
Public function Const bool

AttemptCalculateCapturedAttributeMagnitudeWithBase ( const FGameplayEffectAttributeCaptureDefinition& InCaptureDef,
const FAggregatorEvaluateParameters& InEvalParams,
float InBaseValue,
OUT float& OutMagnitude
)

 Attempts to calculate the magnitude of a captured attribute given the specified parameters, including a starting base value.
Public function Const bool

AttemptCalculateTransientAggregatorBaseValue ( const FGameplayTag& InAggregatorIdentifier,
OUT float& OutBaseValue
)

 Attempts to calculate the base value of a transient aggregator given the specified parameters.
Public function Const bool

AttemptCalculateTransientAggregatorBonusMagnitude ( const FGameplayTag& InAggregatorIdentifier,
const FAggregatorEvaluateParameters& InEvalParams,
OUT float& OutBonusMagnitude
)

 Attempts to calculate the bonus magnitude of a transient aggregator given the specified parameters.
Public function Const bool

AttemptCalculateTransientAggregatorMagnitude ( const FGameplayTag& InAggregatorIdentifier,
const FAggregatorEvaluateParameters& InEvalParams,
OUT float& OutMagnitude
)

 Attempts to calculate the magnitude of a transient aggregator given the specified parameters.
Public function Const bool

AttemptCalculateTransientAggregatorMagnitudeWithBase ( const FGameplayTag& InAggregatorIdentifier,
const FAggregatorEvaluateParameters& InEvalParams,
float InBaseValue,
OUT float& OutMagnitude
)

 Attempts to calculate the magnitude of a transient aggregator given the specified parameters, including a starting base value.
Public function Const bool Returns all modifiers for a given captured def.
Public function Const bool

AttemptGetCapturedAttributeAggregatorSnapshot ( const FGameplayTag& InAggregatorIdentifier,
OUTFAggregator& OutSnapshottedAggregator
)

 Attempts to populate the specified aggregator with a snapshot of a backing transient aggregator.
Public function Const bool Attempts to populate the specified aggregator with a snapshot of a backing captured aggregator.
Public function Const bool Runs given TFunction on every qualifier mod for a given AttributeCaptureDefinition
Public function Const TArray< FActiveGameplayEffectHandle >  
Public function Const const FGameplayEffectSpec & Simple accessor to owning gameplay spec
Public function Const FGameplayEffectSpec * Non const access. Be careful with this, especially when modifying a spec after attribute capture.
Public function Const const FGameplayTagContainer & Simple accessor to the Passed In Tags to this execution
Public function Const FPredictionKey  
Public function Const UAbilitySystemComponent * Simple accessor to source ability system component (could be null!)
Public function Const UAbilitySystemComponent * Simple accessor to target ability system component

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page