Choose your operating system:
Windows
macOS
Linux
Module |
|
Header |
/Engine/Source/Runtime/GameplayTags/Classes/GameplayTagContainer.h |
Include |
#include "GameplayTagContainer.h" |
struct FGameplayTagContainer
A Tag Container holds a collection of FGameplayTags, tags are included explicitly by adding them, and implicitly from adding child tags
Name | Description | ||
---|---|---|---|
|
GameplayTags |
Array of gameplay tags |
|
|
ParentTags |
Array of expanded parent tags, in addition to GameplayTags. |
Name | Description | |
---|---|---|
|
FGameplayTagContainer() |
Constructors |
|
FGameplayTagContainer ( |
|
|
FGameplayTagContainer ( |
Explicit to prevent people from accidentally using the wrong type of operation |
|
FGameplayTagContainer ( |
Name | Description | |
---|---|---|
|
~FGameplayTagContainer() |
Name | Description | ||
---|---|---|---|
|
AddLeafTag ( |
Adds a tag to the container and removes any direct parents, wont add if child already exists |
|
|
AddParentsForTag ( |
Adds parent tags for a single tag |
|
|
AddTag ( |
Add the specified tag to the container |
|
|
AddTagFast ( |
Add the specified tag to the container without checking for uniqueness |
|
|
AppendMatchingTags ( |
Adds all the tags that match between the two specified containers to this container. |
|
|
AppendTags ( |
Adds all the tags from one container to this container |
|
|
CreateConstIterator() |
Creates a const iterator for the contents of this array |
|
|
FGameplayTag... |
CreateFromArray ( |
Creates a container from an array of tags, this is more efficient than adding them all individually |
|
FillParentTags() |
Fills in ParentTags from GameplayTags |
|
|
FGameplayTag... |
Filter ( |
Returns a filtered version of this container, returns all tags that match against any of the tags in OtherContainer, expanding parents |
|
FGameplayTag... |
FilterExact ( |
Returns a filtered version of this container, returns all tags that match exactly one in OtherContainer |
|
First() |
||
|
FromExportString |
Sets from a ImportText string, used in asset registry |
|
|
GetByIndex ( |
||
|
GetGameplayTagArray ( |
Gets the explicit list of gameplay tags |
|
|
FGameplayTag... |
GetGameplayTagParents() |
Returns a new container explicitly containing the tags of this container and all of their parent tags |
|
HasAll ( |
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 |
|
|
HasAllExact ( |
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 |
|
|
HasAny ( |
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 |
|
|
HasAnyExact ( |
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 |
|
|
HasTag ( |
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 |
|
|
HasTagExact ( |
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 |
|
|
ImportTextItem ( |
Handles fixup after importing from text |
|
|
IsEmpty() |
Returns true if container is empty |
|
|
IsValid() |
Returns whether the container has any valid tags |
|
|
IsValidIndex ( |
||
|
Last() |
||
|
MatchesQuery ( |
Checks if this container matches the given query. |
|
|
NetSerialize ( |
Efficient network serialize, takes advantage of the dictionary |
|
|
Num() |
Returns the number of explicitly added tags |
|
|
PostScriptConstruct() |
Fill in the ParentTags array and any other transient parameters |
|
|
RemoveTag ( |
Tag to remove from the container |
|
|
RemoveTagByExplicitName ( |
If a Tag with the specified tag name explicitly exists, it will remove that tag and return true. |
|
|
RemoveTags ( |
Removes all tags in TagsToRemove from this container |
|
|
Reset ( |
Remove all tags from the container. Will maintain slack by default |
|
|
Serialize ( |
Serialize the tag container |
|
|
ToMatchingText ( |
Returns human readable description of what match is being looked for on the readable tag list. |
|
|
ToString() |
Returns string version of container in ImportText format |
|
|
ToStringSimple ( |
Returns abbreviated human readable Tag list without parens or property names. |
|
|
ToStringsMaxLen ( |
Returns abbreviated human readable Tag list without parens or property names, but will limit each string to specified len. |
Name | Description | ||
---|---|---|---|
|
operator!= ( |
||
|
FGameplayTag... |
operator= ( |
Assignment/Equality operators |
|
FGameplayTag... |
operator= ( |
|
|
operator== ( |
Name |
Description |
---|---|
EmptyContainer |
An empty Gameplay Tag Container |
Name | Description | ||
---|---|---|---|
|
ComplexHasTag ( |
Deprecated in favor of HasTag or HasTagExact |
|
|
DoesTagContainerMatch ( |
Deprecated in favor of HasAll and related functions |
|
|
HasTagFast ( |
Deprecated in favor of HasTag or HasTagExact |