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

Light Theme

Dark Theme

FGameplayCueParameters

Metadata about a gameplay cue execution

Windows

MacOS

Linux

References

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

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)([BlueprintType](Programming/UnrealArchitecture/Reference/Structs/Specifiers/BlueprintType),
Meta=(HasNativeBreak="GameplayAbilities.AbilitySystemBlueprintLibrary.BreakGameplayCueParameters", HasNativeMake="GameplayAbilities.AbilitySystemBlueprintLibrary.MakeGameplayCueParameters"))
struct FGameplayCueParameters

Remarks

Metadata about a gameplay cue execution

Variables

	Name	Description
int32	AbilityLevel	If originating from an ability, this will be the level of that ability
FGameplayTagCon...	AggregatedSourceTags	The aggregated source tags taken from the effect spec
FGameplayTagCon...	AggregatedTargetTags	The aggregated target tags taken from the effect spec
TWeakObjectPtr<...	EffectCauser	The physical actor that actually did the damage, can be a weapon or projectile
FGameplayEffect...	EffectContext	Effect context, contains information about hit result, etc
int32	GameplayEffectLevel	If originating from a GameplayEffect, the level of that GameplayEffect
TWeakObjectPtr<...	Instigator	Instigator actor, the actor that owns the ability system component
FVector_NetQuan...	Location	Location cue took place at
FGameplayTag	MatchedTagName	The tag name that matched this specific gameplay cue handler
FVector_NetQuan...	Normal	Normal of impact that caused cue
float	NormalizedMagnitude	Magnitude of source gameplay effect, normalzed from 0-1.
FGameplayTag	OriginalTag	The original tag of the gameplay cue
TWeakObjectPtr<...	PhysicalMaterial	PhysMat of the hit, if there was a hit.
float	RawMagnitude	Raw final magnitude of source gameplay effect.
TWeakObjectPtr<...	SourceObject	Object this effect was created from, can be an actor or static object.
TWeakObjectPtr<...	TargetAttachComponent	Could be used to say "attach FX to this component always"

Constructors

	Name	Description
	FGameplayCueParameters()
	FGameplayCueParameters ( const FGameplayEffectSpecForRPC& S... )	Projects can override this via UAbilitySystemGlobals
	FGameplayCueParameters ( const FGameplayEffectContextHandle ... )

Functions

	Name	Description
AActor *	GetEffectCauser()	Returns the actor that physically caused the damage, could be a projectile or weapon
AActor *	GetInstigator()	Returns the actor that instigated this originally, generally attached to an ability system component
const UObjec...	GetSourceObject()	Returns the object that originally caused this, game-specific but usually not an actor
bool	IsInstigatorLocallyControlled ( AActor* FallbackActor )	Returns true if this is locally controlled, using fallback actor if nothing else available
bool	IsInstigatorLocallyControlledPlayer ( AActor* FallbackActor )	Fallback actor is used if the parameters have nullptr for instigator and effect causer
bool	NetSerialize ( FArchive& Ar, UPackageMap* Map, bool& bOutSuccess )	Optimized serializer

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

Take our survey

Dismiss