1. Epic GamesDeveloper
  3. UAbilitySystemBlueprintLibrary

UAbilitySystemBlueprintLibrary

Blueprint library for ability system.

API > API/Plugins > API/Plugins/GameplayAbilities

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Meta&61;&40;ScriptName&61;"AbilitySystemLibrary"&41;&41;  
class UAbilitySystemBlueprintLibrary : public UBlueprintFunctionLibrary

Remarks

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

Constructors

  Type Name Description
Public function  

UAbilitySystemBlueprintLibrary ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static UFunction BlueprintPure, Category FGameplayAbilityTargetDataHandle Creates single actor target data
Public function Static UFunction BlueprintPure, Category FGameplayAbilityTargetDataHandle

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

 Creates actor array target data
Public function Static UFunction BlueprintPure, Category FGameplayAbilityTargetDataHandle Creates a target data with a single hit result
Public function Static UFunction BlueprintPure, Category FGameplayAbilityTargetDataHandle Creates a target data with a source and destination location
Public function Static UFunction BlueprintCallable, Category FGameplayEffectSpecHandle

AddAssetTag ( FGameplayEffectSpecHandle SpecHandle,
FGameplayTag NewGameplayTag
)

 Adds NewGameplayTag to this instance of the effect
Public function Static UFunction BlueprintCallable, Category FGameplayEffectSpecHandle Adds NewGameplayTags to this instance of the effect
Public function Static UFunction BlueprintCallable, Category FGameplayEffectSpecHandle

AddGrantedTag ( FGameplayEffectSpecHandle SpecHandle,
FGameplayTag NewGameplayTag
)

 This instance of the effect will now grant NewGameplayTag to the object that this effect is applied to
Public function Static UFunction BlueprintCallable, Category FGameplayEffectSpecHandle This instance of the effect will now grant NewGameplayTags to the object that this effect is applied to
Public function Static UFunction BlueprintCallable, Category bool

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

 Manually adds a set of tags to a given actor, and optionally replicates them.
Public function Static UFunction BlueprintCallable, Category FGameplayAbilityTargetDataHandle TargetData Copies targets from HandleToAdd to TargetHandle
Public function Static UFunction BlueprintCallable, Category FGameplayEffectSpecHandle

AssignSetByCallerMagnitude ( FGameplayEffectSpecHandle SpecHandle,
FName DataName,
float Magnitude
)

 GameplayEffectSpec
Public function Static UFunction BlueprintCallable, Category, Meta FGameplayEffectSpecHandle

AssignTagSetByCallerMagnitude ( FGameplayEffectSpecHandle SpecHandle,
FGameplayTag DataTag,
float Magnitude
)

 Sets a gameplay tag Set By Caller magnitude value
Public function Static UFunction BlueprintPure, Category, Meta 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
Public function Static UFunction BlueprintPure, Category FGameplayEffectSpecHandle

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

 Create a spec handle, cloning another
Public function Static UFunction BlueprintPure, Category bool Returns true if the aggregated source and target tags from the effect spec meets the tag requirements
Public function Static UFunction BlueprintPure, Category bool

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

 Returns true if the given TargetData has the actor passed in targeted
Public function Static UFunction BlueprintCallable, Category, Meta void

EffectContextAddHitResult ( FGameplayEffectContextHandle EffectContext,
FHitResult HitResult,
bool bReset
)

 Adds a hit result to the effect context
Public function Static UFunction BlueprintPure, Category, Meta AActor * Gets the physical actor that caused the effect, possibly a projectile or weapon
Public function Static UFunction BlueprintPure, Category, Meta FHitResult Extracts a hit result from the effect context if it is set
Public function Static UFunction BlueprintPure, Category, Meta AActor * Gets the instigating actor (that holds the ability system component) of the EffectContext
Public function Static UFunction BlueprintPure, Category, Meta FVector Gets the location the effect originated from
Public function Static UFunction BlueprintPure, Category, Meta AActor * Gets the original instigator actor that started the chain of events to cause this effect
Public function Static UFunction BlueprintPure, Category, Meta UObject * Gets the source object of the effect.
Public function Static UFunction BlueprintPure, Category, Meta bool Returns true if there is a valid hit result inside the effect context
Public function Static UFunction BlueprintPure, Category, Meta bool Returns true if the ability system component that instigated this is locally controlled
Public function Static UFunction BlueprintPure, Category, Meta bool GameplayEffectContext Returns true if this context has ever been initialized
Public function Static UFunction BlueprintCallable, Category, Meta void

EffectContextSetOrigin ( FGameplayEffectContextHandle EffectContext,
FVector Origin
)

 Sets the location the effect originated from
Public function Static UFunction BlueprintPure, Category, Meta bool Equality operator for two Active Gameplay Effect Handles
Public function Static UFunction BlueprintPure, Category, Meta bool Equality operator for two Gameplay Ability Spec Handles
Public function Static UFunction BlueprintPure, Category, Meta bool Simple equality operator for gameplay attributes
Public function Static UFunction BlueprintPure, Category 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.
Public function Static UFunction BlueprintPure, Category 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.
Public function Static UFunction BlueprintPure, Category FGameplayAbilityTargetDataHandle Create a new target data handle with filtration performed on the data
Public function Static UFunction BlueprintCallable, Category void Forwards the gameplay cue to another gameplay cue interface object
Public function Static UFunction BlueprintPure, Category, Meta UAbilitySystemComponent * Tries to find an ability system component on the actor, will use AbilitySystemInterface or fall back to a component search
Public function Static UFunction BlueprintPure, Category, Meta FString Returns a debug string for display
Public function Static UFunction BlueprintCallable, Category float 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!)
Public function Static UFunction BlueprintCallable, Category, Meta float Returns the total duration for a given GameplayEffect, basically ExpectedEndTime - Current Time
Public function Static UFunction BlueprintCallable, Category int32 FActiveGameplayEffectHandle
Public function Static UFunction BlueprintCallable, Category int32 Returns stack limit count of an active Gameplay Effect.
Public function Static UFunction BlueprintCallable, Category float Returns the start time (time which the GE was added) for a given GameplayEffect
Public function Static UFunction BlueprintCallable, Category float Returns the total duration for a given GameplayEffect
Public function Static UFunction BlueprintPure, Category AActor *

GetActorByIndex ( FGameplayCueParameters Parameters,
int32 Index
)

 Returns actor stored in the Effect Context used by this cue
Public function Static UFunction BlueprintPure, Category int32 Returns number of actors stored in the Effect Context used by this cue
Public function Static UFunction BlueprintPure, Category TArray< AActor * >

GetActorsFromTargetData ( const FGameplayAbilityTargetDataHandle& TargetData,
int32 Index
)

 Returns all actors targeted, for a given index
Public function Static UFunction BlueprintPure, Category TArray< AActor * > Returns all actors targeted
Public function Static UFunction BlueprintPure, Category int32 Returns number of target data objects, not necessarily number of distinct targets
Public function Static UFunction BlueprintPure, Category FString 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).
Public function Static UFunction BlueprintCallable, Category FGameplayEffectContextHandle Gets the GameplayEffectSpec's effect context handle
Public function Static UFunction BlueprintPure, Category float

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

 Returns the value of Attribute from the ability system component belonging to Actor.
Public function Static UFunction BlueprintPure, Category float

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

 Returns the base value of Attribute from the ability system component belonging to Actor.
Public function Static UFunction BlueprintPure, Category float

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

 Returns the base value of Attribute from the ability system component AbilitySystemComponent.
Public function Static UFunction BlueprintPure, Category float

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

 Returns the value of Attribute from the ability system component AbilitySystem.
Public function Static UFunction BlueprintPure, Category const UGameplayAbility *

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

 GameplayAbility
Public function Static UFunction BlueprintPure, Category bool

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

 Gets the best normalized effect direction for this gameplay cue.
Public function Static UFunction BlueprintPure, Category bool

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

 Gets the best end location and normal for this gameplay cue.
Public function Static UFunction BlueprintPure, Category const UGameplayEffect * Returns the Gameplay Effect CDO from an active handle.
Public function Static UFunction BlueprintCallable, Category, Meta const UGameplayEffectUIData * Returns the UI data for a gameplay effect class (if any)
Public function Static UFunction BlueprintPure, Category FHitResult Returns a hit result stored in the effect context if valid
Public function Static UFunction BlueprintPure, Category FHitResult Returns the hit result for a given index if it exists
Public function Static UFunction BlueprintPure, Category AActor * Gets the instigating actor (that holds the ability system component) of the GameplayCue
Public function Static UFunction BlueprintPure, Category FTransform Gets instigating world location
Public function Static UFunction BlueprintCallable, Category float GameplayEffectSpec
Public function Static float Helper function that may be useful to call from native as well
Public function Static UFunction BlueprintPure, Category FVector Gets instigating world location
Public function Static UFunction BlueprintPure, Category FVector

GetTargetDataEndPoint ( const FGameplayAbilityTargetDataHandle& TargetData,
int32 Index
)

 Returns the end point for a given index if it exists
Public function Static UFunction BlueprintPure, Category FTransform Returns the end point transform for a given index if it exists
Public function Static UFunction BlueprintPure, Category FTransform

GetTargetDataOrigin ( const FGameplayAbilityTargetDataHandle& TargetData,
int32 Index
)

 Returns the origin for a given index if it exists
Public function Static UFunction BlueprintPure, Category bool Checks if the effect context has a hit reslt stored inside
Public function Static UFunction BlueprintPure, Category bool GameplayCue
Public function Static UFunction BlueprintPure, Category bool Returns true if the ability system component that spawned this cue is locally controlled and a player
Public function Static UFunction BlueprintPure, Category bool

IsValid ( FGameplayAttribute Attribute
)

 Attribute Returns true if the attribute actually exists
Public function Static UFunction BlueprintPure, Category FGameplayTargetDataFilterHandle Create a handle for filtering target data, filling out all fields
Public function Static UFunction BlueprintPure, Category, Meta 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
Public function Static UFunction BlueprintPure, Category FGameplayEffectSpecHandle

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

 Create a spec handle, filling out all fields
Public function Static UFunction BlueprintPure, Category, Meta bool Inequality operator for two Active Gameplay Effect Handles
Public function Static UFunction BlueprintPure, Category, Meta bool Inequality operator for two Gameplay Ability Spec Handles
Public function Static UFunction BlueprintPure, Category, Meta bool Simple inequality operator for gameplay attributes
Public function Static UFunction BlueprintCallable, Category bool

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

 Manually removes a set of tags from a given actor, with optional replication.
Public function Static UFunction BlueprintCallable, Category, Meta void This function can be used to trigger an ability on the actor in question with useful payload data.
Public function Static UFunction BlueprintCallable, Category FGameplayEffectSpecHandle

SetDuration ( FGameplayEffectSpecHandle SpecHandle,
float Duration
)

 Manually sets the duration on a specific effect
Public function Static UFunction BlueprintCallable, Category FGameplayEffectSpecHandle

SetStackCount ( FGameplayEffectSpecHandle SpecHandle,
int32 StackCount
)

 Sets the GameplayEffectSpec's StackCount to the specified amount (prior to applying)
Public function Static UFunction BlueprintCallable, Category FGameplayEffectSpecHandle Sets the GameplayEffectSpec's StackCount to the max stack count defined in the GameplayEffect definition
Public function Static UFunction BlueprintPure, Category bool

TargetDataHasActor ( const FGameplayAbilityTargetDataHandle& TargetData,
int32 Index
)

 Returns true if the given TargetData has at least 1 actor targeted
Public function Static UFunction BlueprintPure, Category bool

TargetDataHasEndPoint ( const FGameplayAbilityTargetDataHandle& TargetData,
int32 Index
)

 Returns true if the target data has an end point
Public function Static UFunction BlueprintPure, Category bool

TargetDataHasHitResult ( const FGameplayAbilityTargetDataHandle& HitResult,
int32 Index
)

 Returns true if the target data has a hit result
Public function Static UFunction BlueprintPure, Category bool

TargetDataHasOrigin ( const FGameplayAbilityTargetDataHandle& TargetData,
int32 Index
)

 Returns true if the target data has an origin

Deprecated Functions

  Type Name Description
Public function Static UFunction BlueprintCallable, Category, Meta FGameplayEffectSpecHandle Linked GameplayEffects aren't replicated. The new UAdditionalGameplayEffectsComponent renders this functionality obsolete (and since it's configured in the Asset, it is properly synced).
Public function Static UFunction BlueprintCallable, Category, Meta FGameplayEffectSpecHandle Linked GameplayEffects aren't replicated. The new UAdditionalGameplayEffectsComponent renders this functionality obsolete (and since it's configured in the Asset, it is properly synced).
Public function Static UFunction BlueprintPure, Category, Meta TArray< FGameplayEffectSpecHandle > Linked GameplayEffects aren't replicated. The new UAdditionalGameplayEffectsComponent renders this functionality obsolete (and since it's configured in the Asset, it is properly synced).

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page