1. Epic GamesDeveloper
  3. UGameplayEffect

UGameplayEffect

[UGameplayEffect](API\Plugins\GameplayAbilities\UGameplayEffect) The GameplayEffect definition.

Unreal Engine C++ API Reference > Plugins > GameplayAbilities

Inheritance Hierarchy

References

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

Syntax

UCLASS (Blueprintable, prioritizeCategories="Status Duration GameplayEffect GameplayCues Stacking",  
       Meta=(ShortTooltip="A GameplayEffect modifies attributes and tags."))  
class UGameplayEffect :  
    public UObject ,  
    public IGameplayTagAssetInterface

Remarks

UGameplayEffect The GameplayEffect definition. This is the data asset defined in the editor that drives everything. This is only blueprintable to allow for templating gameplay effects. Gameplay effects should NOT contain blueprint graphs.

Variables

  Type Name Description
Public variable UProperty Category, Meta BlueprintReadOnly FGameplayTagRequirements ApplicationTagRequirements Tag requirements for this GameplayEffect to be applied to a target.
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly bool bClearStackOnOverflow If true, the entire stack of the effect will be cleared once it overflows
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly bool bDenyOverflowApplication If true, stacking attempts made while at the stack count will fail, resulting in the duration and context not being refreshed
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly bool bExecutePeriodicEffectOnApplication If true, the effect executes on application and then at every period interval.
Public variable UProperty Category, EditDefaultsOnly BlueprintReadOnly bool bRequireModifierSuccessToTriggerCues If true, cues will only trigger when GE modifiers succeed being applied (whether through modifiers or executions)
Public variable UProperty Category, EditDefaultsOnly bool bSuppressStackingCues If true, GameplayCues will only be triggered for the first instance in a stacking GameplayEffect.
Public variable FGameplayTagContainer CachedAssetTags Cached Component Data - Do not modify these at runtime! If you want to manipulate these, write your own GameplayEffectComponent set the data during PostLoad.
Public variable FGameplayTagContainer CachedBlockedAbilityTags Cached copy of all the tags this GE applies to its target to block Gameplay Abilities.
Public variable FGameplayTagContainer CachedGrantedTags Cached copy of all the tags this GE grants to its target. Data populated during PostLoad.
Public variable UProperty Category, Meta BlueprintReadOnly TArray< FConditionalGameplayEffect > ConditionalGameplayEffects Other gameplay effects that will be applied to the target of this effect if this effect applies
Public variable UProperty Category, EditDefaultsOnly, Meta FGameplayEffectModifierMagnitude DurationMagnitude Duration in seconds. 0.0 for instantaneous effects; -1.0 for infinite duration.
Public variable UProperty Category, EditDefaultsOnly EGameplayEffectDurationType DurationPolicy Properties

Policy for the duration of this effect |

Protected variable UProperty Category Transient visibleanywhere FText EditorStatusText Allow us to show the Status of the class (valid configurations or invalid configurations) while configuring in the Editor
Public variable UProperty Category, EditDefaultsOnly BlueprintReadOnly TArray< FGameplayEffectExecutionDefinition > Executions Array of executions that will affect the target of this effect
Public variable UProperty Category, EditDefaultsOnly BlueprintReadOnly TArray< FGameplayEffectCue > GameplayCues Cues to trigger non-simulated reactions in response to this GameplayEffect such as sounds, particle effects, etc
Protected variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly instanced TArray< TObjectPtr< UGameplayEffectComponent > > GEComponents These Gameplay Effect Components define how this Gameplay Effect behaves when applied
Public variable UProperty Category BlueprintReadOnly TArray< FGameplayAbilitySpecDef > GrantedAbilities Granted abilities

Policy for what abilities this GE will grant. |

Public variable UProperty Category, Meta BlueprintReadOnly FGameplayEffectQuery GrantedApplicationImmunityQuery Grants immunity to GameplayEffects that match this query.
Public variable UProperty Category, Meta BlueprintReadOnly FGameplayTagRequirements GrantedApplicationImmunityTags Grants the owner immunity from these source tags.
Public variable bool HasGrantedApplicationImmunityQuery Cached !GrantedApplicationImmunityQuery.IsEmpty(). Set on PostLoad.
Public variable bool HasRemoveGameplayEffectsQuery Cached !RemoveGameplayEffectsQuery.IsEmpty(). Set on PostLoad.
Public variable UProperty Category, Meta BlueprintReadOnly FInheritedTagContainer InheritableBlockedAbilityTagsContainer These blocked ability tags are applied to the actor I am applied to
Public variable UProperty Category, Meta BlueprintReadOnly FInheritedTagContainer InheritableGameplayEffectTags Tag Containers

The GameplayEffect's Tags: tags the the GE has and DOES NOT give to the actor. |

Public variable UProperty Category, Meta BlueprintReadOnly FInheritedTagContainer InheritableOwnedTagsContainer These tags are applied to the actor I am applied to
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly TArray< FGameplayModifierInfo > Modifiers Array of modifiers that will affect the target of this effect
Public variable UProperty Category, Meta BlueprintReadOnly FGameplayTagRequirements OngoingTagRequirements Once Applied, these tags requirements are used to determined if the GameplayEffect is "on" or "off".
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly TArray< TSubclassOf< UGameplayEffect > > OverflowEffects Effects to apply when a stacking effect "overflows" its stack count through another attempted application.
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly FScalableFloat Period Period in seconds. 0.0 for non-periodic effects
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly EGameplayEffectPeriodInhibitionRemovedPolicy PeriodicInhibitionPolicy How we should respond when a periodic gameplay effect is no longer inhibited
Public variable UProperty Category, Meta BlueprintReadOnly TArray< TSubclassOf< UGameplayEffect > > PrematureExpirationEffectClasses Effects to apply when this effect is made to expire prematurely (like via a forced removal, clear tags, etc.); Only works for effects with a duration
Public variable UProperty Category, Meta BlueprintReadOnly FGameplayTagRequirements RemovalTagRequirements Tag requirements that if met will remove this effect. Also prevents effect application.
Public variable UProperty Category, Meta BlueprintReadOnly FGameplayEffectQuery RemoveGameplayEffectQuery On Application of an effect, any active effects with this this query that matches against the added effect will be removed.
Public variable UProperty Category, Meta BlueprintReadOnly FInheritedTagContainer RemoveGameplayEffectsWithTags GameplayEffects that have tags in this container will be cleared upon effect application.
Public variable UProperty Category, Meta BlueprintReadOnly TArray< TSubclassOf< UGameplayEffect > > RoutineExpirationEffectClasses Effects to apply when this effect expires naturally via its duration; Only works for effects with a duration
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly EGameplayEffectStackingDurationPolicy StackDurationRefreshPolicy Policy for how the effect duration should be refreshed while stacking
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly EGameplayEffectStackingExpirationPolicy StackExpirationPolicy Policy for how to handle duration expiring on this gameplay effect
Public variable UProperty Category, EditDefaultsOnly BlueprintReadOnly EGameplayEffectStackingType StackingType Stacking

How this GameplayEffect stacks with other instances of this same GameplayEffect |

Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly int32 StackLimitCount Stack limit for StackingType
Public variable UProperty Category, EditDefaultsOnly, Meta BlueprintReadOnly EGameplayEffectStackingPeriodPolicy StackPeriodResetPolicy Policy for how the effect period should be reset (or not) while stacking
Public variable UProperty Category, Meta BlueprintReadOnly Transient instanced TObjectPtr< class UGameplayEffectUIData > UIData Data for the UI representation of this effect.

Constructors

  Type Name Description
Public function  

UGameplayEffect ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function GEComponentClass & Add a GameplayEffectComponent to the GameplayEffect.
Public function Const bool

CanApply ( const FActiveGameplayEffectsContainer& ActiveGEContainer,
const FGameplayEffectSpec& GESpec
)

 Can we Apply this Gameplay Effect? Note: Apply is the generic term for adding to the active container or executing it.
Public function Const const UGameplayEffectComponent *  
Public function Const const GEComponentClass * Find and return the component of class GEComponentClass on this GE, if one exists.
Public function GEComponentClass & Find an existing GameplayEffectComponent of the requested class, or add one if none are found.
Public function Const const FGameplayTagContainer & Returns all tags that this GE has and does not grant to any Actor.
Public function Const const FGameplayTagContainer & Returns all blocking ability tags granted by this gameplay effect definition.
Public function Virtual Const void  
Public function Const const FGameplayTagContainer & Returns all tags granted to the Target Actor of this gameplay effect.
Public function Virtual Const void  
Public function Const EGameplayEffectStackingExpirationPolicy Returns the stack expiration policy for this gameplay effect
Public function Const int32 Returns the maximum stack size for this gameplay effect
Protected function Const EGameplayEffectVersion Upgrade Path
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Const bool Receive a notify that this GameplayEffect has been added to an Active Container.
Public function Const void

OnApplied ( FActiveGameplayEffectsContainer& ActiveGEContainer,
FGameplayEffectSpec& GESpec,
FPredictionKey& PredictionKey
)

 Receive a notify that this GameplayEffect has been applied (this GE is either previously added to the container or executed in such cases).
Public function Const void

OnExecuted ( FActiveGameplayEffectsContainer& ActiveGEContainer,
FGameplayEffectSpec& GESpec,
FPredictionKey& PredictionKey
)

 Receive a notify that this GameplayEffect has been executed (it must be instant, as it is not added to the Container).
Public function Virtual void Called when the Gameplay Effect has finished loading.
Public function void We need to fix-up all of the SubObjects manually since the Engine doesn't fully support this
Protected function void Sets the Version of the class to denote it's been upgraded
Public function void Check for any errors

Overridden from UObject

  Type Name Description
Public function Virtual Const EDataValidationResult Allow each Gameplay Effect Component to validate its own data.
Public function Virtual void Do our upgrades in PostCDOCompiled
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Needed to properly disable inheriting the version value from its parent.
Public function Virtual void PostLoad gets called once after the asset has been loaded.
Protected function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

 We should intercept the Save call and revalidate all of our deprecated values to avoid hanging onto stale data

Constants

Name Description
INFINITE_DURATION These are deprecated but remain for backwards compat, please use FGameplayEffectConstants:: instead.
INSTANT_APPLICATION  
INVALID_LEVEL  
NO_PERIOD  

Deprecated Variables

  Type Name Description
Public variable UProperty Meta TArray< TSubclassOf< UGameplayEffectCustomApplicationRequirement > > ApplicationRequirements_DEPRECATED  
Public variable UProperty Meta FScalableFloat ChanceToApplyToTarget_DEPRECATED Probability that this gameplay effect will be applied to the target actor (0.0 for never, 1.0 for always)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page