UBlueprintGameplayTagLibrary

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

GameplayTags

Header

/Engine/Source/Runtime/GameplayTags/Classes/BlueprintGameplayTagLibrary.h

Include

#include "BlueprintGameplayTagLibrary.h"

Syntax

class UBlueprintGameplayTagLibrary : public UBlueprintFunctionLibrary

Constructors

Name Description

Public function

UBlueprintGameplayTagLibrary

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Static

void

 

AddGameplayTag

(
    FGameplayTagContainer& TagContaine...,
    FGameplayTag Tag
)

Adds a single tag to the passed in tag container

Public function Static

void

 

AppendGameplayTagContainers

(
    FGameplayTagContainer& InOutTagCon...,
    const FGameplayTagContainer& InTag...
)

Appends all tags in the InTagContainer to InOutTagContainer

Public function Static

void

 

BreakGameplayTagContainer

(
    const FGameplayTagContainer& Gamep...,
    TArray< FGameplayTag >& GameplayTa...
)

Breaks tag container into explicit array of tags

Public function Static

bool

 

DoesContainerMatchTagQuery

(
    const FGameplayTagContainer& TagCo...,
    const FGameplayTagQuery& TagQuery
)

Check if the specified tag container matches the given Tag Query

Public function Static

bool

 

DoesTagAssetInterfaceHaveTag

(
    TScriptInterface< IGameplayTagAsset...,
    FGameplayTag Tag
)

Check if the specified tag container has the specified tag, using the specified tag matching types

Public function Static

bool

 

EqualEqual_GameplayTag

(
    FGameplayTag A,
    FGameplayTag B
)

Returns true if the values are equal (A == B)

Public function Static

bool

 

EqualEqual_GameplayTagContainer

(
    const FGameplayTagContainer& A,
    const FGameplayTagContainer& B
)

Returns true if the values are equal (A == B)

Public function Static

void

 

GetAllActorsOfClassMatchingTagQuery

(
    UObject* WorldContextObject,
    TSubclassOf< AActor > ActorClass,
    const FGameplayTagQuery& GameplayT...,
    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

FString

 

GetDebugStringFromGameplayTag

(
    FGameplayTag GameplayTag
)

Returns an FString representation of a gameplay tag for debugging purposes.

Public function Static

FString

 

GetDebugStringFromGameplayTagContainer

(
    const FGameplayTagContainer& TagCo...
)

Returns an FString listing all of the gameplay tags in the tag container for debugging purposes.

Public function Static

int32

 

GetNumGameplayTagsInContainer

(
    const FGameplayTagContainer& TagCo...
)

Get the number of gameplay tags in the specified container

Public function Static

FName

 

GetTagName

(
    const FGameplayTag& GameplayTag
)

Returns FName of this tag

Public function Static

bool

 

HasAllMatchingGameplayTags

(
    TScriptInterface< IGameplayTagAsset...,
    const FGameplayTagContainer& Other...
)

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

bool

 

HasAllTags

(
    const FGameplayTagContainer& TagCo...,
    const FGameplayTagContainer& Other...,
    bool bExactMatch
)

Check if the specified tag container has ALL of the tags in the other container

Public function Static

bool

 

HasAnyTags

(
    const FGameplayTagContainer& TagCo...,
    const FGameplayTagContainer& Other...,
    bool bExactMatch
)

Check if the specified tag container has ANY of the tags in the other container

Public function Static

bool

 

HasTag

(
    const FGameplayTagContainer& TagCo...,
    FGameplayTag Tag,
    bool bExactMatch
)

Check if the tag container has the specified tag

Public function Static

bool

 

IsGameplayTagValid

(
    FGameplayTag GameplayTag
)

Returns true if the passed in gameplay tag is non-null

Public function Static

bool

 

IsTagQueryEmpty

(
    const FGameplayTagQuery& TagQuery
)

Check if the specified tag query is empty

Public function Static

FGameplayTag...

 

MakeGameplayTagContainerFromArray

(
    const TArray< FGameplayTag >& Game...
)

Creates a FGameplayTagContainer from the array of passed in tags

Public function Static

FGameplayTag...

 

MakeGameplayTagContainerFromTag

(
    FGameplayTag SingleTag
)

Creates a FGameplayTagContainer containing a single tag

Public function Static

FGameplayTag...

 

MakeGameplayTagQuery

(
    FGameplayTagQuery TagQuery
)

Creates a literal FGameplayTagQuery

Public function Static

FGameplayTag

 

MakeLiteralGameplayTag

(
    FGameplayTag Value
)

Creates a literal FGameplayTag

Public function Static

FGameplayTag...

 

MakeLiteralGameplayTagContainer

(
    FGameplayTagContainer Value
)

Creates a literal FGameplayTagContainer

Public function Static

bool

 

MatchesAnyTags

(
    FGameplayTag TagOne,
    const FGameplayTagContainer& Other...,
    bool bExactMatch
)

Determine if TagOne matches against any tag in OtherContainer

Public function Static

bool

 

MatchesTag

(
    FGameplayTag TagOne,
    FGameplayTag TagTwo,
    bool bExactMatch
)

Determine if TagOne matches against TagTwo

Public function Static

bool

 

NotEqual_GameplayTag

(
    FGameplayTag A,
    FGameplayTag B
)

Returns true if the values are not equal (A != B)

Public function Static

bool

 

NotEqual_GameplayTagContainer

(
    const FGameplayTagContainer& A,
    const FGameplayTagContainer& B
)

Returns true if the values are not equal (A != B)

Public function 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

Public function Static

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

bool

 

RemoveGameplayTag

(
    FGameplayTagContainer& TagContaine...,
    FGameplayTag Tag
)

Remove a single tag from the passed in tag container, returns true if found