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 > FActiveGameplayEffectsContainer

Light Theme

Dark Theme

FActiveGameplayEffectsContainer

Active GameplayEffects Container -Bucket of ActiveGameplayEffects -Needed for FFastArraySerialization

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FFastArraySerializer

FActiveGameplayEffectsContainer

References

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

Syntax

USTRUCT()
struct FActiveGameplayEffectsContainer : public FFastArraySerializer

Remarks

Active GameplayEffects Container -Bucket of ActiveGameplayEffects -Needed for FFastArraySerialization

This should only be used by UAbilitySystemComponent. All of this could just live in UAbilitySystemComponent except that we need a distinct USTRUCT to implement FFastArraySerializer.

The preferred way to iterate through the ActiveGameplayEffectContainer is with CreateConstIterator/CreateIterator or stl style range iteration:

for (const FActiveGameplayEffect& Effect : this) {} for (auto It = CreateConstIterator(); It; ++It) {}

Variables

	Name	Description
TArray< DebugEx...	DebugExecutedGameplayEffects	Stores a record of gameplay effects that have executed and their results. Useful for debugging
FOnGivenActiveG...	OnActiveGameplayEffectRemovedDelegate
UAbilitySystemC...	Owner
bool	OwnerIsNetAuthority

Constructors

	Name	Description
	FActiveGameplayEffectsContainer()

Destructors

	Name	Description
	~FActiveGameplayEffectsContainer()

Functions

	Name	Description
FActiveGamep...	ApplyGameplayEffectSpec ( const FGameplayEffectSpec& Spec, FPredictionKey& InPredictionKey, bool& bFoundExistingStackableGE )
void	ApplyModToAttribute ( const FGameplayAttribute& Attribut..., TEnumAsByte< EGameplayModOp::Type >..., float ModifierMagnitude, const FGameplayEffectModCallbackDat... )	Actually applies given mod to the attribute
void	AttemptRemoveActiveEffectsOnEffectApplication ( const FGameplayEffectSpec& InSpec, const FActiveGameplayEffectHandle&... )	Method called during effect application to process if any active effects should be removed from this effects application
bool	CanApplyAttributeModifiers ( const UGameplayEffect* Gamepla..., float Level, const FGameplayEffectContextHandle ... )
void	CaptureAttributeForGameplayEffect ( OUTFGameplayEffectAttributeCaptureS... )	Populate the specified capture spec with the data necessary to capture an attribute from the container
void	CheckDuration ( FActiveGameplayEffectHandle Handle )
void	CloneFrom ( const FActiveGameplayEffectsContain... )	Performs a deep copy on the source container, duplicating all gameplay effects and reconstructing the attribute aggregator map to match the passed in source.
ConstIterato...	CreateConstIterator()
Iterator	CreateIterator()
void	DebugCyclicAggregatorBroadcasts ( FAggregator* Aggregator )
void	DecrementLock()
void	ExecuteActiveEffectsFrom ( FGameplayEffectSpec& Spec, FPredictionKey PredictionKey )	This is the main function that executes a GameplayEffect on Attributes and ActiveGameplayEffects
void	ExecutePeriodicGameplayEffect ( FActiveGameplayEffectHandle Handle )
int32	GetActiveEffectCount ( const FGameplayEffectQuery& Query, bool bEnforceOnGoingCheck )	Get the count of the effects matching the specified query (including stack count)
TArray< FAct...	GetActiveEffects ( const FGameplayEffectQuery& Query )
TArray< floa...	GetActiveEffectsDuration ( const FGameplayEffectQuery& Query )
float	GetActiveEffectsEndTime ( const FGameplayEffectQuery& Query, TArray< AActor* >& Instigator... )
bool	GetActiveEffectsEndTimeAndDuration ( const FGameplayEffectQuery& Query, float& EndTime, float& Duration, TArray< AActor* >& Instigator... )
TArray< floa...	GetActiveEffectsTimeRemaining ( const FGameplayEffectQuery& Query )
TArray< TPai...	GetActiveEffectsTimeRemainingAndDuration ( const FGameplayEffectQuery& Query )
FActiveGamep...	GetActiveGameplayEffect ( const FActiveGameplayEffectHandle H... )
const FActiv...	GetActiveGameplayEffect ( const FActiveGameplayEffectHandle H... )
void	GetActiveGameplayEffectDataByAttribute ( TMultiMap< FGameplayAttribute, FAct... )
TArray< FAct...	GetAllActiveEffectHandles()	Returns an array of all of the active gameplay effect handles
void	GetAllActiveGameplayEffectSpecs ( TArray< FGameplayEffectSpec >& Out... )
float	GetAttributeBaseValue ( FGameplayAttribute Attribute )
float	GetEffectContribution ( const FAggregatorEvaluateParameters..., FActiveGameplayEffectHandle ActiveH..., FGameplayAttribute Attribute )
FOnGameplayA...	GetGameplayAttributeValueChangeDelegate ( FGameplayAttribute Attribute )
float	GetGameplayEffectMagnitude ( FActiveGameplayEffectHandle Handle, FGameplayAttribute Attribute )
const FGamep...	GetGameplayEffectSourceTagsFromHandle ( FActiveGameplayEffectHandle Handle )	Get the source tags from the gameplay spec represented by the specified handle, if possible
void	GetGameplayEffectStartTimeAndDuration ( FActiveGameplayEffectHandle Handle, float& EffectStartTime, float& EffectDuration )
const FGamep...	GetGameplayEffectTargetTagsFromHandle ( FActiveGameplayEffectHandle Handle )	Get the target tags from the gameplay spec represented by the specified handle, if possible
int32	GetNumGameplayEffects()	Returns the total number of gameplay effects.
float	GetServerWorldTime()
float	GetWorldTime()
void	GrabDebugSnapshot ( FVisualLogEntry* Snapshot )
bool	HasApplicationImmunityToSpec ( const FGameplayEffectSpec& SpecToA..., const FActiveGameplayEffect*& ... )
bool	HasPredictedEffectWithPredictedKey ( FPredictionKey PredictionKey )
bool	HasReceivedEffectWithPredictedKey ( FPredictionKey PredictionKey )
void	IncrementLock()
bool	IsServerWorldTimeAvailable()
void	ModifyActiveEffectStartTime ( FActiveGameplayEffectHandle Handle, float StartTimeDiff )
bool	NetDeltaSerialize ( FNetDeltaSerializeInfo& DeltaParms )
void	OnOwnerTagChange ( FGameplayTag TagChange, int32 NewCount )
void	PrintAllGameplayEffects()
void	RecomputeStartWorldTimes ( const float WorldTime, const float ServerWorldTime )	Recomputes the start time for all active abilities
void	RegisterWithOwner ( UAbilitySystemComponent* Owner )
int32	RemoveActiveEffects ( const FGameplayEffectQuery& Query, int32 StacksToRemove )
bool	RemoveActiveGameplayEffect ( FActiveGameplayEffectHandle Handle, int32 StacksToRemove )	Called on server to remove a GameplayEffect
void	SetActiveGameplayEffectLevel ( FActiveGameplayEffectHandle ActiveH..., int32 NewLevel )
void	SetAttributeBaseValue ( FGameplayAttribute Attribute, float NewBaseValue )
void	SetBaseAttributeValueFromReplication ( const FGameplayAttribute& Attribut..., float NewBaseValue, float OldBaseValue )
void	Uninitialize()
void	UpdateActiveGameplayEffectSetByCallerMagnitude ( FActiveGameplayEffectHandle ActiveH..., const FGameplayTag& SetByCallerTag, float NewValue )	Update a set-by-caller magnitude for the active effect to match the new value, if possible
void	UpdateActiveGameplayEffectSetByCallerMagnitudes ( FActiveGameplayEffectHandle ActiveH..., const TMap< FGameplayTag, float >&... )	Update set-by-caller magnitudes for the active effect to match the new values, if possible; Replaces existing values

Classes

	Name	Description
	DebugExecutedGameplayEffectData

Typedefs

Name	Description
ConstIterator
Iterator

Deprecated Functions

		Name	Description
	FOnGameplayA...	RegisterGameplayAttributeEvent ( FGameplayAttribute Attribute )	Use GetGameplayAttributeValueChangeDelegate (the delegate signature has changed)