1. Epic GamesDeveloper
  3. FGameplayTagContainer

FGameplayTagContainer

A Tag Container holds a collection of FGameplayTags, tags are included explicitly by adding them, and implicitly from adding child tags

Unreal Engine C++ API Reference > Runtime > GameplayTags

References

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

Syntax

USTRUCT (BlueprintType ,  
        Meta=(HasNativeMake="/Script/GameplayTags.BlueprintGameplayTagLibrary.MakeGameplayTagContainerFromArray", HasNativeBreak="/Script/GameplayTags.BlueprintGameplayTagLibrary.BreakGameplayTagContainer"))  
struct FGameplayTagContainer

Remarks

A Tag Container holds a collection of FGameplayTags, tags are included explicitly by adding them, and implicitly from adding child tags

Variables

  Type Name Description
Protected variable UProperty Category BlueprintReadWrite SaveGame visibleanywhere TArray< FGameplayTag > GameplayTags Array of gameplay tags
Protected variable UProperty Transient TArray< FGameplayTag > ParentTags Array of expanded parent tags, in addition to GameplayTags.

Constructors

  Type Name Description
Public function   Constructors
Public function    
Public function   Explicit to prevent people from accidentally using the wrong type of operation
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function bool

AddLeafTag ( const FGameplayTag& TagToAdd
)

 Adds a tag to the container and removes any direct parents, wont add if child already exists
Protected function void  
Public function void

AddTag ( const FGameplayTag& TagToAdd
)

 Add the specified tag to the container
Public function void

AddTagFast ( const FGameplayTag& TagToAdd
)

 Add the specified tag to the container without checking for uniqueness
Public function void Adds all the tags that match between the two specified containers to this container.
Public function void Adds all the tags from one container to this container NOTE: From set theory, this effectively is the union of the container this is called on with Other.
Public function Const bool

ComplexHasTag ( FGameplayTag const& TagToCheck,
TEnumAsByte< EGameplayTagMatchType::Type > TagMatchType,
TEnumAsByte< EGameplayTagMatchType::Type > TagToCheckMatchType
)

  
Public function Const TArray< FGameplayTag >::TConstIterator Creates a const iterator for the contents of this array
Public function Static FGameplayTagContainer

CreateFromArray ( const TArray< FGameplayTag, AllocatorType >& SourceTags
)

 Creates a container from an array of tags, this is more efficient than adding them all individually
Public function Const FORCEINLINE_DEBUGGABLE bool

DoesTagContainerMatch ( const FGameplayTagContainer& OtherContainer,
TEnumAsByte< EGameplayTagMatchType::Type > TagMatchType,
TEnumAsByte< EGameplayTagMatchType::Type > OtherTagMatchType,
EGameplayContainerMatchType ContainerMatchType
)

  
Public function void Fills in ParentTags from GameplayTags
Public function Const FGameplayTagContainer

Filter ( const FGameplayTagContainer& OtherContainer
)

 Returns a filtered version of this container, returns all tags that match against any of the tags in OtherContainer, expanding parents
Public function Const FGameplayTagContainer

FilterExact ( const FGameplayTagContainer& OtherContainer
)

 Returns a filtered version of this container, returns all tags that match exactly one in OtherContainer
Public function Const FGameplayTag

First ()

  
Public function void

FromExportString ( const FString& ExportString,
int32 PortFlags
)

 Sets from a ImportText string, used in asset registry
Public function Const FGameplayTag

GetByIndex ( int32 Index
)

  
Public function Const void

GetGameplayTagArray ( TArray< FGameplayTag >& InOutGameplayTags
)

 Gets the explicit list of gameplay tags
Public function Const const TArray< FGameplayTag > & Gets the explicit list of gameplay tags
Public function Const FGameplayTagContainer Returns a new container explicitly containing the tags of this container and all of their parent tags
Public function Const FORCEINLINE_DEBUGGABLE bool

HasAll ( const FGameplayTagContainer& ContainerToCheck
)

 Checks if this container contains ALL of the tags in the specified container, also checks against parent tags {"A.1","B.1"}.HasAll({"A","B"}) will return True, {"A","B"}.HasAll({"A.1","B.1"}) will return False If ContainerToCheck is empty/invalid it will always return True, because there were no failed checks
Public function Const FORCEINLINE_DEBUGGABLE bool

HasAllExact ( const FGameplayTagContainer& ContainerToCheck
)

 Checks if this container contains ALL of the tags in the specified container, only allowing exact matches {"A.1","B.1"}.HasAll({"A","B"}) will return False If ContainerToCheck is empty/invalid it will always return True, because there were no failed checks
Public function Const FORCEINLINE_DEBUGGABLE bool

HasAny ( const FGameplayTagContainer& ContainerToCheck
)

 Checks if this container contains ANY of the tags in the specified container, also checks against parent tags {"A.1"}.HasAny({"A","B"}) will return True, {"A"}.HasAny({"A.1","B"}) will return False If ContainerToCheck is empty/invalid it will always return False
Public function Const FORCEINLINE_DEBUGGABLE bool

HasAnyExact ( const FGameplayTagContainer& ContainerToCheck
)

 Checks if this container contains ANY of the tags in the specified container, only allowing exact matches {"A.1"}.HasAny({"A","B"}) will return False If ContainerToCheck is empty/invalid it will always return False
Public function Const FORCEINLINE_DEBUGGABLE bool

HasTag ( const FGameplayTag& TagToCheck
)

 Determine if TagToCheck is present in this container, also checking against parent tags {"A.1"}.HasTag("A") will return True, {"A"}.HasTag("A.1") will return False If TagToCheck is not Valid it will always return False
Public function Const FORCEINLINE_DEBUGGABLE bool

HasTagExact ( const FGameplayTag& TagToCheck
)

 Determine if TagToCheck is explicitly present in this container, only allowing exact matches {"A.1"}.HasTagExact("A") will return False If TagToCheck is not Valid it will always return False
Public function Const PRAGMA_DISABLE_DEPRECATION_WARNINGS FORCEINLINE_DEBUGGABLE bool

HasTagFast ( FGameplayTag const& TagToCheck,
TEnumAsByte< EGameplayTagMatchType::Type > TagMatchType,
TEnumAsByte< EGameplayTagMatchType::Type > TagToCheckMatchType
)

  
Public function bool

ImportTextItem ( const TCHAR*& Buffer,
int32 PortFlags,
UObject* Parent,
FOutputDevice* ErrorText
)

 Handles fixup after importing from text
Public function Const bool

IsEmpty ()

 Returns true if container is empty
Public function Const bool

IsValid ()

 Returns whether the container has any valid tags
Public function Const bool

IsValidIndex ( int32 Index
)

  
Public function Const FGameplayTag

Last ()

  
Public function Const bool

MatchesQuery ( const FGameplayTagQuery& Query
)

 Checks if this container matches the given query.
Public function bool

NetSerialize ( FArchive& Ar,
UPackageMap* Map,
bool& bOutSuccess
)

 Efficient network serialize, takes advantage of the dictionary
Public function Const int32

Num ()

 Returns the number of explicitly added tags
Public function void Fill in the ParentTags array and any other transient parameters
Public function bool

RemoveTag ( const FGameplayTag& TagToRemove,
bool bDeferParentTags
)

 Tag to remove from the container
Protected function bool

RemoveTagByExplicitName ( const FName& TagName
)

 If a Tag with the specified tag name explicitly exists, it will remove that tag and return true.
Public function void

RemoveTags ( const FGameplayTagContainer& TagsToRemove
)

 Removes all tags in TagsToRemove from this container
Public function void

Reset ( int32 Slack
)

 Remove all tags from the container. Will maintain slack by default
Public function bool

Serialize ( FStructuredArchive::FSlot Slot
)

 Serialize the tag container
Public function Const FText

ToMatchingText ( EGameplayContainerMatchType MatchType,
bool bInvertCondition
)

 Returns human readable description of what match is being looked for on the readable tag list.
Public function Const FString Returns string version of container in ImportText format
Public function Const FString

ToStringSimple ( bool bQuoted
)

 Returns abbreviated human readable Tag list without parens or property names.
Public function Const TArray< FString >

ToStringsMaxLen ( int32 MaxLen
)

 Returns abbreviated human readable Tag list without parens or property names, but will limit each string to specified len.

Operators

  Type Name Description
Public function Const bool  
Public function FGameplayTagContainer &

operator= ( FGameplayTagContainer const& Other
)

 Assignment/Equality operators
Public function FGameplayTagContainer &  
Public function Const bool  

Constants

Name Description
EmptyContainer An empty Gameplay Tag Container

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page