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

Light Theme

Dark Theme

UGameplayCueManager

Singleton manager object that handles dispatching gameplay cues and spawning GameplayCueNotify actors as needed

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UDataAsset

UGameplayCueManager

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UGameplayCueManager : public UDataAsset

Remarks

Singleton manager object that handles dispatching gameplay cues and spawning GameplayCueNotify actors as needed

Variables

	Name	Description
bool	bAccelerationMapOutdated
FGameplayCueObj...	EditorGameplayCueObjectLibrary
bool	EditorObjectLibraryFullyInitialized
FTimerHandle	EditorPeriodicUpdateHandle
TSharedPtr< FSt...	GameplayCueAssetHandle	Handle to maintain ownership of gameplay cue assets.
TArray< TSubcla...	GameplayCueClassesForPreallocation	Classes that we need to preallocate instances for
int32	GameplayCueSendContextCount	Number of active gameplay cue send contexts, when it goes to 0 cues are flushed
TArray< UClass ...	LoadedGameplayCueNotifyClasses	Hardref to the gameplaycue notify classes we have async loaded
TMap< FGCNotify...	NotifyMapActor
FSimpleMulticas...	OnEditorObjectLibraryUpdated
FSimpleMulticas...	OnFlushPendingCues	Broadcasted when ::FlushPendingCues runs: useful for custom batching/gameplay cue handling
FOnGameplayCueN...	OnGameplayCueNotifyAddOrRemove
FOnRouteGamepla...	OnRouteGameplayCue
TArray< FGamepl...	PendingExecuteCues	List of gameplay cue executes that haven't been processed yet
TArray< FPreall...	PreallocationInfoList_Internal
FGameplayCueObj...	RuntimeGameplayCueObjectLibrary
FStreamableMana...	StreamableManager
FGameplayCueTra...	TranslationManager

Constructors

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

Functions

	Name	Description
void	AddReferencedObjects ( UObject* InThis, FReferenceCollector& Collector )
void	BuildCuesToAddToGlobalSet ( const TArray< FAssetData >& AssetD..., FName TagPropertyName, TArray< struct FGameplayCueReferenc..., TArray< FSoftObjectPath >& OutAsse..., FShouldLoadGCNotifyDelegate )
void	CheckForPreallocation ( UClass* GCClass )
void	CheckForTooManyRPCs ( FName FuncName, const FGameplayCuePendingExecute& ..., const FString& CueID, const FGameplayEffectContext* ... )	The cue manager has a tendency to produce a lot of RPCs.
bool	DoesPendingCueExecuteMatch ( FGameplayCuePendingExecute& Pendin..., FGameplayCuePendingExecute& Existi... )	Returns true if two pending cues match, can be overridden in game
void	DumpPreallocationStats ( UWorld* World )	Prints what classess exceeded their preallocation sizes during runtime
void	EndGameplayCueSendContext()
void	EndGameplayCuesFor ( AActor* TargetActor )	Force any instanced GameplayCueNotifies to stop
int32	FinishLoadingGameplayCueNotifies()
void	FlushPendingCues()	Send out any pending cues
TArray< FStr...	GetAlwaysLoadedGameplayCuePaths()
UWorld *	GetCachedWorldForGameplayCueNotifies()
UGameplayCue...	GetEditorCueSet()
void	GetEditorObjectLibraryGameplayCueNotifyFilenames ( TArray< FString >& Filenames )	Get filenames of all GC notifies we know about (loaded or not). Useful for cooking
TArray< UGam...	GetGlobalCueSets()	Will return the Runtime cue set and the EditorCueSet, if the EditorCueSet is available. This is used mainly for handling asset created/deleted in the editor.
AGameplayCue...	GetInstancedCueActor ( AActor* TargetActor, UClass* CueClass, const FGameplayCueParameters& Para... )	Returns the cached instance cue. Creates it if it doesn't exist
FPreallocati...	GetPreallocationInfo ( UWorld* World )
UGameplayCue...	GetRuntimeCueSet()	Loading GameplayCueNotifies from ObjectLibraries
TArray< FStr...	GetValidGameplayCuePaths()	Returns list of valid gameplay cue paths.
UWorld *	GetWorld()
void	HandleAssetAdded ( UObject* Object )	Handles updating an object library when a new asset is created
void	HandleAssetDeleted ( UObject* Object )	Handles cleaning up an object library if it matches the passed in object
void	HandleAssetRenamed ( const FAssetData& Data, const FString& String )	Warns if we move a GameplayCue notify out of the valid search paths
void	HandleGameplayCue ( AActor* TargetActor, FGameplayTag GameplayCueTag, EGameplayCueEvent::Type EventType, const FGameplayCueParameters& Para..., EGameplayCueExecutionOptions Option... )	Handling GameplayCues at runtime:
void	HandleGameplayCues ( AActor* TargetActor, const FGameplayTagContainer& Gamep..., EGameplayCueEvent::Type EventType, const FGameplayCueParameters& Para..., EGameplayCueExecutionOptions Option... )	Handling GameplayCues at runtime:
bool	HandleMissingGameplayCue ( UGameplayCueSet* OwningSet, FGameplayCueNotifyData& CueData, AActor* TargetActor, EGameplayCueEvent::Type EventType, FGameplayCueParameters& Parameters )	Handles what to do if a missing cue is requested.
void	InitializeEditorObjectLibrary()	Called from editor to soft load all gameplay cue notifies for the GameplayCueEditor
void	InitializeRuntimeObjectLibrary()	Called to setup and initialize the runtime library.
TSharedPtr< ...	InitObjectLibrary ( FGameplayCueObjectLibrary& Library )	Internal function to actually init the FGameplayCueObjectLibrary.
void	InvokeGameplayCueAddedAndWhileActive_FromSpec ( UAbilitySystemComponent* Ownin..., const FGameplayEffectSpec& Spec, FPredictionKey PredictionKey )
void	InvokeGameplayCueExecuted ( UAbilitySystemComponent* Ownin..., const FGameplayTag GameplayCueTag, FPredictionKey PredictionKey, FGameplayEffectContextHandle Effect... )	Wrappers to handle replicating executed cues
void	InvokeGameplayCueExecuted_FromSpec ( UAbilitySystemComponent* Ownin..., const FGameplayEffectSpec& Spec, FPredictionKey PredictionKey )	Wrappers to handle replicating executed cues
void	InvokeGameplayCueExecuted_WithParams ( UAbilitySystemComponent* Ownin..., const FGameplayTag GameplayCueTag, FPredictionKey PredictionKey, FGameplayCueParameters GameplayCueP... )
bool	IsGameplayCueRecylingEnabled()
void	LoadNotifyForEditorPreview ( FGameplayTag GameplayCueTag )	Looks in the EditorObjectLibrary for a notify for this tag, if it finds it, it loads it and puts it in the RuntimeObjectLibrary so that it can be previewed in the editor
void	NotifyGameplayCueActorEndPlay ( AGameplayCueNotify_Actor* Acto... )	Notify to say the actor is about to be destroyed and the GC manager needs to remove references to it.
void	NotifyGameplayCueActorFinished ( AGameplayCueNotify_Actor* Acto... )	Notify that this actor is finished and should be destroyed or recycled
void	OnCreated()	Called when manager is first created
void	OnEngineInitComplete()	Called when engine has completely loaded, this is a good time to finalize things
void	OnGameplayCueNotifyAsyncLoadComplete ( TArray< FSoftObjectPath > StringRef )
FOnRouteGame...	OnGameplayCueRouted()
void	OnMissingCueAsyncLoadComplete ( FSoftObjectPath LoadedObject, TWeakObjectPtr< UGameplayCueSet > O..., FGameplayTag GameplayCueTag, TWeakObjectPtr< AActor > TargetActo..., EGameplayCueEvent::Type EventType, FGameplayCueParameters Parameters )
void	OnPreReplayScrub ( UWorld* World )
void	OnWorldCleanup ( UWorld* World, bool bSessionEnded, bool bCleanupResources )
void	PrintGameplayCueNotifyMap()
void	PrintLoadedGameplayCueNotifyClasses()
bool	ProcessPendingCueExecute ( FGameplayCuePendingExecute& Pendin... )	Process a pending cue, return false if the cue should be rejected.
void	RefreshObjectLibraries()	Refreshes the existing, already initialized, object libraries.
void	ReloadObjectLibrary ( UWorld* World, const UWorld::InitializationValues ... )	This handles the case where GameplayCueNotifications have changed between sessions, which is possible in editor.
void	RequestPeriodicUpdateOfEditorObjectLibraryWhileWaitingOnAssetRegistry()	Calling this will make the GC manager periodically refresh the EditorObjectLibrary until the asset registry is finished scanning
void	ResetPreallocation ( UWorld* World )	Resets preallocation for a given world
void	RouteGameplayCue ( AActor* TargetActor, FGameplayTag GameplayCueTag, EGameplayCueEvent::Type EventType, const FGameplayCueParameters& Para..., EGameplayCueExecutionOptions Option... )	Actually routes the gameplaycue event to the right place.
bool	ShouldAsyncLoadMissingGameplayCues()	If true, this will asynchronously load missing gameplay cues, and execute cue when the load finishes
bool	ShouldAsyncLoadObjectLibrariesAtStart()
bool	ShouldAsyncLoadRuntimeObjectLibraries()
bool	ShouldLoadGameplayCueAssetData ( const FAssetData& Data )	Called before loading any gameplay cue notifies from object libraries.
bool	ShouldSuppressGameplayCues ( AActor* TargetActor )	Returns true to ignore gameplay cues
bool	ShouldSyncLoadMissingGameplayCues()	Debugging Help If true, this will synchronously load missing gameplay cues
bool	ShouldSyncLoadRuntimeObjectLibraries()
bool	ShouldSyncScanRuntimeObjectLibraries()
void	StartGameplayCueSendContext()	Start or stop a gameplay cue send context.
void	TranslateGameplayCue ( FGameplayTag& Tag, AActor* TargetActor, const FGameplayCueParameters& Para... )	Allows Tag to be translated in place to a different Tag. See FGameplayCueTranslorManager
void	UpdatePreallocation ( UWorld* World )	Prespawns a single actor for gameplaycue notify actor classes that need prespawning (should be called by outside gamecode, such as gamestate)
bool	VerifyNotifyAssetIsInValidPath ( FString Path )

Classes

	Name	Description
	FOnRouteGameplayCue

Constants

Name	Description
CurrentWorld	Cached world we are currently handling cues for.
PreviewComponent	Animation Preview Hacks
PreviewProxyTick
PreviewWorld

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

Take our survey

Dismiss