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

Light Theme

Dark Theme

FActiveGameplayEffect

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

Windows

MacOS

Linux

Inheritance Hierarchy

FFastArraySerializerItem

FActiveGameplayEffect

References

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

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)([BlueprintType](Programming/UnrealArchitecture/Reference/Structs/Specifiers/BlueprintType))
struct FActiveGameplayEffect : public FFastArraySerializerItem

Remarks

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

Variables

	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
FActiveGameplay...	EventSet	All the bindable events for this active effect (bundled to allow easier non-const access to these events via the ASC)
FActiveGameplay...	Handle	Globally unique ID for identify this active gameplay effect.
bool	IsPendingRemove
FActiveGameplay...	PendingNext
FTimerHandle	PeriodHandle
FPredictionKey	PredictionKey
FGameplayEffect...	Spec
float	StartServerWorldTime	Server time this started
float	StartWorldTime

Constructors

	Name	Description
	FActiveGameplayEffect()	IMPORTANT: Any new state added to FActiveGameplayEffect must be handled in the copy/move constructor/operator
	FActiveGameplayEffect ( const FActiveGameplayEffect& Other )
	FActiveGameplayEffect ( FActiveGameplayEffect&& Other )
	FActiveGameplayEffect ( FActiveGameplayEffectHandle InHandl..., const FGameplayEffectSpec& InSpec, float CurrentWorldTime, float InStartServerWorldTime, FPredictionKey InPredictionKey )

Functions

	Name	Description
void	CheckOngoingTagRequirements ( const FGameplayTagContainer& Owner..., FActiveGameplayEffectsContainer& O..., bool bInvokeGameplayCueEvents )	This is the core function that turns the ActiveGE 'on' or 'off
bool	CheckRemovalTagRequirements ( const FGameplayTagContainer& Owner..., FActiveGameplayEffectsContainer& O... )	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 FActiveGameplayEffectsContain... )
void	PostReplicatedChange ( const FActiveGameplayEffectsContain... )
void	PreReplicatedRemove ( const FActiveGameplayEffectsContain... )
void	PrintAll()
void	RecomputeStartWorldTime ( const FActiveGameplayEffectsContain... )	Refreshes the cached StartWorldTime for this effect.
void	RecomputeStartWorldTime ( const float WorldTime, const float ServerWorldTime )	Refreshes the cached StartWorldTime for this effect.

Operators

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

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

Take our survey

Dismiss