FActiveGameplayEffect | Unreal Engine 5.6 Documentation

Inheritance Hierarchy


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

USTRUCT (BlueprintType )  
struct FActiveGameplayEffect : public FFastArraySerializerItem

Active GameplayEffect instance -What GameplayEffect Spec -Start time -When to execute next -Replication callbacks

Type	Name	Description
bool	bIsInhibited	Not sure if this should replicate or not. If replicated, we may have trouble where IsInhibited doesn't appear to change when we do tag checks (because it was previously inhibited, but replication made it inhibited).
bool	bPendingRepOnActiveGC	When replicated down, we cue the GC events until the entire list of active gameplay effects has been received
bool	bPendingRepWhileActiveGC
float	CachedStartServerWorldTime	Used for handling duration modifications being replicated
int32	ClientCachedStackCount	Last StackCount that the client had.
FTimerHandle	DurationHandle
FActiveGameplayEffectEvents	EventSet	All the bindable events for this active effect (bundled to allow easier non-const access to these events via the ASC)
TArray< FGameplayAbilitySpecHandle >	GrantedAbilityHandles	Handles of Gameplay Abilities that were granted to the target by this Active Gameplay Effect
FActiveGameplayEffectHandle	Handle	Globally unique ID for identify this active gameplay effect.
bool	IsPendingRemove
FActiveGameplayEffect *	PendingNext	Cached pointer.
FTimerHandle	PeriodHandle
FPredictionKey	PredictionKey
FGameplayEffectSpec	Spec
float	StartServerWorldTime	Server time this started
float	StartWorldTime

	Type	Name	Description
		FActiveGameplayEffect ()	IMPORTANT: Any new state added to FActiveGameplayEffect must be handled in the copy/move constructor/operator
		FActiveGameplayEffect ( const FActiveGameplayEffect& Other )	These need to be defined because we need to omit PendingNext from move operations and the base class isn't trivially copyable.
		FActiveGameplayEffect ( FActiveGameplayEffect&& Other )
		FActiveGameplayEffect ( FActiveGameplayEffectHandle InHandle, const FGameplayEffectSpec& InSpec, float CurrentWorldTime, float InStartServerWorldTime, FPredictionKey InPredictionKey )

Type	Name	Description
void	CheckOngoingTagRequirements ( const FGameplayTagContainer& OwnerTags, FActiveGameplayEffectsContainer& OwningContainer, bool bInvokeGameplayCueEvents )	This was the core function that turns the ActiveGE 'on' or 'off.
bool	CheckRemovalTagRequirements ( const FGameplayTagContainer& OwnerTags, FActiveGameplayEffectsContainer& OwningContainer )	Method to check if this effect should remove because the owner tags pass the RemovalTagRequirements requirement check
FString	GetDebugString ()	Debug string used by Fast Array serialization
float	GetDuration ()
float	GetEndTime ()
float	GetPeriod ()
float	GetTimeRemaining ( float WorldTime )
void	PostReplicatedAdd ( const FActiveGameplayEffectsContainer& InArray )
void	PostReplicatedChange ( const FActiveGameplayEffectsContainer& InArray )
void	PreReplicatedRemove ( const FActiveGameplayEffectsContainer& InArray )
void	PrintAll ()
void	RecomputeStartWorldTime ( const FActiveGameplayEffectsContainer& InArray )	Refreshes the cached StartWorldTime for this effect.
void	RecomputeStartWorldTime ( const float WorldTime, const float ServerWorldTime )	Refreshes the cached StartWorldTime for this effect.

	Type	Name	Description
	FActiveGameplayEffect &	operator= ( const FActiveGameplayEffect& other )
	FActiveGameplayEffect &	operator= ( FActiveGameplayEffect&& other )
	bool	operator== ( const FActiveGameplayEffect& Other )