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

Light Theme

Dark Theme

AGameplayCueNotify_Actor

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

AGameplayCueNotify_Actor

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, Meta=(ShowWorldContextPin), HideCategories=(Replication))
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

	Name	Description
float	AutoDestroyDelay	If bAutoDestroyOnRemove is true, the actor will stay alive for this many seconds before being auto destroyed.
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.
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.
bool	bAutoAttachToOwner	If true, attach this GameplayCue Actor to the target actor while it is active.
bool	bAutoDestroyOnRemove	We will auto destroy (recycle) this GameplayCueActor when the OnRemove event fires (after OnRemove is called).
bool	bHasHandledOnActiveEvent
bool	bHasHandledOnRemoveEvent
bool	bHasHandledWhileActiveEvent
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)
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.
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.
FTimerHandle	FinishTimerHandle
FName	GameplayCueName	Mirrors GameplayCueTag in order to be asset registry searchable
FGameplayTag	GameplayCueTag
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.
FGCNotifyActorK...	NotifyKey
int32	NumPreallocatedInstances	How many instances of the gameplay cue to preallocate
FGameplayTagRef...	ReferenceHelper
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)
bool	WarnIfTimelineIsStillRunning	Warn if we have a timeline running when we cleanup this gameplay cue (we will kill the timeline either way)

Constructors

	Name	Description
	AGameplayCueNotify_Actor ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	ClearOwnerDestroyedDelegate()
void	GameplayCueFinishedCallback()	Called when the GC is finished.
bool	GameplayCuePendingRemove()
void	HandleGameplayCue ( AActor* MyTarget, EGameplayCueEvent::Type EventType, const FGameplayCueParameters& Para... )
bool	HandlesEvent ( EGameplayCueEvent::Type EventType )	Does this GameplayCueNotify handle this type of GameplayCueEvent?
void	K2_EndGameplayCue()	Ends the gameplay cue: either destroying it or recycling it.
void	K2_HandleGameplayCue ( AActor* MyTarget, EGameplayCueEvent::Type EventType, const FGameplayCueParameters& Para... )	Generic Event Graph event that will get called for every event type
bool	OnActive ( AActor* MyTarget, const FGameplayCueParameters& Para... )
bool	OnExecute ( AActor* MyTarget, const FGameplayCueParameters& Para... )
void	OnOwnerDestroyed ( AActor* DestroyedActor )
bool	OnRemove ( AActor* MyTarget, const FGameplayCueParameters& Para... )
bool	Recycle()	Called when returning to the recycled pool.
void	ReuseAfterRecycle()	Called when we are about to reuse the GC.
bool	WhileActive ( AActor* MyTarget, const FGameplayCueParameters& Para... )

Overridden from AActor

	Name	Description
void	BeginPlay()	Overridable native event for when play begins for this actor.
void	EndPlay ( const EEndPlayReason::Type EndPlayR... )	Overridable function called whenever this actor is being removed from a level
void	SetOwner ( AActor* NewOwner )	Set the owner of this Actor, used primarily for network replication.

Overridden from UObject

	Name	Description
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

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

Take our survey

Dismiss