1. Epic GamesDeveloper
  3. UAbilitySystemBlueprintLibrary

UAbilitySystemBlueprintLibrary

Blueprint library for ability system.

API > API/Plugins > API/Plugins/GameplayAbilities

Blueprint library for ability system. Many of these functions are useful to call from native as well

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

Syntax

UCLASS (Meta=(ScriptName="AbilitySystemLibrary"), MinimalAPI)  
class UAbilitySystemBlueprintLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UAbilitySystemBlueprintLibrary ( const FObjectInitializer& ObjectInitializer
)

   AbilitySystemBlueprintLibrary.h  

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static FGameplayAbilityTargetDataHandle AbilityTargetDataFromActor ( AActor* Actor
)

 Creates single actor target data AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|TargetData"

static FGameplayAbilityTargetDataHandle AbilityTargetDataFromActorArray ( const TArray< AActor* >& ActorArray,
bool OneTargetPerHandle
)

 Creates actor array target data AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|TargetData"

static FGameplayAbilityTargetDataHandle AbilityTargetDataFromHitResult ( const FHitResult& HitResult
)

 Creates a target data with a single hit result AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|TargetData"

static FGameplayAbilityTargetDataHandle AbilityTargetDataFromLocations ( const FGameplayAbilityTargetingLocationInfo& SourceLocation,
const FGameplayAbilityTargetingLocationInfo& TargetLocation
)

 Creates a target data with a source and destination location AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|TargetData"

static FGameplayEffectSpecHandle AddAssetTag ( FGameplayEffectSpecHandle SpecHandle,
FGameplayTag NewGameplayTag
)

 Adds NewGameplayTag to this instance of the effect AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static FGameplayEffectSpecHandle AddAssetTags ( FGameplayEffectSpecHandle SpecHandle,
FGameplayTagContainer NewGameplayTags
)

 Adds NewGameplayTags to this instance of the effect AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static bool AddGameplayTags ( AActor* Actor,
const FGameplayTagContainer& GameplayTags,
EGameplayTagReplicationState ReplicationRule
)

 Manually adds a set of tags to a given actor AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static FGameplayEffectSpecHandle AddGrantedTag ( FGameplayEffectSpecHandle SpecHandle,
FGameplayTag NewGameplayTag
)

 This instance of the effect will now grant NewGameplayTag to the object that this effect is applied to AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static FGameplayEffectSpecHandle AddGrantedTags ( FGameplayEffectSpecHandle SpecHandle,
FGameplayTagContainer NewGameplayTags
)

 This instance of the effect will now grant NewGameplayTags to the object that this effect is applied to AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"
Adds LinkedGameplayEffect to SpecHandles. AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"
  • Meta=(DeprecatedFunction, DeprecatedMessage="Linked GameplayEffects aren't replicated. Configure the GameplayEffect asset with a suitable GameplayEffectComponent.")
Adds LinkedGameplayEffectSpec to SpecHandles. AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"
  • Meta=(DeprecatedFunction, DeprecatedMessage="Linked GameplayEffects aren't replicated. Configure the GameplayEffect asset with a suitable GameplayEffectComponent.")

static bool AddLooseGameplayTags ( AActor* Actor,
const FGameplayTagContainer& GameplayTags,
bool bShouldReplicate
)

 Manually adds a set of tags to a given actor, and optionally replicates them. AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static FGameplayAbilityTargetDataHandle AppendTargetDataHandle ( FGameplayAbilityTargetDataHandle TargetHandle,
const FGameplayAbilityTargetDataHandle& HandleToAdd
)

 TargetDataCopies targets from HandleToAdd to TargetHandle AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|TargetData"

static FGameplayEffectSpecHandle AssignSetByCallerMagnitude ( FGameplayEffectSpecHandle SpecHandle,
FName DataName,
float Magnitude
)

 GameplayEffectSpec AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static FGameplayEffectSpecHandle AssignTagSetByCallerMagnitude ( FGameplayEffectSpecHandle SpecHandle,
FGameplayTag DataTag,
float Magnitude
)

 Sets a gameplay tag Set By Caller magnitude value AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"
  • Meta=(GameplayTagFilter="SetByCaller")

static FGameplayTagChangedEventWrapperSpecHandle BindEventWrapperToAnyOfGameplayTagContainerChanged ( UAbilitySystemComponent* AbilitySystemComponent,
const FGameplayTagContainer TagContainer,
FOnGameplayTagChangedEventWrapperSignature GameplayTagChangedEventWrapperDelegate,
bool bExecuteImmediatelyIfTagApplied,
EGameplayTagEventType::Type TagListeningPolicy
)

 Binds to changes in the given TagContainer on the given ASC's owned tags. AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Gameplay Tags"
  • Meta=(AdvancedDisplay="bExecuteImmediatelyIfTagApplied, TagListeningPolicy")

static FGameplayTagChangedEventWrapperSpecHandle BindEventWrapperToAnyOfGameplayTagsChanged ( UAbilitySystemComponent* AbilitySystemComponent,
const TArray< FGameplayTag >& Tags,
FOnGameplayTagChangedEventWrapperSignature GameplayTagChangedEventWrapperDelegate,
bool bExecuteImmediatelyIfTagApplied,
EGameplayTagEventType::Type TagListeningPolicy
)

 Binds to changes in the given Tags on the given ASC's owned tags. AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Gameplay Tags"
  • Meta=(AdvancedDisplay="bExecuteImmediatelyIfTagApplied, TagListeningPolicy")

static FGameplayTagChangedEventWrapperSpecHandle BindEventWrapperToGameplayTagChanged ( UAbilitySystemComponent* AbilitySystemComponent,
FGameplayTag Tag,
FOnGameplayTagChangedEventWrapperSignature GameplayTagChangedEventWrapperDelegate,
bool bExecuteImmediatelyIfTagApplied,
EGameplayTagEventType::Type TagListeningPolicy
)

 Gameplay Tag AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Gameplay Tags"
  • Meta=(AdvancedDisplay="bExecuteImmediatelyIfTagApplied, TagListeningPolicy")

static void BreakGameplayCueParameters ( const FGameplayCueParameters& Parameters,
float& NormalizedMagnitude,
float& RawMagnitude,
FGameplayEffectContextHandle& EffectContext,
FGameplayTag& MatchedTagName,
FGameplayTag& OriginalTag,
FGameplayTagContainer& AggregatedSourceTags,
FGameplayTagContainer& AggregatedTargetTags,
FVector& Location,
FVector& Normal,
AActor*& Instigator,
AActor*& EffectCauser,
UObject*& SourceObject,
UPhysicalMaterial*& PhysicalMaterial,
int32& GameplayEffectLevel,
int32& AbilityLevel,
USceneComponent*& TargetAttachComponent,
bool& bReplicateLocationWhenUsingMinimalRepProxy
)

 Native break, to avoid having to deal with quantized vector types AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayCue"
  • Meta=(NativeBreakFunc, AdvancedDisplay=6)

static FGameplayEffectSpecHandle CloneSpecHandle ( AActor* InNewInstigator,
AActor* InEffectCauser,
FGameplayEffectSpecHandle GameplayEffectSpecHandle_Clone
)

 Create a spec handle, cloning another AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Spec"

static double Conv_ScalableFloatToDouble ( const FScalableFloat& Input,
float Level
)

 Converts the given Scalable float to the value at the given level. AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="ScalableFloat"
  • Meta=(DisplayName="Get Value At Level (double-precision)", BlueprintAutocast, IgnoreTypePromotion)

static float Conv_ScalableFloatToFloat ( const FScalableFloat& Input,
float Level
)

 Converts the given Scalable float to the value at the given level. AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="ScalableFloat"
  • Meta=(DisplayName="Get Value At Level (single-precision)", BlueprintAutocast, IgnoreTypePromotion)

static bool DoesGameplayCueMeetTagRequirements ( FGameplayCueParameters Parameters,
const FGameplayTagRequirements& SourceTagReqs,
const FGameplayTagRequirements& TargetTagReqs
)

 Returns true if the aggregated source and target tags from the effect spec meets the tag requirements AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayCue"

static bool DoesTargetDataContainActor ( const FGameplayAbilityTargetDataHandle& TargetData,
int32 Index,
AActor* Actor
)

 Returns true if the given TargetData has the actor passed in targeted AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|TargetData"

static void EffectContextAddHitResult ( FGameplayEffectContextHandle EffectContext,
FHitResult HitResult,
bool bReset
)

 Adds a hit result to the effect context AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|EffectContext"
  • Meta=(DisplayName="AddHitResult")

static AActor * EffectContextGetEffectCauser ( FGameplayEffectContextHandle EffectContext
)

 Gets the physical actor that caused the effect, possibly a projectile or weapon AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|EffectContext"
  • Meta=(DisplayName="GetEffectCauser")

static FHitResult EffectContextGetHitResult ( FGameplayEffectContextHandle EffectContext
)

 Extracts a hit result from the effect context if it is set AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|EffectContext"
  • Meta=(DisplayName="GetHitResult")

static AActor * EffectContextGetInstigatorActor ( FGameplayEffectContextHandle EffectContext
)

 Gets the instigating actor (that holds the ability system component) of the EffectContext AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|EffectContext"
  • Meta=(DisplayName="GetInstigatorActor")

static FVector EffectContextGetOrigin ( FGameplayEffectContextHandle EffectContext
)

 Gets the location the effect originated from AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|EffectContext"
  • Meta=(DisplayName="GetOrigin")

static AActor * EffectContextGetOriginalInstigatorActor ( FGameplayEffectContextHandle EffectContext
)

 Gets the original instigator actor that started the chain of events to cause this effect AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|EffectContext"
  • Meta=(DisplayName="GetOriginalInstigatorActor")

static UObject * EffectContextGetSourceObject ( FGameplayEffectContextHandle EffectContext
)

 Gets the source object of the effect. AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|EffectContext"
  • Meta=(DisplayName="GetSourceObject")

static bool EffectContextHasHitResult ( FGameplayEffectContextHandle EffectContext
)

 Returns true if there is a valid hit result inside the effect context AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|EffectContext"
  • Meta=(DisplayName="HasHitResult")

static bool EffectContextIsInstigatorLocallyControlled ( FGameplayEffectContextHandle EffectContext
)

 Returns true if the ability system component that instigated this is locally controlled AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|EffectContext"
  • Meta=(DisplayName="IsInstigatorLocallyControlled")

static bool EffectContextIsValid ( FGameplayEffectContextHandle EffectContext
)

 GameplayEffectContextReturns true if this context has ever been initialized AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|EffectContext"
  • Meta=(DisplayName="IsValid")

static void EffectContextSetOrigin ( FGameplayEffectContextHandle EffectContext,
FVector Origin
)

 Sets the location the effect originated from AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|EffectContext"
  • Meta=(DisplayName="SetOrigin")

static bool EqualEqual_ActiveGameplayEffectHandle ( const FActiveGameplayEffectHandle& A,
const FActiveGameplayEffectHandle& B
)

 Equality operator for two Active Gameplay Effect Handles AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayEffect"
  • Meta=(DisplayName="Equal (Active Gameplay Effect Handle)", CompactNodeTitle="==", ScriptOperator="==")

static bool EqualEqual_GameplayAbilitySpecHandle ( const FGameplayAbilitySpecHandle& A,
const FGameplayAbilitySpecHandle& B
)

 Equality operator for two Gameplay Ability Spec Handles AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayAbility"
  • Meta=(DisplayName="Equal (Gameplay Ability Spec Handle)", CompactNodeTitle="==", ScriptOperator="==")

static bool EqualEqual_GameplayAttributeGameplayAttribute ( FGameplayAttribute AttributeA,
FGameplayAttribute AttributeB
)

 Simple equality operator for gameplay attributes AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Equal (Gameplay Attribute)", CompactNodeTitle="==", Keywords="== equal")
  • Category="Ability|Attribute"

static float EvaluateAttributeValueWithTags ( UAbilitySystemComponent* AbilitySystem,
FGameplayAttribute Attribute,
const FGameplayTagContainer& SourceTags,
const FGameplayTagContainer& TargetTags,
bool& bSuccess
)

 Returns the value of Attribute from the ability system component AbilitySystem after evaluating it with source and target tags. AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|Attribute"

static float EvaluateAttributeValueWithTagsAndBase ( UAbilitySystemComponent* AbilitySystem,
FGameplayAttribute Attribute,
const FGameplayTagContainer& SourceTags,
const FGameplayTagContainer& TargetTags,
float BaseValue,
bool& bSuccess
)

 Returns the value of Attribute from the ability system component AbilitySystem after evaluating it with source and target tags using the passed in base value instead of the real base value. AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|Attribute"

static FGameplayAbilityTargetDataHandle FilterTargetData ( const FGameplayAbilityTargetDataHandle& TargetDataHandle,
FGameplayTargetDataFilterHandle ActorFilterClass
)

 Create a new target data handle with filtration performed on the data AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|TargetData"

static void ForwardGameplayCueToTarget ( TScriptInterface< IGameplayCueInterface > TargetCueInterface,
EGameplayCueEvent::Type EventType,
FGameplayCueParameters Parameters
)

 Forwards the gameplay cue to another gameplay cue interface object AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayCue"

static UAbilitySystemComponent * GetAbilitySystemComponent ( AActor* Actor
)

 Tries to find an ability system component on the actor, will use AbilitySystemInterface or fall back to a component search AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category=Ability
  • Meta=(DefaultToSelf="Actor")

static UAbilitySystemComponent * GetAbilitySystemComponentFromActiveGameplayEffectHandle ( FActiveGameplayEffectHandle Handle
)

 Returns AbilitySystemComponent from an ActiveGameplayEffectHandle. AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static FString GetActiveGameplayEffectDebugString ( FActiveGameplayEffectHandle ActiveHandle
)

 Returns a debug string for display AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayEffect"
  • Meta=(DisplayName="Get Active GameplayEffect Debug String ")

static float GetActiveGameplayEffectExpectedEndTime ( FActiveGameplayEffectHandle ActiveHandle
)

 Returns the expected end time (when we think the GE will expire) for a given GameplayEffect (note someone could remove or change it before that happens!) AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static float GetActiveGameplayEffectRemainingDuration ( UObject* WorldContextObject,
FActiveGameplayEffectHandle ActiveHandle
)

 Returns the total duration for a given GameplayEffect, basically ExpectedEndTime - Current Time AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"
  • Meta=(WorldContext="WorldContextObject")
Returns current stack count of an active Gameplay Effect. AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"
Returns stack limit count of an active Gameplay Effect. AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static float GetActiveGameplayEffectStartTime ( FActiveGameplayEffectHandle ActiveHandle
)

 Returns the start time (time which the GE was added) for a given GameplayEffect AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static float GetActiveGameplayEffectTotalDuration ( FActiveGameplayEffectHandle ActiveHandle
)

 Returns the total duration for a given GameplayEffect AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static AActor * GetActorByIndex ( FGameplayCueParameters Parameters,
int32 Index
)

 Returns actor stored in the Effect Context used by this cue AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayCue"

static int32 GetActorCount ( FGameplayCueParameters Parameters
)

 Returns number of actors stored in the Effect Context used by this cue AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayCue"

static TArray< AActor * > GetActorsFromTargetData ( const FGameplayAbilityTargetDataHandle& TargetData,
int32 Index
)

 Returns all actors targeted, for a given index AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|TargetData"

static TArray< AActor * > GetAllActorsFromTargetData ( const FGameplayAbilityTargetDataHandle& TargetData
)

 Returns all actors targeted AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|TargetData"
Returns handles for all Linked GE Specs that SpecHandle may apply. AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayEffect"
  • Meta=(DeprecatedFunction, DeprecatedMessage="Linked GameplayEffects aren't replicated. Configure the GameplayEffect asset with a suitable GameplayEffectComponent.")

static FGameplayTagContainer GetAssetTags ( FGameplayEffectSpecHandle SpecHandle
)

 Return all asset tags of this GameplayEffectSpec: both from the GE asset and dynamic asset tags. AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static int32 GetDataCountFromTargetData ( const FGameplayAbilityTargetDataHandle& TargetData
)

 Returns number of target data objects, not necessarily number of distinct targets AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|TargetData"

static FString GetDebugStringFromGameplayAttribute ( const FGameplayAttribute& Attribute
)

 Returns FString representation of a gameplay attribute's set class and name, in the form of AttrSetName.AttrName (or just AttrName if not part of a set). AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|Attribute"

static EGameplayEffectDurationType GetDurationPolicyFromGameplayEffectSpecHandle ( FGameplayEffectSpecHandle Handle
)

 Returns the Duration Policy of a GameplayEffectSpec. AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static FGameplayEffectContextHandle GetEffectContext ( FGameplayEffectSpecHandle SpecHandle
)

 Gets the GameplayEffectSpec's effect context handle AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static float GetFloatAttribute ( const AActor* Actor,
FGameplayAttribute Attribute,
bool& bSuccessfullyFoundAttribute
)

 Returns the value of Attribute from the ability system component belonging to Actor. AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|Attribute"

static float GetFloatAttributeBase ( const AActor* Actor,
FGameplayAttribute Attribute,
bool& bSuccessfullyFoundAttribute
)

 Returns the base value of Attribute from the ability system component belonging to Actor. AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|Attribute"

static float GetFloatAttributeBaseFromAbilitySystemComponent ( const UAbilitySystemComponent* AbilitySystemComponent,
FGameplayAttribute Attribute,
bool& bSuccessfullyFoundAttribute
)

 Returns the base value of Attribute from the ability system component AbilitySystemComponent. AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|Attribute"

static float GetFloatAttributeFromAbilitySystemComponent ( const UAbilitySystemComponent* AbilitySystem,
FGameplayAttribute Attribute,
bool& bSuccessfullyFoundAttribute
)

 Returns the value of Attribute from the ability system component AbilitySystem. AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|Attribute"

static const UGameplayAbility * GetGameplayAbilityFromSpecHandle ( UAbilitySystemComponent* AbilitySystem,
const FGameplayAbilitySpecHandle& AbilitySpecHandle,
bool& bIsInstance
)

 GameplayAbility AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayAbility"

static bool GetGameplayCueDirection ( AActor* TargetActor,
FGameplayCueParameters Parameters,
FVector& Direction
)

 Gets the best normalized effect direction for this gameplay cue. AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayCue"

static bool GetGameplayCueEndLocationAndNormal ( AActor* TargetActor,
FGameplayCueParameters Parameters,
FVector& Location,
FVector& Normal
)

 Gets the best end location and normal for this gameplay cue. AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayCue"
Gameplay Effect AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayEffect"
  • Meta=(DisplayName="Get Asset Tags")
Returns the Gameplay Effect CDO from an active handle. AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayEffect"

static const UGameplayEffect * GetGameplayEffectFromSpecHandle ( FGameplayEffectSpecHandle Handle
)

 Get the GameplayEffect definition from a GameplayEffectSpecHandle. AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static const FGameplayTagContainer & GetGameplayEffectGrantedTags ( TSubclassOf< UGameplayEffect > EffectClass
)

 Returns all tags that the Gameplay Effect grants to the target Actor AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayEffect"
  • Meta=(DisplayName="Get Granted Tags")

static const UGameplayEffectUIData * GetGameplayEffectUIData ( TSubclassOf< UGameplayEffect > EffectClass,
TSubclassOf< UGameplayEffectUIData > DataType
)

 Returns the UI data for a gameplay effect class (if any) AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"
  • Meta=(DisplayName="Get GameplayEffect UI Data", DeterminesOutputType="DataType")

static FGameplayTagContainer GetGrantedTags ( FGameplayEffectSpecHandle SpecHandle
)

 Return all tags granted by this GameplayEffectSpec: both from the GE asset and dynamic granted tags. AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static FHitResult GetHitResult ( FGameplayCueParameters Parameters
)

 Returns a hit result stored in the effect context if valid AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayCue"

static FHitResult GetHitResultFromTargetData ( const FGameplayAbilityTargetDataHandle& HitResult,
int32 Index
)

 Returns the hit result for a given index if it exists AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|TargetData"

static AActor * GetInstigatorActor ( FGameplayCueParameters Parameters
)

 Gets the instigating actor (that holds the ability system component) of the GameplayCue AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayCue"

static FTransform GetInstigatorTransform ( FGameplayCueParameters Parameters
)

 Gets instigating world location AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayCue"
GameplayEffectSpec AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static float GetModifiedAttributeMagnitude ( const FGameplayEffectSpec& SpecHandle,
FGameplayAttribute Attribute
)

 Helper function that may be useful to call from native as well AbilitySystemBlueprintLibrary.h  

static FVector GetOrigin ( FGameplayCueParameters Parameters
)

 Gets instigating world location AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayCue"

static FVector GetTargetDataEndPoint ( const FGameplayAbilityTargetDataHandle& TargetData,
int32 Index
)

 Returns the end point for a given index if it exists AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|TargetData"

static FTransform GetTargetDataEndPointTransform ( const FGameplayAbilityTargetDataHandle& TargetData,
int32 Index
)

 Returns the end point transform for a given index if it exists AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|TargetData"

static FTransform GetTargetDataOrigin ( const FGameplayAbilityTargetDataHandle& TargetData,
int32 Index
)

 Returns the origin for a given index if it exists AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|TargetData"

static bool HasAnyAbilitiesByPredicate ( const UAbilitySystemComponent* AbilitySystemComponent,
const TFunctionRef< bool(const UGameplayAbility&AbilityRef)> Predicate,
bool bOnlyRunPredicateOnAbilityCDOs
)

 Returns true if the ASC has any abilities that meet a given predicate. AbilitySystemBlueprintLibrary.h  

static bool HasAnyAbilitiesWithAssetTag ( const UAbilitySystemComponent* AbilitySystemComponent,
FGameplayTag AssetTag
)

 Returns true if the ASC has any abilities that have a specific asset tag. AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayAbility"

static bool HasHitResult ( FGameplayCueParameters Parameters
)

 Checks if the effect context has a hit reslt stored inside AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayCue"

static bool IsActiveGameplayEffectHandleActive ( FActiveGameplayEffectHandle Handle
)

 Returns whether the active gameplay effect handle represents a gameplay effect that is valid and still active. AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"
FActiveGameplayEffectHandle AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static bool IsDurationGameplayEffectSpecHandle ( FGameplayEffectSpecHandle Handle
)

 Returns whether the GameplayEffectSpecHandle represents a non-instant GameplayEffect. AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static bool IsGameplayAbilityActive ( const UGameplayAbility* GameplayAbility
)

 Returns true if the passed-in Gameplay Ability instance is active (activated and not yet ended). AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayAbility"
  • Meta=(DisplayName="Is Active", DefaultToSelf=GameplayAbility)
GameplayCue AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayCue"

static bool IsInstigatorLocallyControlledPlayer ( FGameplayCueParameters Parameters
)

 Returns true if the ability system component that spawned this cue is locally controlled and a player AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayCue"

static bool IsValid ( FGameplayAttribute Attribute
)

 AttributeReturns true if the attribute actually exists AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|Attribute"

static FGameplayTargetDataFilterHandle MakeFilterHandle ( FGameplayTargetDataFilter Filter,
AActor* FilterActor
)

 Create a handle for filtering target data, filling out all fields AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Filter"

static FGameplayCueParameters MakeGameplayCueParameters ( float NormalizedMagnitude,
float RawMagnitude,
FGameplayEffectContextHandle EffectContext,
FGameplayTag MatchedTagName,
FGameplayTag OriginalTag,
FGameplayTagContainer AggregatedSourceTags,
FGameplayTagContainer AggregatedTargetTags,
FVector Location,
FVector Normal,
AActor* Instigator,
AActor* EffectCauser,
UObject* SourceObject,
UPhysicalMaterial* PhysicalMaterial,
int32 GameplayEffectLevel,
int32 AbilityLevel,
USceneComponent* TargetAttachComponent,
bool bReplicateLocationWhenUsingMinimalRepProxy
)

 Native make, to avoid having to deal with quantized vector types AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayCue"
  • Meta=(NativeMakeFunc, AdvancedDisplay=5, Location="0,0,0", Normal="0,0,0", GameplayEffectLevel="1", AbilityLevel="1")

static FGameplayEffectSpecHandle MakeSpecHandle ( UGameplayEffect* InGameplayEffect,
AActor* InInstigator,
AActor* InEffectCauser,
float InLevel
)

 Create a spec handle, filling out all fields AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Spec"
  • Meta=(DeprecatedFunction, DeprecatedMessage="Use Make Spec Handle (By Class)")

static FGameplayEffectSpecHandle MakeSpecHandleByClass ( TSubclassOf< UGameplayEffect > GameplayEffect,
AActor* Instigator,
AActor* EffectCauser,
float Level
)

 Create a spec handle, filling out all fields AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Spec"
  • Meta=(DisplayName="Make Spec Handle (By Class)")

static bool NotEqual_ActiveGameplayEffectHandle ( const FActiveGameplayEffectHandle& A,
const FActiveGameplayEffectHandle& B
)

 Inequality operator for two Active Gameplay Effect Handles AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayEffect"
  • Meta=(DisplayName="Not Equal (Active Gameplay Effect Handle)", CompactNodeTitle="!=", ScriptOperator="!=")

static bool NotEqual_GameplayAbilitySpecHandle ( const FGameplayAbilitySpecHandle& A,
const FGameplayAbilitySpecHandle& B
)

 Inequality operator for two Gameplay Ability Spec Handles AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|GameplayAbility"
  • Meta=(DisplayName="Not Equal (Gameplay Ability Spec Handle)", CompactNodeTitle="!=", ScriptOperator="!=")

static bool NotEqual_GameplayAttributeGameplayAttribute ( FGameplayAttribute AttributeA,
FGameplayAttribute AttributeB
)

 Simple inequality operator for gameplay attributes AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Not Equal (Gameplay Attribute)", CompactNodeTitle="!=", Keywords="!= not equal")
  • Category="Ability|Attribute"

static void ProcessGameplayTagChangedEventWrapper ( const FGameplayTag GameplayTag,
int32 GameplayTagCount,
FOnGameplayTagChangedEventWrapperSignature GameplayTagChangedEventWrapperDelegate
)

 Helper fn to process gameplay tag changed event wrappers. AbilitySystemBlueprintLibrary.h  

static bool RemoveGameplayTags ( AActor* Actor,
const FGameplayTagContainer& GameplayTags,
EGameplayTagReplicationState ReplicationRule
)

 Manually removes a set of tags from a given actor AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static bool RemoveLooseGameplayTags ( AActor* Actor,
const FGameplayTagContainer& GameplayTags,
bool bShouldReplicate
)

 Manually removes a set of tags from a given actor, with optional replication. AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static void SendGameplayEventToActor ( AActor* Actor,
FGameplayTag EventTag,
FGameplayEventData Payload
)

 This function can be used to trigger an ability on the actor in question with useful payload data. AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category=Ability
  • Meta=(ToolTip="This function can be used to trigger an ability on the actor in question with useful payload data.")

static FGameplayEffectSpecHandle SetDuration ( FGameplayEffectSpecHandle SpecHandle,
float Duration
)

 Manually sets the duration on a specific effect AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static FGameplayEffectSpecHandle SetStackCount ( FGameplayEffectSpecHandle SpecHandle,
int32 StackCount
)

 Sets the GameplayEffectSpec's StackCount to the specified amount (prior to applying) AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static FGameplayEffectSpecHandle SetStackCountToMax ( FGameplayEffectSpecHandle SpecHandle
)

 Sets the GameplayEffectSpec's StackCount to the max stack count defined in the GameplayEffect definition AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Ability|GameplayEffect"

static bool TargetDataHasActor ( const FGameplayAbilityTargetDataHandle& TargetData,
int32 Index
)

 Returns true if the given TargetData has at least 1 actor targeted AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|TargetData"

static bool TargetDataHasEndPoint ( const FGameplayAbilityTargetDataHandle& TargetData,
int32 Index
)

 Returns true if the target data has an end point AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|TargetData"

static bool TargetDataHasHitResult ( const FGameplayAbilityTargetDataHandle& HitResult,
int32 Index
)

 Returns true if the target data has a hit result AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|TargetData"

static bool TargetDataHasOrigin ( const FGameplayAbilityTargetDataHandle& TargetData,
int32 Index
)

 Returns true if the target data has an origin AbilitySystemBlueprintLibrary.h
  • BlueprintPure
  • Category="Ability|TargetData"
Unbinds the event wrapper tag change event bound via a BindEventWrapper method that is tied to the given Handle. AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Gameplay Tags"
Unbinds the event wrapper tag change event bound via a BindEventWrapper method that is tied to the given Handle, for the specific tag. AbilitySystemBlueprintLibrary.h
  • BlueprintCallable
  • Category="Gameplay Tags"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page