Class BlueprintGameplayTagLibrary

Blueprint Gameplay Tag Library

Inheritance
System.Object
UObject
BlueprintFunctionLibrary
BlueprintGameplayTagLibrary
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.GameplayTags
Assembly: UE4DotNet.dll
Syntax
public class BlueprintGameplayTagLibrary : BlueprintFunctionLibrary

Properties

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static BlueprintGameplayTagLibrary DefaultObject { get; }
Property Value
Type Description
BlueprintGameplayTagLibrary
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

AddGameplayTag(GameplayTagContainer, GameplayTag)

Adds a single tag to the passed in tag container @

Declaration
public static void AddGameplayTag(GameplayTagContainer TagContainer, GameplayTag Tag)
Parameters
Type Name Description
GameplayTagContainer TagContainer
GameplayTag Tag
Remarks

param InOutTagContainer The container that will be appended too. @param Tag The tag to add to the container

| Improve this Doc View Source

AppendGameplayTagContainers(GameplayTagContainer, GameplayTagContainer)

Appends all tags in the InTagContainer to InOutTagContainer @

Declaration
public static void AppendGameplayTagContainers(GameplayTagContainer InOutTagContainer, GameplayTagContainer InTagContainer)
Parameters
Type Name Description
GameplayTagContainer InOutTagContainer
GameplayTagContainer InTagContainer
Remarks

param InOutTagContainer The container that will be appended too. @param InTagContainer The container to append.

| Improve this Doc View Source

BreakGameplayTagContainer(GameplayTagContainer)

Breaks tag container into explicit array of tags

Declaration
public static IReadOnlyCollection<GameplayTag> BreakGameplayTagContainer(GameplayTagContainer GameplayTagContainer)
Parameters
Type Name Description
GameplayTagContainer GameplayTagContainer
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<GameplayTag>
| Improve this Doc View Source

DoesContainerMatchTagQuery(GameplayTagContainer, GameplayTagQuery)

Check if the specified tag container matches the given Tag Query @

Declaration
public static bool DoesContainerMatchTagQuery(GameplayTagContainer TagContainer, GameplayTagQuery TagQuery)
Parameters
Type Name Description
GameplayTagContainer TagContainer
GameplayTagQuery TagQuery
Returns
Type Description
System.Boolean
Remarks

param TagContainer Container to check if it matches all of the tags in the other container @param TagQuery Query to match against

@return True if the container matches the query, false otherwise.

| Improve this Doc View Source

DoesTagAssetInterfaceHaveTag(Byte, GameplayTag)

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

Declaration
public static bool DoesTagAssetInterfaceHaveTag(byte TagContainerInterface, GameplayTag Tag)
Parameters
Type Name Description
System.Byte TagContainerInterface
GameplayTag Tag
Returns
Type Description
System.Boolean
Remarks

param TagContainerInterface An Interface to a tag container @param Tag Tag to check for in the container

@return True if the container has the specified tag, false if it does not

| Improve this Doc View Source

EqualEqual_GameplayTag(GameplayTag, GameplayTag)

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

Declaration
public static bool EqualEqual_GameplayTag(GameplayTag A, GameplayTag B)
Parameters
Type Name Description
GameplayTag A
GameplayTag B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

EqualEqual_GameplayTagContainer(GameplayTagContainer, GameplayTagContainer)

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

Declaration
public static bool EqualEqual_GameplayTagContainer(GameplayTagContainer A, GameplayTagContainer B)
Parameters
Type Name Description
GameplayTagContainer A
GameplayTagContainer B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GetAllActorsOfClassMatchingTagQuery(UObject, SubclassOf<Actor>, GameplayTagQuery)

Get an array of all actors of a specific class (or subclass of that class) which match the specified gameplay tag query.

Declaration
public static IReadOnlyCollection<Actor> GetAllActorsOfClassMatchingTagQuery(UObject WorldContextObject, SubclassOf<Actor> ActorClass, GameplayTagQuery GameplayTagQuery)
Parameters
Type Name Description
UObject WorldContextObject
SubclassOf<Actor> ActorClass
GameplayTagQuery GameplayTagQuery
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<Actor>
Remarks

@param ActorClass Class of actors to fetch @param GameplayTagQuery Query to match against

| Improve this Doc View Source

GetDebugStringFromGameplayTag(GameplayTag)

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

Declaration
public static string GetDebugStringFromGameplayTag(GameplayTag GameplayTag)
Parameters
Type Name Description
GameplayTag GameplayTag
Returns
Type Description
System.String
Remarks

@param GameplayTag The tag to get the debug string from.

| Improve this Doc View Source

GetDebugStringFromGameplayTagContainer(GameplayTagContainer)

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

Declaration
public static string GetDebugStringFromGameplayTagContainer(GameplayTagContainer TagContainer)
Parameters
Type Name Description
GameplayTagContainer TagContainer
Returns
Type Description
System.String
Remarks

@param TagContainer The tag container to get the debug string from.

| Improve this Doc View Source

GetNumGameplayTagsInContainer(GameplayTagContainer)

Get the number of gameplay tags in the specified container @

Declaration
public static int GetNumGameplayTagsInContainer(GameplayTagContainer TagContainer)
Parameters
Type Name Description
GameplayTagContainer TagContainer
Returns
Type Description
System.Int32
Remarks

param TagContainer Tag container to get the number of tags from

@return The number of tags in the specified container

| Improve this Doc View Source

GetTagName(GameplayTag)

Returns FName of this tag

Declaration
public static Name GetTagName(GameplayTag GameplayTag)
Parameters
Type Name Description
GameplayTag GameplayTag
Returns
Type Description
Name
| Improve this Doc View Source

HasAllMatchingGameplayTags(Byte, GameplayTagContainer)

Check Gameplay tags in the interface has all of the specified tags in the tag container (expands to include parents of asset tags) @

Declaration
public static bool HasAllMatchingGameplayTags(byte TagContainerInterface, GameplayTagContainer OtherContainer)
Parameters
Type Name Description
System.Byte TagContainerInterface
GameplayTagContainer OtherContainer
Returns
Type Description
System.Boolean
Remarks

param TagContainerInterface An Interface to a tag container @param OtherContainer A Tag Container

@return True if the tagcontainer in the interface has all the tags inside the container.

| Improve this Doc View Source

HasAllTags(GameplayTagContainer, GameplayTagContainer, Boolean)

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

Declaration
public static bool HasAllTags(GameplayTagContainer TagContainer, GameplayTagContainer OtherContainer, bool bExactMatch)
Parameters
Type Name Description
GameplayTagContainer TagContainer
GameplayTagContainer OtherContainer
System.Boolean bExactMatch
Returns
Type Description
System.Boolean
Remarks

param TagContainer Container to check if it matches all of the tags in the other container @param OtherContainer Container to check against. If this is empty, the check will succeed @param bExactMatch If true, the tag has to be exactly present, if false then TagContainer will include it's parent tags while matching

@return True if the container has ALL of the tags in the other container

| Improve this Doc View Source

HasAnyTags(GameplayTagContainer, GameplayTagContainer, Boolean)

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

Declaration
public static bool HasAnyTags(GameplayTagContainer TagContainer, GameplayTagContainer OtherContainer, bool bExactMatch)
Parameters
Type Name Description
GameplayTagContainer TagContainer
GameplayTagContainer OtherContainer
System.Boolean bExactMatch
Returns
Type Description
System.Boolean
Remarks

param TagContainer Container to check if it matches any of the tags in the other container @param OtherContainer Container to check against. @param bExactMatch If true, the tag has to be exactly present, if false then TagContainer will include it's parent tags while matching

@return True if the container has ANY of the tags in the other container

| Improve this Doc View Source

HasTag(GameplayTagContainer, GameplayTag, Boolean)

Check if the tag container has the specified tag @

Declaration
public static bool HasTag(GameplayTagContainer TagContainer, GameplayTag Tag, bool bExactMatch)
Parameters
Type Name Description
GameplayTagContainer TagContainer
GameplayTag Tag
System.Boolean bExactMatch
Returns
Type Description
System.Boolean
Remarks

param TagContainer Container to check for the tag @param Tag Tag to check for in the container @param bExactMatch If true, the tag has to be exactly present, if false then TagContainer will include it's parent tags while matching

@return True if the container has the specified tag, false if it does not

| Improve this Doc View Source

IsGameplayTagValid(GameplayTag)

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

Declaration
public static bool IsGameplayTagValid(GameplayTag GameplayTag)
Parameters
Type Name Description
GameplayTag GameplayTag
Returns
Type Description
System.Boolean
| Improve this Doc View Source

MakeGameplayTagContainerFromArray(Byte)

Creates a FGameplayTagContainer from the array of passed in tags

Declaration
public static GameplayTagContainer MakeGameplayTagContainerFromArray(byte GameplayTags)
Parameters
Type Name Description
System.Byte GameplayTags
Returns
Type Description
GameplayTagContainer
| Improve this Doc View Source

MakeGameplayTagContainerFromTag(GameplayTag)

Creates a FGameplayTagContainer containing a single tag

Declaration
public static GameplayTagContainer MakeGameplayTagContainerFromTag(GameplayTag SingleTag)
Parameters
Type Name Description
GameplayTag SingleTag
Returns
Type Description
GameplayTagContainer
| Improve this Doc View Source

MakeGameplayTagQuery(GameplayTagQuery)

Creates a literal FGameplayTagQuery @

Declaration
public static GameplayTagQuery MakeGameplayTagQuery(GameplayTagQuery TagQuery)
Parameters
Type Name Description
GameplayTagQuery TagQuery
Returns
Type Description
GameplayTagQuery
Remarks

param TagQuery value to set the FGameplayTagQuery to

@return The literal FGameplayTagQuery

| Improve this Doc View Source

MakeLiteralGameplayTag(GameplayTag)

Creates a literal FGameplayTag

Declaration
public static GameplayTag MakeLiteralGameplayTag(GameplayTag Value)
Parameters
Type Name Description
GameplayTag Value
Returns
Type Description
GameplayTag
| Improve this Doc View Source

MakeLiteralGameplayTagContainer(GameplayTagContainer)

Creates a literal FGameplayTagContainer

Declaration
public static GameplayTagContainer MakeLiteralGameplayTagContainer(GameplayTagContainer Value)
Parameters
Type Name Description
GameplayTagContainer Value
Returns
Type Description
GameplayTagContainer
| Improve this Doc View Source

MatchesAnyTags(GameplayTag, GameplayTagContainer, Boolean)

Determine if TagOne matches against any tag in OtherContainer @

Declaration
public static bool MatchesAnyTags(GameplayTag TagOne, GameplayTagContainer OtherContainer, bool bExactMatch)
Parameters
Type Name Description
GameplayTag TagOne
GameplayTagContainer OtherContainer
System.Boolean bExactMatch
Returns
Type Description
System.Boolean
Remarks

param TagOne Tag to check for match @param OtherContainer Container to check against. @param bExactMatch If true, the tag has to be exactly present, if false then TagOne will include it's parent tags while matching

@return True if TagOne matches any tags explicitly present in OtherContainer

| Improve this Doc View Source

MatchesTag(GameplayTag, GameplayTag, Boolean)

Determine if TagOne matches against TagTwo @

Declaration
public static bool MatchesTag(GameplayTag TagOne, GameplayTag TagTwo, bool bExactMatch)
Parameters
Type Name Description
GameplayTag TagOne
GameplayTag TagTwo
System.Boolean bExactMatch
Returns
Type Description
System.Boolean
Remarks

param TagOne Tag to check for match @param TagTwo Tag to check match against @param bExactMatch If true, the tag has to be exactly present, if false then TagOne will include it's parent tags while matching

@return True if TagOne matches TagTwo

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static BlueprintGameplayTagLibrary New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
BlueprintGameplayTagLibrary
| Improve this Doc View Source

NotEqual_GameplayTag(GameplayTag, GameplayTag)

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

Declaration
public static bool NotEqual_GameplayTag(GameplayTag A, GameplayTag B)
Parameters
Type Name Description
GameplayTag A
GameplayTag B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

NotEqual_GameplayTagContainer(GameplayTagContainer, GameplayTagContainer)

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

Declaration
public static bool NotEqual_GameplayTagContainer(GameplayTagContainer A, GameplayTagContainer B)
Parameters
Type Name Description
GameplayTagContainer A
GameplayTagContainer B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

NotEqual_TagContainerTagContainer(GameplayTagContainer, String)

Checks if a gameplay tag containers's name and a string are not equal to one another

Declaration
public static bool NotEqual_TagContainerTagContainer(GameplayTagContainer A, string B)
Parameters
Type Name Description
GameplayTagContainer A
System.String B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

NotEqual_TagTag(GameplayTag, String)

Checks if a gameplay tag's name and a string are not equal to one another

Declaration
public static bool NotEqual_TagTag(GameplayTag A, string B)
Parameters
Type Name Description
GameplayTag A
System.String B
Returns
Type Description
System.Boolean
| Improve this Doc View Source

RemoveGameplayTag(GameplayTagContainer, GameplayTag)

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

Declaration
public static bool RemoveGameplayTag(GameplayTagContainer TagContainer, GameplayTag Tag)
Parameters
Type Name Description
GameplayTagContainer TagContainer
GameplayTag Tag
Returns
Type Description
System.Boolean
Remarks

param InOutTagContainer The container that will be appended too. @param Tag The tag to add to the container

Operators

| Improve this Doc View Source

Implicit(IntPtr to BlueprintGameplayTagLibrary)

Convert from IntPtr to UObject

Declaration
public static implicit operator BlueprintGameplayTagLibrary(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
BlueprintGameplayTagLibrary