1. Epic GamesDeveloper
  3. UGameplayCueNotify_Static

UGameplayCueNotify_Static

A non instantiated [UObject](API\Runtime\CoreUObject\UObject\UObject) that acts as a handler for a GameplayCue.

Unreal Engine C++ API Reference > Plugins > GameplayAbilities

Inheritance Hierarchy

References

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

Syntax

UCLASS (Blueprintable, Meta=(ShowWorldContextPin), HideCategories=(Replication))  
class UGameplayCueNotify_Static : public UObject

Remarks

A non instantiated UObject that acts as a handler for a GameplayCue. These are useful for one-off "burst" effects.

Variables

  Type Name Description
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.

Constructors

  Type Name Description
Public function  

UGameplayCueNotify_Static ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const UWorld *  
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 Const 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 Const UFunction BlueprintPure, 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 Const UFunction BlueprintPure, 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 void  
Public function Const UFunction BlueprintPure, Category blueprintnativeevent bool

OnRemove ( AActor* MyTarget,
const FGameplayCueParameters& Parameters
)

 Called when a GameplayCue with duration is removed
Public function Const UFunction BlueprintPure, 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 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page