1. Epic GamesDeveloper
  3. AGameplayCueNotify_Actor

AGameplayCueNotify_Actor

An instantiated Actor that acts as a handler of a GameplayCue.

API > API/Plugins > API/Plugins/GameplayAbilities

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Blueprintable, Meta&61;&40;ShowWorldContextPin&41;, HideCategories&61;&40;Replication&41;&41;  
class AGameplayCueNotify_Actor : public AActor

Remarks

An instantiated Actor that acts as a handler of a GameplayCue. Since they are instantiated, they can maintain state and tick/update every frame if necessary.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere float AutoDestroyDelay If bAutoDestroyOnRemove is true, the actor will stay alive for this many seconds before being auto destroyed.
Public variable UProperty Category, EditDefaultsOnly bool bAllowMultipleOnActiveEvents Does this cue trigger its OnActive event if it's already been triggered? This can occur when the associated tag is triggered by multiple sources and there is no unique instancing.
Public variable UProperty Category, EditDefaultsOnly bool bAllowMultipleWhileActiveEvents Does this cue trigger its WhileActive event if it's already been triggered? This can occur when the associated tag is triggered by multiple sources and there is no unique instancing.
Public variable UProperty Category, EditDefaultsOnly bool bAutoAttachToOwner If true, attach this GameplayCue Actor to the target actor while it is active.
Public variable UProperty Category, EditDefaultsOnly bool bAutoDestroyOnRemove We will auto destroy (recycle) this GameplayCueActor when the OnRemove event fires (after OnRemove is called).
Protected variable bool bHasHandledOnActiveEvent  
Protected variable bool bHasHandledOnRemoveEvent  
Protected variable bool bHasHandledWhileActiveEvent  
Public variable bool bInRecycleQueue Set when the GC actor is in the recycle queue (E.g., not active in world. This is to prevent rentrancy in the recyle code since multiple paths can lead the GC actor there)
Public variable UProperty Category, EditDefaultsOnly bool bUniqueInstancePerInstigator Does this cue get a new instance for each instigator? For example if two instigators apply a GC to the same source, do we create two of these GameplayCue Notify actors or just one? If the notify is simply playing FX or sounds on the source, it should not need unique instances.
Public variable UProperty Category, EditDefaultsOnly bool bUniqueInstancePerSourceObject Does this cue get a new instance for each source object? For example if two source objects apply a GC to the same source, do we create two of these GameplayCue Notify actors or just one? If the notify is simply playing FX or sounds on the source, it should not need unique instances.
Public variable TWeakObjectPtr< AActor > CueInstigator Keep track of the Instigator so we can decide if this GameplayCueNotify is one we're searching for.
Public variable TWeakObjectPtr< const UObject > CueSourceObject Keep track of the SourceObject so we can decide if this GameplayCueNotify is one we're searching for.
Protected variable FTimerHandle FinishTimerHandle  
Public variable UProperty assetregistrysearchable FName GameplayCueName Mirrors GameplayCueTag in order to be asset registry searchable
Public variable UProperty Category, EditDefaultsOnly, Meta FGameplayTag GameplayCueTag Tag this notify is activated by
Public variable UProperty Category, EditDefaultsOnly bool IsOverride Does this Cue override other cues, or is it called in addition to them? E.g., If this is Damage.Physical.Slash, we wont call Damage.Physical afer we run this cue.
Public variable UProperty Category, EditDefaultsOnly int32 NumPreallocatedInstances How many instances of the gameplay cue to preallocate
Public variable UProperty Category, EditAnywhere bool WarnIfLatentActionIsStillRunning Warn if we have a latent action (delay, etc) running when we cleanup this gameplay cue (we will kill the latent action either way)
Public variable UProperty Category, EditAnywhere bool WarnIfTimelineIsStillRunning Warn if we have a timeline running when we cleanup this gameplay cue (we will kill the timeline either way)

Constructors

  Type Name Description
Public function  

AGameplayCueNotify_Actor ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function void  
Public function Virtual void Called when the GC is finished.
Public function Virtual bool  
Public function Virtual void

HandleGameplayCue ( AActor* MyTarget,
EGameplayCueEvent::Type EventType,
const FGameplayCueParameters& Parameters
)

  
Public function Virtual Const bool Does this GameplayCueNotify handle this type of GameplayCueEvent?
Public function Virtual UFunction BlueprintCallable, Category, Meta displayname void Ends the gameplay cue: either destroying it or recycling it.
Public function UFunction Category, Meta, BlueprintImplementableEvent displayname void

K2_HandleGameplayCue ( AActor* MyTarget,
EGameplayCueEvent::Type EventType,
const FGameplayCueParameters& Parameters
)

 Generic Event Graph event that will get called for every event type
Public function UFunction Category blueprintnativeevent bool

OnActive ( AActor* MyTarget,
const FGameplayCueParameters& Parameters
)

 Called when a GameplayCue with duration is first activated, this will only be called if the client witnessed the activation
Public function UFunction Category blueprintnativeevent bool

OnExecute ( AActor* MyTarget,
const FGameplayCueParameters& Parameters
)

 Called when a GameplayCue is executed, this is used for instant effects or periodic ticks
Public function Virtual UFunction void

OnOwnerDestroyed ( AActor* DestroyedActor
)

  
Public function UFunction Category blueprintnativeevent bool

OnRemove ( AActor* MyTarget,
const FGameplayCueParameters& Parameters
)

 Called when a GameplayCue with duration is removed
Public function Virtual bool

Recycle ()

 Called when returning to the recycled pool.
Public function Virtual void Called when we are about to reuse the GC.
Public function UFunction Category blueprintnativeevent bool

WhileActive ( AActor* MyTarget,
const FGameplayCueParameters& Parameters
)

 Called when a GameplayCue with duration is first seen as active, even if it wasn't actually just applied (Join in progress, etc)

Overridden from AActor

  Type Name Description
Protected function Virtual void Overridable native event for when play begins for this actor.
Protected function Virtual void Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Overridable function called whenever this actor is being removed from a level
Protected function Virtual void Destroy the actor
Public function Virtual void

SetOwner ( AActor* NewOwner
)

 Set the owner of this Actor, used primarily for network replication.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

  Type Name Description
Public variable PRAGMA_DISABLE_DEPRECATION_WARNINGS FGCNotifyActorKey NotifyKey NotifyKey is deprecated and unused. See comments in FGCNotifyActorKey

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page