UBlueprintGameplayTagLibrary

API > API/Runtime > API/Runtime/GameplayTags

   
Name UBlueprintGameplayTagLibrary
Type class
Header File /Engine/Source/Runtime/GameplayTags/Classes/BlueprintGameplayTagLibrary.h
Include Path #include "BlueprintGameplayTagLibrary.h"

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UBlueprintGameplayTagLibrary ( const FObjectInitializer& ObjectInitializer
)

   BlueprintGameplayTagLibrary.h  

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static void AddGameplayTag ( FGameplayTagContainer& TagContainer,
FGameplayTag Tag
)

 Adds a single tag to the passed in tag container BlueprintGameplayTagLibrary.h
  • BlueprintCallable
  • Category="GameplayTags"
  • Meta=(BlueprintThreadSafe)

static void AppendGameplayTagContainers ( FGameplayTagContainer& InOutTagContainer,
const FGameplayTagContainer& InTagContainer
)

 Appends all tags in the InTagContainer to InOutTagContainer BlueprintGameplayTagLibrary.h
  • BlueprintCallable
  • Category="GameplayTags"
  • Meta=(BlueprintThreadSafe)

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

 Breaks tag container into explicit array of tags BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(BlueprintThreadSafe)
Converts a UObject to a GameplayTagAssetInterface. BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To GameplayTagAssetInterface", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|Casting"

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

 Check if the specified tag container matches the given Tag Query BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(BlueprintThreadSafe)

static bool DoesTagAssetInterfaceHaveTag ( TScriptInterface< IGameplayTagAssetInterface > TagContainerInterface,
FGameplayTag Tag
)

 Check if the specified tag container has the specified tag, using the specified tag matching types BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Meta=(BlueprintInternalUseOnly="TRUE")

static bool EqualEqual_GameplayTag ( FGameplayTag A,
FGameplayTag B
)

 Returns true if the values are equal (A == B) BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Equal (GameplayTag)", CompactNodeTitle="==", BlueprintThreadSafe)
  • Category="GameplayTags"

static bool EqualEqual_GameplayTagContainer ( const FGameplayTagContainer& A,
const FGameplayTagContainer& B
)

 Returns true if the values are equal (A == B) BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Equal (GameplayTagContainer)", CompactNodeTitle="==", BlueprintThreadSafe)
  • Category="GameplayTags"

static FGameplayTagContainer Filter ( const FGameplayTagContainer& TagContainer,
const FGameplayTagContainer& OtherContainer,
bool bExactMatch
)

 Returns a filtered version of this container, returns all tags that match against any of the tags in OtherContainer BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(BlueprintThreadSafe)

static 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. BlueprintGameplayTagLibrary.h
  • BlueprintCallable
  • Category="GameplayTags"
  • Meta=(WorldContext="WorldContextObject", DeterminesOutputType="ActorClass", DynamicOutputParam="OutActors")

static FString GetDebugStringFromGameplayTag ( FGameplayTag GameplayTag
)

 Returns an FString representation of a gameplay tag for debugging purposes. BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(BlueprintThreadSafe, BlueprintAutocast)

static FString GetDebugStringFromGameplayTagContainer ( const FGameplayTagContainer& TagContainer
)

 Returns an FString listing all of the gameplay tags in the tag container for debugging purposes. BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(BlueprintThreadSafe, BlueprintAutocast)

static int32 GetNumGameplayTagsInContainer ( const FGameplayTagContainer& TagContainer
)

 Get the number of gameplay tags in the specified container BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(BlueprintThreadSafe)

static FGameplayTagContainer GetOwnedGameplayTags ( TScriptInterface< IGameplayTagAssetInterface > TagContainerInterface
)

   BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(DefaultToSelf=TagContainerInterface)

static FName GetTagName ( const FGameplayTag& GameplayTag
)

 Returns FName of this tag BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(BlueprintThreadSafe)

static 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) BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Meta=(BlueprintInternalUseOnly="TRUE")

static 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 BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(Keywords="DoesContainerMatchAllTagsInContainer", BlueprintThreadSafe)

static bool HasAnyMatchingGameplayTags ( TScriptInterface< IGameplayTagAssetInterface > TagContainerInterface,
const FGameplayTagContainer& OtherContainer
)

 Check Gameplay tags in the interface has ANY of the specified tags in the tag container (expands to include parents of asset tags) BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Meta=(BlueprintInternalUseOnly="TRUE")

static 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 BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(Keywords="DoesContainerMatchAnyTagsInContainer", BlueprintThreadSafe)

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

 Check if the tag container has the specified tag BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(Keywords="DoesContainerHaveTag", BlueprintThreadSafe)

static bool IsGameplayTagValid ( FGameplayTag GameplayTag
)

 Returns true if the passed in gameplay tag is non-null BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(BlueprintThreadSafe)

static bool IsTagQueryEmpty ( const FGameplayTagQuery& TagQuery
)

 Check if the specified tag query is empty BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(BlueprintThreadSafe)

static FGameplayTagContainer MakeGameplayTagContainerFromArray ( const TArray< FGameplayTag >& GameplayTags
)

 Creates a FGameplayTagContainer from the array of passed in tags BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(BlueprintThreadSafe)

static FGameplayTagContainer MakeGameplayTagContainerFromTag ( FGameplayTag SingleTag
)

 Creates a FGameplayTagContainer containing a single tag BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(BlueprintThreadSafe)

static FGameplayTagQuery MakeGameplayTagQuery ( FGameplayTagQuery TagQuery
)

 Creates a literal FGameplayTagQuery BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(BlueprintThreadSafe)

static FGameplayTagQuery MakeGameplayTagQuery_MatchAllTags ( const FGameplayTagContainer& InTags
)

 Creates a literal FGameplayTagQuery with a prepopulated AllTagsMatch expression BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(BlueprintThreadSafe)

static FGameplayTagQuery MakeGameplayTagQuery_MatchAnyTags ( const FGameplayTagContainer& InTags
)

 Creates a literal FGameplayTagQuery with a prepopulated AnyTagsMatch expression BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(BlueprintThreadSafe)

static FGameplayTagQuery MakeGameplayTagQuery_MatchNoTags ( const FGameplayTagContainer& InTags
)

 Creates a literal FGameplayTagQuery with a prepopulated NoTagsMatch expression BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(BlueprintThreadSafe)

static FGameplayTag MakeLiteralGameplayTag ( FGameplayTag Value
)

 Creates a literal FGameplayTag BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(BlueprintThreadSafe)

static FGameplayTagContainer MakeLiteralGameplayTagContainer ( FGameplayTagContainer Value
)

 Creates a literal FGameplayTagContainer BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(BlueprintThreadSafe)

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

 Determine if TagOne matches against any tag in OtherContainer BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(BlueprintThreadSafe)

static bool MatchesTag ( FGameplayTag TagOne,
FGameplayTag TagTwo,
bool bExactMatch
)

 Determine if TagOne matches against TagTwo BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category="GameplayTags"
  • Meta=(Keywords="DoGameplayTagsMatch", BlueprintThreadSafe)

static bool NotEqual_GameplayTag ( FGameplayTag A,
FGameplayTag B
)

 Returns true if the values are not equal (A != B) BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Not Equal (GameplayTag)", CompactNodeTitle="!=", BlueprintThreadSafe)
  • Category="GameplayTags"

static bool NotEqual_GameplayTagContainer ( const FGameplayTagContainer& A,
const FGameplayTagContainer& B
)

 Returns true if the values are not equal (A != B) BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Not Equal (GameplayTagContainer)", CompactNodeTitle="!=", BlueprintThreadSafe)
  • Category="GameplayTags"

static bool NotEqual_TagContainerTagContainer ( FGameplayTagContainer A,
FString B
)

 Checks if a gameplay tag containers's name and a string are not equal to one another BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category=PinOptions
  • Meta=(BlueprintInternalUseOnly="TRUE")

static bool NotEqual_TagTag ( FGameplayTag A,
FString B
)

 Checks if a gameplay tag's name and a string are not equal to one another BlueprintGameplayTagLibrary.h
  • BlueprintPure
  • Category=PinOptions
  • Meta=(BlueprintInternalUseOnly="TRUE")

static bool RemoveGameplayTag ( FGameplayTagContainer& TagContainer,
FGameplayTag Tag
)

 Remove a single tag from the passed in tag container, returns true if found BlueprintGameplayTagLibrary.h
  • BlueprintCallable
  • Category="GameplayTags"
  • Meta=(BlueprintThreadSafe)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page