1. Epic GamesDeveloper
  3. UGameplayTagsManager

UGameplayTagsManager

Holds data about the tag dictionary, is in a singleton UObject

Unreal Engine C++ API Reference > Runtime > GameplayTags

Inheritance Hierarchy

  • UObject
  • UGameplayTagsManager

References

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

Syntax

UCLASS (Config=Engine, MinimalAPI)  
class UGameplayTagsManager : public UObject

Remarks

Holds data about the tag dictionary, is in a singleton UObject

Variables

  Type Name Description
Public variable int32 NumBitsForContainerSize Numbers of bits to use for replicating container size. This can be set via config.
Public variable FOnFilterGameplayTag OnFilterGameplayTag  
Public variable FOnFilterGameplayTagChildren OnFilterGameplayTagChildren  
Public variable FOnGameplayTagDoubleClickedEditor OnGatherGameplayTagDoubleClickedEditor  
Public variable FOnGetCategoriesMetaFromPropertyHandle OnGetCategoriesMetaFromPropertyHandle  
Public variable TMap< FGameplayTag, int32 > ReplicationCountMap  
Public variable TMap< FGameplayTag, int32 > ReplicationCountMap_Containers  
Public variable TMap< FGameplayTag, int32 > ReplicationCountMap_SingleTags  

Constructors

  Type Name Description
Public function  

UGameplayTagsManager ( const FObjectInitializer& ObjectInitializer
)

  

Destructors

  Type Name Description
Public function   Destructor

Functions

  Type Name Description
Public function FGameplayTag

AddNativeGameplayTag ( FName TagName,
const FString& TagDevComment
)

 Registers the given name as a gameplay tag, and tracks that it is being directly referenced from code This can only be called during engine initialization, the table needs to be locked down before replication
Public function void

AddTagIniSearchPath ( const FString& RootDir
)

 Loads tag inis contained in the specified path
Public function Const FDelegateHandle

CallOrRegister_OnDoneAddingNativeTagsDelegate ( const FSimpleMulticastDelegate::FDelegate& Delegate
)

 Register a callback for when native tags are done being added (this is also a safe point to consider that the gameplay tags have fully been initialized).
Public function void Stops suppressing GameplayTag tree rebuilds and (optionally) rebuilds the tree
Public function void Clears runtime overrides, reverting to bShouldAllowUnloadingTags when determining GameplayTags unload behavior
Public function void Helper function to construct the gameplay tag tree
Public function  

DECLARE_TS_MULTICAST_DELEGATE_OneParam ( FOnGameplayTagLoaded,
const FGameplayTag&
)

  
Public function void Helper function to destroy the gameplay tag tree
Public function void Call to flush the list of native tags, once called it is unsafe to add more
Public function Const void

DumpSources ( FOutputDevice& Out
)

 Implementation of console command GameplayTags.DumpSources
Public function void Refresh the gameplaytag tree due to an editor change
Public function Const bool

ExtractParentTags ( const FGameplayTag& GameplayTag,
TArray< FGameplayTag >& UniqueParentTags
)

 Fills in an array of gameplay tags with all of tags that are the parents of the passed in tag.
Public function Const FGameplayTag

FindGameplayTagFromPartialString_Slow ( FString PartialString
)

 Searches for a gameplay tag given a partial string.
Public function Const FORCEINLINE_DEBUGGABLE TSharedPtr< FGameplayTagNode >

FindTagNode ( FName TagName
)

 Checks node tree to see if a FGameplayTagNode with the name exists
Public function Const FORCEINLINE_DEBUGGABLE TSharedPtr< FGameplayTagNode >

FindTagNode ( const FGameplayTag& GameplayTag
)

 Checks node tree to see if a FGameplayTagNode with the tag exists
Public function FGameplayTagSource *

FindTagSource ( FName TagSourceName
)

 Returns the tag source for a given tag source name and type, or null if not found
Public function Const const FGameplayTagSource *

FindTagSource ( FName TagSourceName
)

 Returns the tag source for a given tag source name and type, or null if not found
Public function Const void

FindTagSourcesWithType ( EGameplayTagSourceType TagSourceType,
TArray< const FGameplayTagSource* >& OutArray
)

 Fills in an array with all tag sources of a specific type
Public function Const void

FindTagsWithSource ( FStringView PackageNameOrPath,
TArray< FGameplayTag >& OutTags
)

  
Public function Const void

GameplayTagContainerLoaded ( FGameplayTagContainer& Container,
FProperty* SerializingProperty
)

 Notification that a tag container has been loaded via serialize
Public function Const int32

GameplayTagsMatchDepth ( const FGameplayTag& GameplayTagOne,
const FGameplayTag& GameplayTagTwo
)

 Check to see how closely two FGameplayTags match.
Public function Static UGameplayTagsManager &

Get ()

 Returns the global UGameplayTagsManager manager
Public function Const void

GetAllTagsFromSource ( FName TagSource,
TArray< TSharedPtr< FGameplayTagNode > >& OutTagArray
)

 Gets a list of all gameplay tag nodes added by the specific source
Public function Static FString

GetCategoriesMetaFromField ( TFieldType* Field
)

 Returns "Categories" meta property from given field, used for filtering by tag widget
Public function Static FString

GetCategoriesMetaFromFunction ( const UFunction* Func,
FName ParamName
)

 Returns "GameplayTagFilter" meta property from given function, used for filtering by tag widget for any parameters of the function that end up as BP pins
Public function Const FString

GetCategoriesMetaFromPropertyHandle ( TSharedPtr< class IPropertyHandle > PropertyHandle
)

 Returns "Categories" meta property from given handle, used for filtering by tag widget
Public function Const void

GetFilteredGameplayRootTags ( const FString& InFilterString,
TArray< TSharedPtr< FGameplayTagNode > >& OutTagArray
)

 Gets a Filtered copy of the GameplayRootTags Array based on the comma delimited filter string passed in
Public function Static UGameplayTagsManager * Returns possibly nullptr to the manager. Needed for some shutdown cases to avoid reallocating.
Public function Const FGameplayTagNetIndex This is the actual value for an invalid tag "None".
Public function Const int32 The length in bits of the first segment when net serializing tags.
Public function Const FGameplayTagNetIndex

GetNetIndexFromTag ( const FGameplayTag& InTag
)

  
Public function Const int32 Cached number of bits we need to replicate tags.
Public function Const const TArray< TSharedPtr< FGameplayTagNode > > &  
Public function Const uint32 Returns the hash of NetworkGameplayTagNodeIndex
Public function Const int32

GetNumberOfTagNodes ( const FGameplayTag& GameplayTag
)

 Returns the number of parents a particular gameplay tag has.
Public function Const int32  
Public function int32 Gets the number of tag source search paths
Public function Const void

GetOwnersForTagSource ( const FString& SourceName,
TArray< FString >& OutOwners
)

 Returns a list of the owners for a restricted tag config file. May be empty
Public function Const void

GetRestrictedTagConfigFiles ( TArray< FString >& RestrictedConfigFiles
)

 Returns a list of the ini files that contain restricted tags
Public function Const void

GetRestrictedTagSources ( TArray< const FGameplayTagSource* >& Sources
)

 Returns a list of the source files that contain restricted tags
Public function Const FORCEINLINE_DEBUGGABLE const FGameplayTagContainer *

GetSingleTagContainer ( const FGameplayTag& GameplayTag
)

  
Public function Const bool

GetTagEditorData ( FName TagName,
FString& OutComment,
TArray< FName >& OutTagSources,
bool& bOutIsTagExplicit,
bool& bOutIsRestrictedTag,
bool& bOutAllowNonRestrictedChildren
)

 Returns information about tag. If not found return false
Public function Const bool

GetTagEditorData ( FName TagName,
FString& OutComment,
FName& OutFirstTagSource,
bool& bOutIsTagExplicit,
bool& bOutIsRestrictedTag,
bool& bOutAllowNonRestrictedChildren
)

 Returns information about tag. If not found return false
Public function Const FName Gets a tag name from net index and vice versa, used for replication efficiency
Public function void

GetTagSourceSearchPaths ( TArray< FString >& OutPaths
)

 Gets all the current directories to look for tag sources in
Public function Const bool

ImportSingleGameplayTag ( FGameplayTag& Tag,
FName ImportedTagName,
bool bImportFromSerialize
)

 Handles establishing a single tag from an imported tag name (accounts for redirects too).
Public function Const bool

IsDictionaryTag ( FName TagName
)

 Returns true if this tag was explicitly registered, this is false for implictly added parent tags
Public function bool

IsValidGameplayTagString ( const FString& TagString,
FText* OutError,
FString* OutFixedString
)

 Returns true if this is a valid gameplay tag string (foo.bar.baz). If false, it will fill
Public function void

LoadGameplayTagTables ( bool bAllowAsyncLoad
)

 Loads the tag tables referenced in the GameplayTagSettings object
Public function void  
Public function void

NotifyTagReplicated ( FGameplayTag Tag,
bool WasInContainer
)

  
Public function Static FSimpleMulticastDelegate & This is a delegate that is called during initialization/initial loading and signals the last chance to add tags before we are considered to be fully loaded (all tags registered).
Public function void  
Public function void Mechanism for tracking what tags are frequently replicated
Public function void  
Public function void  
Public function Const void

RedirectSingleGameplayTag ( FGameplayTag& Tag,
FProperty* SerializingProperty
)

 Handles redirectors for a single tag, will also error on invalid tag.
Public function Const void

RedirectTagsForContainer ( FGameplayTagContainer& Container,
FProperty* SerializingProperty
)

 Handles redirectors for an entire container, will also error on invalid tags
Public function bool

RemoveTagIniSearchPath ( const FString& RootDir
)

 Tries to remove the specified search path, will return true if anything was removed
Public function Const void

RequestAllGameplayTags ( FGameplayTagContainer& TagContainer,
bool OnlyIncludeDictionaryTags
)

 Gets the list of all registered tags, setting OnlyIncludeDictionaryTags will exclude implicitly added tags if possible
Public function Const FGameplayTag

RequestGameplayTag ( FName TagName,
bool ErrorIfNotFound
)

 Gets the FGameplayTag that corresponds to the TagName
Public function Const FGameplayTagContainer

RequestGameplayTagChildren ( const FGameplayTag& GameplayTag
)

 Gets a Tag Container containing the all tags in the hierarchy that are children of this tag.
Public function Const FGameplayTagContainer Gets a Tag Container containing all of the tags in the hierarchy that are children of this tag, and were explicitly added to the dictionary
Public function Const void

RequestGameplayTagContainer ( const TArray< FString >& TagStrings,
FGameplayTagContainer& OutTagsContainer,
bool bErrorIfNotFound
)

 Adds the gameplay tags corresponding to the strings in the array TagStrings to OutTagsContainer
Public function Const FGameplayTagContainer Gets a Tag Container containing all of the tags in the hierarchy that are children of this tag, were explicitly added to the dictionary, and do not have any explicitly added tags between them and the specified tag
Public function Const FGameplayTag Returns direct parent GameplayTag of this GameplayTag, calling on x.y will return x
Public function Const FGameplayTagContainer

RequestGameplayTagParents ( const FGameplayTag& GameplayTag
)

 Gets a Tag Container containing the supplied tag and all of its parents as explicit tags.
Public function void

ResumeEditorRefreshGameplayTagTree ( FGuid SuspendToken
)

 Resumes EditorRefreshGameplayTagTree requests; triggers a refresh if a request was made while it was suspended
Public function void

SetShouldDeferGameplayTagTreeRebuilds ( bool bShouldDeferRebuilds
)

 Pushes an override that suppresses calls to HandleGameplayTagTreeChanged that would result in a complete rebuild of the GameplayTag tree
Public function void

SetShouldUnloadTagsOverride ( bool bShouldUnloadTags
)

 Pushes an override that supersedes bShouldAllowUnloadingTags to allow/disallow unloading of GameplayTags in controlled scenarios
Public function Const bool Should we clear references to invalid tags loaded/saved in the editor
Public function Const bool Returns true if we should import tags from UGameplayTagsSettings objects (configured by INI files)
Public function Const bool If we are allowed to unload tags
Public function Const bool Should use dynamic replication (Gameplay Tags need not match between client/server)
Public function Const bool Should use fast replication
Public function Const bool Should we print loading errors when trying to load invalid tags
Public function bool

ShowGameplayTagAsHyperLinkEditor ( FString TagName
)

  
Public function Const void

SingleGameplayTagLoaded ( FGameplayTag& Tag,
FProperty* SerializingProperty
)

 Notification that a gameplay tag has been loaded via serialize
Public function Const void

SplitGameplayTagFName ( const FGameplayTag& Tag,
TArray< FName >& OutNames
)

 Splits a tag such as x.y.z into an array of names {x,y,z}
Public function Static FString

StaticGetCategoriesMetaFromPropertyHandle ( TSharedPtr< class IPropertyHandle > PropertyHandle
)

 Helper function, made to be called by custom OnGetCategoriesMetaFromPropertyHandle handlers
Public function void

SuspendEditorRefreshGameplayTagTree ( FGuid SuspendToken
)

 Suspends EditorRefreshGameplayTagTree requests
Public function Const bool

ValidateTagCreation ( FName TagName
)

 Returns true if if the passed in name is in the tag dictionary and can be created

Classes

  Type Name Description
Public struct FFilterGameplayTagContext This is a container to filter out gameplay tags when they are invalid or when they don't meet the filter string If used from editor to filter out tags when picking them the FilterString is optional and the ReferencingPropertyHandle is required If used to validate an asset / assets you can provide the TagSourceAssets.  

Typedefs

Name Description
FOnFilterGameplayTag Allows dynamic hiding of gameplay tags in SGameplayTagWidget.
FOnFilterGameplayTagChildren Allows dynamic hiding of gameplay tags in SGameplayTagWidget.
FOnGameplayTagDoubleClickedEditor  
FOnGetCategoriesMetaFromPropertyHandle Chance to dynamically change filter string based on a property handle

Constants

Name Description
NAME_Categories  
NAME_GameplayTagFilter  
OnEditorRefreshGameplayTagTree This is called after EditorRefreshGameplayTagTree.
SingletonManager The Tag Manager singleton

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page