1. Epic GamesDeveloper
  3. FActiveGameplayEffectsContainer

FActiveGameplayEffectsContainer

Active GameplayEffects Container -Bucket of ActiveGameplayEffects -Needed for FFastArraySerialization

API > API/Plugins > API/Plugins/GameplayAbilities

Inheritance Hierarchy

References

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

Syntax

USTRUCT&40;&41;  
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

  Type Name Description
Public variable TArray< DebugExecutedGameplayEffectData > DebugExecutedGameplayEffects Stores a record of gameplay effects that have executed and their results. Useful for debugging
Public variable FOnGivenActiveGameplayEffectRemoved OnActiveGameplayEffectRemovedDelegate  
Public variable UAbilitySystemComponent * Owner  
Public variable bool OwnerIsNetAuthority  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function FActiveGameplayEffect *

ApplyGameplayEffectSpec ( const FGameplayEffectSpec& Spec,
FPredictionKey& InPredictionKey,
bool& bFoundExistingStackableGE
)

  
Public function void

ApplyModToAttribute ( const FGameplayAttribute& Attribute,
TEnumAsByte< EGameplayModOp::Type > ModifierOp,
float ModifierMagnitude,
const FGameplayEffectModCallbackData* ModData
)

 Actually applies given mod to the attribute
Public function bool

CanApplyAttributeModifiers ( const UGameplayEffect* GameplayEffect,
float Level,
const FGameplayEffectContextHandle& EffectContext
)

  
Public function void Populate the specified capture spec with the data necessary to capture an attribute from the container
Public function void  
Public function void Performs a deep copy on the source container, duplicating all gameplay effects and reconstructing the attribute aggregator map to match the passed in source.
Public function Const ConstIterator  
Public function Iterator  
Public function void  
Public function void  
Public function void This is the main function that executes a GameplayEffect on Attributes and ActiveGameplayEffects
Public function void  
Public function Const int32

GetActiveEffectCount ( const FGameplayEffectQuery& Query,
bool bEnforceOnGoingCheck
)

 Get the count of the effects matching the specified query (including stack count)
Public function Const TArray< FActiveGameplayEffectHandle >  
Public function Const TArray< float >  
Public function Const float

GetActiveEffectsEndTime ( const FGameplayEffectQuery& Query,
TArray< AActor* >& Instigators
)

  
Public function Const bool

GetActiveEffectsEndTimeAndDuration ( const FGameplayEffectQuery& Query,
float& EndTime,
float& Duration,
TArray< AActor* >& Instigators
)

  
Public function Const TArray< float >  
Public function Const TArray< TPair< float, float > >  
Public function FActiveGameplayEffect *  
Public function Const const FActiveGameplayEffect *  
Public function Const void  
Public function Const TArray< FActiveGameplayEffectHandle > Returns an array of all of the active gameplay effect handles
Public function Const void  
Public function Const float  
Public function float  
Public function FOnGameplayAttributeValueChange &  
Public function Const float  
Public function Const const FGameplayTagContainer * Get the source tags from the gameplay spec represented by the specified handle, if possible
Public function Const void

GetGameplayEffectStartTimeAndDuration ( FActiveGameplayEffectHandle Handle,
float& EffectStartTime,
float& EffectDuration
)

  
Public function Const const FGameplayTagContainer * Get the target tags from the gameplay spec represented by the specified handle, if possible
Public function Const int32 Returns the total number of gameplay effects.
Public function Const ELifetimeCondition Returns which ELifetimeCondition can be used for this instance to replicate to relevant connections.
Public function Const float  
Public function Const float  
Public function Const void  
Public function Const bool  
Public function Const bool  
Public function void  
Public function Const bool  
Public function Const bool  
Public function Const bool Return whether the container is using COND_Dynamic and setting the proper condition at runtime.
Public function void  
Public function bool  
Public function void Called every time data has been modified by the FastArraySerializer
Public function void

PredictivelyExecuteEffectSpec ( FGameplayEffectSpec& Spec,
FPredictionKey PredictionKey,
const bool bPredictGameplayCues
)

 Predictively execute a given effect spec.
Public function Const void  
Public function void

RecomputeStartWorldTimes ( const float WorldTime,
const float ServerWorldTime
)

 Recomputes the start time for all active abilities
Public function void  
Public function int32

RemoveActiveEffects ( const FGameplayEffectQuery& Query,
int32 StacksToRemove
)

  
Public function bool

RemoveActiveGameplayEffect ( FActiveGameplayEffectHandle Handle,
int32 StacksToRemove
)

 Called on server to remove a GameplayEffect
Public function void  
Public function void

SetAttributeBaseValue ( FGameplayAttribute Attribute,
float NewBaseValue
)

  
Public function void

SetBaseAttributeValueFromReplication ( const FGameplayAttribute& Attribute,
float NewBaseValue,
float OldBaseValue
)

  
Public function void

SetIsUsingReplicationCondition ( bool bInIsUsingReplicationCondition
)

 Set whether the container is using COND_Dynamic and setting the proper condition at runtime.
Public function void  
Public function void

UpdateActiveGameplayEffectSetByCallerMagnitude ( FActiveGameplayEffectHandle ActiveHandle,
const FGameplayTag& SetByCallerTag,
float NewValue
)

 Update a set-by-caller magnitude for the active effect to match the new value, if possible
Public function void

UpdateActiveGameplayEffectSetByCallerMagnitudes ( FActiveGameplayEffectHandle ActiveHandle,
const TMap< FGameplayTag, float >& NewSetByCallerValues
)

 Update set-by-caller magnitudes for the active effect to match the new values, if possible; Replaces existing values

Classes

  Type Name Description
Public struct DebugExecutedGameplayEffectData    

Typedefs

Name Description
ConstIterator  
Iterator  

Deprecated Functions

  Type Name Description
Public function void AttemptRemoveActiveEffectsOnEffectApplication has been deprecated in favor of URemoveOtherGameplayEffectComponent
Public function Const bool

HasApplicationImmunityToSpec ( const FGameplayEffectSpec& SpecToApply,
const FActiveGameplayEffect*& OutGEThatProvidedImmunity
)

 Use UImmunityGameplayEffectComponent. This function will now always return false.
Public function FOnGameplayAttributeChange & Use GetGameplayAttributeValueChangeDelegate (the delegate signature has changed)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page