1. Epic GamesDeveloper
  3. UGameplayCueManager

UGameplayCueManager

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

API > API/Plugins > API/Plugins/GameplayAbilities

Inheritance Hierarchy

References

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

Syntax

UCLASS ()  
class UGameplayCueManager : public UDataAsset

Remarks

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

Variables

  Type Name Description
Public variable bool bAccelerationMapOutdated  
Protected variable UProperty Transient FGameplayCueObjectLibrary EditorGameplayCueObjectLibrary  
Public variable bool EditorObjectLibraryFullyInitialized  
Public variable FTimerHandle EditorPeriodicUpdateHandle  
Protected variable TSharedPtr< FStreamableHandle > GameplayCueAssetHandle Handle to maintain ownership of gameplay cue assets.
Protected variable UProperty Transient TArray< TSubclassOf< AGameplayCueNotify_Actor > > GameplayCueClassesForPreallocation Classes that we need to preallocate instances for
Protected variable UProperty Transient int32 GameplayCueSendContextCount Number of active gameplay cue send contexts, when it goes to 0 cues are flushed
Protected variable UProperty Transient TArray< TObjectPtr< UClass > > LoadedGameplayCueNotifyClasses Hardref to the gameplaycue notify classes we have async loaded
Public variable FSimpleMulticastDelegate OnEditorObjectLibraryUpdated  
Public variable FSimpleMulticastDelegate OnFlushPendingCues Broadcasted when FlushPendingCues runs: useful for custom batching/gameplay cue handling
Public variable FOnGameplayCueNotifyChange OnGameplayCueNotifyAddOrRemove  
Protected variable FOnRouteGameplayCue OnRouteGameplayCue  
Protected variable UProperty Transient TArray< FGameplayCuePendingExecute > PendingExecuteCues List of gameplay cue executes that haven't been processed yet
Protected variable UProperty Transient TArray< FPreallocationInfo > PreallocationInfoList_Internal  
Protected variable UProperty Transient FGameplayCueObjectLibrary RuntimeGameplayCueObjectLibrary  
Public variable FStreamableManager StreamableManager  
Public variable FGameplayCueTranslationManager TranslationManager  

Constructors

  Type Name Description
Public function  

UGameplayCueManager ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static void

AddGameplayCue_NonReplicated ( AActor* Target,
const FGameplayTag GameplayCueTag,
const FGameplayCueParameters& Parameters
)

 Convenience methods for invoking non-replicated gameplay cue events.
Public function Virtual void

AddGameplayCueNotifyPath ( const FString& InPath,
const bool bShouldRescanCueAssets
)

 Add a path to the GameplayCueNotifyPaths array.
Protected function void

BuildCuesToAddToGlobalSet ( const TArray< FAssetData >& AssetDataList,
FName TagPropertyName,
TArray< struct FGameplayCueReferencePair >& OutCuesToAdd,
TArray< FSoftObjectPath >& OutAssetsToLoad,
FShouldLoadGCNotifyDelegate
)

  
Protected function void  
Protected function void

CheckForTooManyRPCs ( FName FuncName,
const FGameplayCuePendingExecute& PendingCue,
const FString& CueID,
const FGameplayEffectContext* EffectContext
)

 The cue manager has a tendency to produce a lot of RPCs.
Public function Virtual bool Returns true if two pending cues match, can be overridden in game
Public function void

DumpPreallocationStats ( const FPreallocationInfo& PreallocationInfo,
bool bWarnOnActiveActors
)

 Prints what classes exceeded their preallocation sizes during runtime
Public function void  
Public function Virtual void

EndGameplayCuesFor ( AActor* TargetActor
)

 Force any instanced GameplayCueNotifies to stop
Public function Static void

ExecuteGameplayCue_NonReplicated ( AActor* Target,
const FGameplayTag GameplayCueTag,
const FGameplayCueParameters& Parameters
)

  
Protected function Const AGameplayCueNotify_Actor *

FindExistingCueOnActor ( const AActor& TargetActor,
const TSubclassOf< AGameplayCueNotify_Actor >& CueClass,
const FGameplayCueParameters& Parameters
)

 Given a TargetActor and a CueClass, find an existing instance of the CueNotify Actor that we can reuse
Protected function AGameplayCueNotify_Actor *

FindRecycledCue ( const TSubclassOf< AGameplayCueNotify_Actor >& CueClass,
const UWorld& FindInWorld
)

 Given a CueClass, find an already spawned (but currently unused) recycled instance that exists in FindInWorld so that we may reuse it.
Public function int32  
Public function Virtual void Send out any pending cues
Protected function Virtual TArray< FString >  
Public function Static UWorld *  
Public function UGameplayCueSet *  
Public function Const void Get filenames of all GC notifies we know about (loaded or not). Useful for cooking
Public function TArray< UGameplayCueSet * > 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.
Public function Virtual AGameplayCueNotify_Actor *

GetInstancedCueActor ( AActor* TargetActor,
UClass* GameplayCueNotifyActorClass,
const FGameplayCueParameters& Parameters
)

 Returns the cached instance cue. Creates it if it doesn't exist.
Protected function FPreallocationInfo &

GetPreallocationInfo ( const UWorld* World
)

  
Public function UGameplayCueSet * Loading GameplayCueNotifies from ObjectLibraries
Protected function Virtual TArray< FString > Returns list of valid gameplay cue paths.
Public function Virtual Const UWorld *  
Public function void Handles updating an object library when a new asset is created
Public function void Handles cleaning up an object library if it matches the passed in object
Public function void

HandleAssetRenamed ( const FAssetData& Data,
const FString& String
)

 Warns if we move a GameplayCue notify out of the valid search paths
Public function Virtual void

HandleGameplayCue ( AActor* TargetActor,
FGameplayTag GameplayCueTag,
EGameplayCueEvent::Type EventType,
const FGameplayCueParameters& Parameters,
EGameplayCueExecutionOptions Options
)

  
Public function Virtual void

HandleGameplayCues ( AActor* TargetActor,
const FGameplayTagContainer& GameplayCueTags,
EGameplayCueEvent::Type EventType,
const FGameplayCueParameters& Parameters,
EGameplayCueExecutionOptions Options
)

 Handling GameplayCues at runtime:
Public function Virtual bool Handles what to do if a missing cue is requested.
Public function void Called from editor to soft load all gameplay cue notifies for the GameplayCueEditor
Public function void Called to setup and initialize the runtime library.
Protected function TSharedPtr< FStreamableHandle > Internal function to actually init the FGameplayCueObjectLibrary.
Public function Virtual void

InvokeGameplayCueAddedAndWhileActive_FromSpec ( UAbilitySystemComponent* OwningComponent,
const FGameplayEffectSpec& Spec,
FPredictionKey PredictionKey
)

  
Public function Virtual void

InvokeGameplayCueExecuted ( UAbilitySystemComponent* OwningComponent,
const FGameplayTag GameplayCueTag,
FPredictionKey PredictionKey,
FGameplayEffectContextHandle EffectContext
)

  
Public function Virtual void

InvokeGameplayCueExecuted_FromSpec ( UAbilitySystemComponent* OwningComponent,
const FGameplayEffectSpec& Spec,
FPredictionKey PredictionKey
)

 Wrappers to handle replicating executed cues
Public function Virtual void

InvokeGameplayCueExecuted_WithParams ( UAbilitySystemComponent* OwningComponent,
const FGameplayTag GameplayCueTag,
FPredictionKey PredictionKey,
FGameplayCueParameters GameplayCueParameters
)

  
Public function Static bool  
Public function void 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
Public function Virtual void Notify to say the actor is about to be destroyed and the GC manager needs to remove references to it.
Public function Virtual void Notify that this actor is finished and should be destroyed or recycled
Public function Virtual void Called when manager is first created
Public function Virtual void Called when engine has completely loaded, this is a good time to finalize things
Protected function void  
Public function FOnRouteGameplayCue &  
Protected function void  
Public function void

OnPostWorldCleanup ( UWorld* World,
bool bSessionEnded,
bool bCleanupResources
)

  
Public function void  
Public function void  
Public function Virtual void  
Public function Virtual bool Process a pending cue, return false if the cue should be rejected.
Protected function void Refreshes the existing, already initialized, object libraries.
Protected function Virtual void

ReloadObjectLibrary ( UWorld* World,
const UWorld::InitializationValues IVS
)

 This handles the case where GameplayCueNotifications have changed between sessions, which is possible in editor.
Public function Static void

RemoveGameplayCue_NonReplicated ( AActor* Target,
const FGameplayTag GameplayCueTag,
const FGameplayCueParameters& Parameters
)

  
Public function Virtual int32

RemoveGameplayCueNotifyPath ( const FString& InPath,
const bool bShouldRescanCueAssets
)

 Remove the given gameplay cue notify path from the GameplayCueNotifyPaths array.
Public function void Calling this will make the GC manager periodically refresh the EditorObjectLibrary until the asset registry is finished scanning
Public function void Resets preallocation for a given world
Public function Virtual void

RouteGameplayCue ( AActor* TargetActor,
FGameplayTag GameplayCueTag,
EGameplayCueEvent::Type EventType,
const FGameplayCueParameters& Parameters,
EGameplayCueExecutionOptions Options
)

 Actually routes the gameplaycue event to the right place.
Public function Virtual Const bool If true, this will asynchronously load missing gameplay cues, and execute cue when the load finishes
Public function Virtual Const bool  
Protected function Virtual Const bool  
Public function Virtual Const bool Called before loading any gameplay cue notifies from object libraries.
Public function Virtual bool Returns true to ignore gameplay cues
Public function Virtual Const bool Debugging HelpIf true, this will synchronously load missing gameplay cues
Protected function Virtual Const bool  
Protected function Virtual Const bool  
Public function void Start or stop a gameplay cue send context.
Public function void

TranslateGameplayCue ( FGameplayTag& Tag,
AActor* TargetActor,
const FGameplayCueParameters& Parameters
)

 Allows Tag to be translated in place to a different Tag. See FGameplayCueTranslorManager
Public function void Prespawns a single actor for gameplaycue notify actor classes that need prespawning (should be called by outside gamecode, such as gamestate)
Public function bool  

Classes

  Type Name Description
Public class FOnRouteGameplayCue    

Constants

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page