1. Epic GamesDeveloper
  3. UBlueprintGameplayTagLibrary

UBlueprintGameplayTagLibrary

Unreal Engine C++ API Reference > Runtime > GameplayTags

Inheritance Hierarchy

  • UBlueprintFunctionLibrary
  • UBlueprintGameplayTagLibrary

References

   
Module GameplayTags
Header /Engine/Source/Runtime/GameplayTags/Classes/BlueprintGameplayTagLibrary.h
Include #include "BlueprintGameplayTagLibrary.h"

Syntax

UCLASS (Meta=(ScriptName="GameplayTagLibrary"), MinimalAPI)  
class UBlueprintGameplayTagLibrary : public UBlueprintFunctionLibrary

Constructors

  Type Name Description
Public function  

UBlueprintGameplayTagLibrary ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static UFunction BlueprintCallable, Category, Meta void Adds a single tag to the passed in tag container
Public function Static UFunction BlueprintCallable, Category, Meta void

AppendGameplayTagContainers ( UPARAM(ref) FGameplayTagContainer& InOutTagContainer,
const FGameplayTagContainer& InTagContainer
)

 Appends all tags in the InTagContainer to InOutTagContainer
Public function Static UFunction BlueprintPure, Category, Meta void

BreakGameplayTagContainer ( const FGameplayTagContainer& GameplayTagContainer,
TArray< FGameplayTag >& GameplayTags
)

 Breaks tag container into explicit array of tags
Public function Static UFunction BlueprintPure, Category, Meta TScriptInterface< IGameplayTagAssetInterface > Converts a UObject to a GameplayTagAssetInterface.
Public function Static UFunction BlueprintPure, Category, Meta bool

DoesContainerMatchTagQuery ( const FGameplayTagContainer& TagContainer,
const FGameplayTagQuery& TagQuery
)

 Check if the specified tag container matches the given Tag Query
Public function Static UFunction BlueprintPure, Meta bool

DoesTagAssetInterfaceHaveTag ( TScriptInterface< IGameplayTagAssetInterface > TagContainerInterface,
FGameplayTag Tag
)

 Check if the specified tag container has the specified tag, using the specified tag matching types
Public function Static UFunction BlueprintPure, Category, Meta bool Returns true if the values are equal (A == B)
Public function Static UFunction BlueprintPure, Category, Meta bool Returns true if the values are equal (A == B)
Public function Static UFunction BlueprintCallable, Category, Meta void

GetAllActorsOfClassMatchingTagQuery ( UObject* WorldContextObject,
TSubclassOf< AActor > ActorClass,
const FGameplayTagQuery& GameplayTagQuery,
TArray< AActor* >& OutActors
)

 Get an array of all actors of a specific class (or subclass of that class) which match the specified gameplay tag query.
Public function Static UFunction BlueprintPure, Category, Meta FString Returns an FString representation of a gameplay tag for debugging purposes.
Public function Static UFunction BlueprintPure, Category, Meta FString Returns an FString listing all of the gameplay tags in the tag container for debugging purposes.
Public function Static UFunction BlueprintPure, Category, Meta int32 Get the number of gameplay tags in the specified container
Public function Static UFunction BlueprintPure, Category, Meta FName

GetTagName ( const FGameplayTag& GameplayTag
)

 Returns FName of this tag
Public function Static UFunction BlueprintPure, Meta bool

HasAllMatchingGameplayTags ( TScriptInterface< IGameplayTagAssetInterface > TagContainerInterface,
const FGameplayTagContainer& OtherContainer
)

 Check Gameplay tags in the interface has all of the specified tags in the tag container (expands to include parents of asset tags)
Public function Static UFunction BlueprintPure, Category, Meta bool

HasAllTags ( const FGameplayTagContainer& TagContainer,
const FGameplayTagContainer& OtherContainer,
bool bExactMatch
)

 Check if the specified tag container has ALL of the tags in the other container
Public function Static UFunction BlueprintPure, Category, Meta bool

HasAnyTags ( const FGameplayTagContainer& TagContainer,
const FGameplayTagContainer& OtherContainer,
bool bExactMatch
)

 Check if the specified tag container has ANY of the tags in the other container
Public function Static UFunction BlueprintPure, Category, Meta bool

HasTag ( const FGameplayTagContainer& TagContainer,
FGameplayTag Tag,
bool bExactMatch
)

 Check if the tag container has the specified tag
Public function Static UFunction BlueprintPure, Category, Meta bool Returns true if the passed in gameplay tag is non-null
Public function Static UFunction BlueprintPure, Category, Meta bool

IsTagQueryEmpty ( const FGameplayTagQuery& TagQuery
)

 Check if the specified tag query is empty
Public function Static UFunction BlueprintPure, Category, Meta FGameplayTagContainer

MakeGameplayTagContainerFromArray ( const TArray< FGameplayTag >& GameplayTags
)

 Creates a FGameplayTagContainer from the array of passed in tags
Public function Static UFunction BlueprintPure, Category, Meta FGameplayTagContainer Creates a FGameplayTagContainer containing a single tag
Public function Static UFunction BlueprintPure, Category, Meta FGameplayTagQuery Creates a literal FGameplayTagQuery
Public function Static UFunction BlueprintPure, Category, Meta FGameplayTagQuery Creates a literal FGameplayTagQuery with a prepopulated AllTagsMatch expression
Public function Static UFunction BlueprintPure, Category, Meta FGameplayTagQuery Creates a literal FGameplayTagQuery with a prepopulated AnyTagsMatch expression
Public function Static UFunction BlueprintPure, Category, Meta FGameplayTagQuery Creates a literal FGameplayTagQuery with a prepopulated NoTagsMatch expression
Public function Static UFunction BlueprintPure, Category, Meta FGameplayTag Creates a literal FGameplayTag
Public function Static UFunction BlueprintPure, Category, Meta FGameplayTagContainer Creates a literal FGameplayTagContainer
Public function Static UFunction BlueprintPure, Category, Meta bool

MatchesAnyTags ( FGameplayTag TagOne,
const FGameplayTagContainer& OtherContainer,
bool bExactMatch
)

 Determine if TagOne matches against any tag in OtherContainer
Public function Static UFunction BlueprintPure, Category, Meta bool

MatchesTag ( FGameplayTag TagOne,
FGameplayTag TagTwo,
bool bExactMatch
)

 Determine if TagOne matches against TagTwo
Public function Static UFunction BlueprintPure, Category, Meta bool Returns true if the values are not equal (A != B)
Public function Static UFunction BlueprintPure, Category, Meta bool Returns true if the values are not equal (A != B)
Public function Static UFunction BlueprintPure, Category, Meta bool Checks if a gameplay tag containers's name and a string are not equal to one another
Public function Static UFunction BlueprintPure, Category, Meta bool

NotEqual_TagTag ( FGameplayTag A,
FString B
)

 Checks if a gameplay tag's name and a string are not equal to one another
Public function Static UFunction BlueprintCallable, Category, Meta bool Remove a single tag from the passed in tag container, returns true if found
Public function Static UFunction BlueprintPure, Category, Meta static

UPARAM ( DisplayName
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page