Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > GameplayAbilities > FGameplayEffectCustomExecutionParameters

Light Theme

Dark Theme

FGameplayEffectCustomExecutionParameters

Struct representing parameters for a custom gameplay effect execution.

Windows

MacOS

Linux

References

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

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)([BlueprintType](Programming/UnrealArchitecture/Reference/Structs/Specifiers/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

	Name	Description
	FGameplayEffectCustomExecutionParameters()	Constructors.
	FGameplayEffectCustomExecutionParameters ( FGameplayEffectSpec& InOwningSpec, const TArray< FGameplayEffectExecut..., UAbilitySystemComponent* InTar..., const FGameplayTagContainer& InPas..., const FPredictionKey& InPrediction... )
	FGameplayEffectCustomExecutionParameters ( FGameplayEffectSpec& InOwningSpec, const TArray< FGameplayEffectExecut..., UAbilitySystemComponent* InTar..., const FGameplayTagContainer& InPas..., const FPredictionKey& InPrediction..., const TArray< FActiveGameplayEffect... )

Functions

	Name	Description
bool	AttemptCalculateCapturedAttributeBaseValue ( const FGameplayEffectAttributeCaptu..., OUT float& OutBaseValue )	Attempts to calculate the base value of a captured attribute given the specified parameters.
bool	AttemptCalculateCapturedAttributeBonusMagnitude ( const FGameplayEffectAttributeCaptu..., const FAggregatorEvaluateParameters..., OUT float& OutBonusMagnitude )	Attempts to calculate the bonus magnitude of a captured attribute given the specified parameters.
bool	AttemptCalculateCapturedAttributeMagnitude ( const FGameplayEffectAttributeCaptu..., const FAggregatorEvaluateParameters..., OUT float& OutMagnitude )	Attempts to calculate the magnitude of a captured attribute given the specified parameters.
bool	AttemptCalculateCapturedAttributeMagnitudeWithBase ( const FGameplayEffectAttributeCaptu..., const FAggregatorEvaluateParameters..., float InBaseValue, OUT float& OutMagnitude )	Attempts to calculate the magnitude of a captured attribute given the specified parameters, including a starting base value.
bool	AttemptCalculateTransientAggregatorBaseValue ( const FGameplayTag& InAggregatorId..., OUT float& OutBaseValue )	Attempts to calculate the base value of a transient aggregator given the specified parameters.
bool	AttemptCalculateTransientAggregatorBonusMagnitude ( const FGameplayTag& InAggregatorId..., const FAggregatorEvaluateParameters..., OUT float& OutBonusMagnitude )	Attempts to calculate the bonus magnitude of a transient aggregator given the specified parameters.
bool	AttemptCalculateTransientAggregatorMagnitude ( const FGameplayTag& InAggregatorId..., const FAggregatorEvaluateParameters..., OUT float& OutMagnitude )	Attempts to calculate the magnitude of a transient aggregator given the specified parameters.
bool	AttemptCalculateTransientAggregatorMagnitudeWithBase ( const FGameplayTag& InAggregatorId..., const FAggregatorEvaluateParameters..., float InBaseValue, OUT float& OutMagnitude )	Attempts to calculate the magnitude of a transient aggregator given the specified parameters, including a starting base value.
bool	AttemptGatherAttributeMods ( const FGameplayEffectAttributeCaptu..., const FAggregatorEvaluateParameters..., OUTTMap< EGameplayModEvaluationChan... )	Returns all modifiers for a given captured def.
bool	AttemptGetCapturedAttributeAggregatorSnapshot ( const FGameplayTag& InAggregatorId..., OUTFAggregator& OutSnapshottedAggr... )	Attempts to populate the specified aggregator with a snapshot of a backing transient aggregator.
bool	AttemptGetCapturedAttributeAggregatorSnapshot ( const FGameplayEffectAttributeCaptu..., OUTFAggregator& OutSnapshottedAggr... )	Attempts to populate the specified aggregator with a snapshot of a backing captured aggregator.
bool	ForEachQualifiedAttributeMod ( const FGameplayEffectAttributeCaptu..., const FAggregatorEvaluateParameters..., TFunction< void... )	Runs given TFunction on every qualifier mod for a given AttributeCaptureDefinition
TArray< FAct...	GetIgnoreHandles()
const FGamep...	GetOwningSpec()	Simple accessor to owning gameplay spec
FGameplayEff...	GetOwningSpecForPreExecuteMod()	Non const access. Be careful with this, especially when modifying a spec after attribute capture.
const FGamep...	GetPassedInTags()	Simple accessor to the Passed In Tags to this execution
FPredictionK...	GetPredictionKey()
UAbilitySyst...	GetSourceAbilitySystemComponent()	Simple accessor to source ability system component (could be null!)
UAbilitySyst...	GetTargetAbilitySystemComponent()	Simple accessor to target ability system component

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

Take our survey

Dismiss