1. Epic GamesDeveloper
  3. IGameplayCueInterface

IGameplayCueInterface

API > API/Plugins > API/Plugins/GameplayAbilities

   
Name IGameplayCueInterface
Type class
Header File /Engine/Plugins/Runtime/GameplayAbilities/Source/GameplayAbilities/Public/GameplayCueInterface.h
Include Path #include "GameplayCueInterface.h"

Syntax

class IGameplayCueInterface

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

IGameplayCueInterface()

   GameplayCueInterface.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bForwardToParent bool If true, keep checking for additional handlers GameplayCueInterface.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BlueprintCustomHandler ( EGameplayCueEvent::Type EventType,
const FGameplayCueParameters& Parameters
)

 Internal function to map ufunctions directly to gameplaycue tags GameplayCueInterface.h
  • BlueprintImplementableEvent
  • BlueprintCosmetic
  • Category=GameplayCue
  • Meta=(BlueprintInternalUseOnly="true")

virtual void ForwardGameplayCueToParent ()

 Call from a Cue handler event to continue checking for additional, more generic handlers. GameplayCueInterface.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Ability|GameplayCue"

virtual void GameplayCueDefaultHandler ( EGameplayCueEvent::Type EventType,
const FGameplayCueParameters& Parameters
)

 Default native handler, called if no tag matches found GameplayCueInterface.h  

virtual void GetGameplayCueSets ( TArray< class UGameplayCueSet* >& OutSets
) const

 Return the cue sets used by this object. GameplayCueInterface.h  

virtual void HandleGameplayCue ( UObject* Self,
FGameplayTag GameplayCueTag,
EGameplayCueEvent::Type EventType,
const FGameplayCueParameters& Parameters
)

 Handle a single gameplay cue GameplayCueInterface.h  

virtual void HandleGameplayCue ( AActor* Self,
FGameplayTag GameplayCueTag,
EGameplayCueEvent::Type EventType,
const FGameplayCueParameters& Parameters
)

 Handle a single gameplay cue GameplayCueInterface.h  

virtual void HandleGameplayCues ( UObject* Self,
const FGameplayTagContainer& GameplayCueTags,
EGameplayCueEvent::Type EventType,
const FGameplayCueParameters& Parameters
)

 Wrapper that handles multiple cues GameplayCueInterface.h  

virtual void HandleGameplayCues ( AActor* Self,
const FGameplayTagContainer& GameplayCueTags,
EGameplayCueEvent::Type EventType,
const FGameplayCueParameters& Parameters
)

 Wrapper that handles multiple cues GameplayCueInterface.h  

virtual bool ShouldAcceptGameplayCue ( UObject* Self,
FGameplayTag GameplayCueTag,
EGameplayCueEvent::Type EventType,
const FGameplayCueParameters& Parameters
)

 Returns true if the object can currently accept gameplay cues associated with the given tag. GameplayCueInterface.h  

virtual bool ShouldAcceptGameplayCue ( AActor* Self,
FGameplayTag GameplayCueTag,
EGameplayCueEvent::Type EventType,
const FGameplayCueParameters& Parameters
)

 Returns true if the actor can currently accept gameplay cues associated with the given tag. GameplayCueInterface.h  

Static

Name Remarks Include Path Unreal Specifiers

static void ClearTagToFunctionMap()

 Clears internal cache of what classes implement which functions GameplayCueInterface.h  

static void DispatchBlueprintCustomHandler ( UObject* Object,
UFunction* Func,
EGameplayCueEvent::Type EventType,
const FGameplayCueParameters& Parameters
)

 Calls the UFunction override for a specific gameplay cue GameplayCueInterface.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page