Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > GameplayTags > UGameplayTagsManager

Light Theme

Dark Theme

UGameplayTagsManager

Holds data about the tag dictionary, is in a singleton [UObject](API\Runtime\CoreUObject\UObject\UObject)

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UGameplayTagsManager

References

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

Syntax

class UGameplayTagsManager : public UObject

Remarks

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

Variables

	Name	Description
FGameplayTagNet...	InvalidTagNetIndex	This is the actual value for an invalid tag "None".
int32	NetIndexFirstBitSegment	The length in bits of the first segment when net serializing tags.
int32	NetIndexTrueBitNum	Cached number of bits we need to replicate tags.
int32	NumBitsForContainerSize	Numbers of bits to use for replicating container size. This can be set via config.
FOnFilterGamepl...	OnFilterGameplayTagChildren
FOnGameplayTagL...	OnGameplayTagLoadedDelegate
FOnGameplayTagD...	OnGatherGameplayTagDoubleClickedEditor
FOnGetCategorie...	OnGetCategoriesMetaFromPropertyHandle
TMap< FGameplay...	ReplicationCountMap
TMap< FGameplay...	ReplicationCountMap_Containers
TMap< FGameplay...	ReplicationCountMap_SingleTags

Constructors

	Name	Description
	UGameplayTagsManager ( const FObjectInitializer& ObjectIn... )

Destructors

	Name	Description
	~UGameplayTagsManager()	Destructor

Functions

	Name	Description
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
void	AddTagIniSearchPath ( const FString& RootDir )	Loads tag inis contained in the specified path
void	CallOrRegister_OnDoneAddingNativeTagsDelegate ( FSimpleMulticastDelegate::FDelegate... )
void	ConstructGameplayTagTree()	Helper function to construct the gameplay tag tree
void	DestroyGameplayTagTree()	Helper function to destroy the gameplay tag tree
void	DoneAddingNativeTags()	Call to flush the list of native tags, once called it is unsafe to add more
void	EditorRefreshGameplayTagTree()	Refresh the gameplaytag tree due to an editor change
FGameplayTag	FindGameplayTagFromPartialString_Slow ( FString PartialString )	Searches for a gameplay tag given a partial string.
TSharedPtr< ...	FindTagNode ( FName TagName )	Checks node tree to see if a FGameplayTagNode with the name exists
TSharedPtr< ...	FindTagNode ( const FGameplayTag& GameplayTag )	Checks node tree to see if a FGameplayTagNode with the tag exists
const FGamep...	FindTagSource ( FName TagSourceName )	Returns the tag source for a given tag source name and type, or null if not found
FGameplayTag...	FindTagSource ( FName TagSourceName )	Returns the tag source for a given tag source name and type, or null if not found
void	FindTagSourcesWithType ( EGameplayTagSourceType TagSourceTyp..., TArray< const FGameplayTagSource&#... )	Fills in an array with all tag sources of a specific type
void	GameplayTagContainerLoaded ( FGameplayTagContainer& Container, FProperty* SerializingProperty )	Notification that a tag container has been loaded via serialize
int32	GameplayTagsMatchDepth ( const FGameplayTag& GameplayTagOne, const FGameplayTag& GameplayTagTwo )	Check to see how closely two FGameplayTags match.
UGameplayTag...	Get()	Returns the global UGameplayTagsManager manager
void	GetAllTagsFromSource ( FName TagSource, TArray< TSharedPtr< FGameplayTagNod... )	Gets a list of all gameplay tag nodes added by the specific source
FString	GetCategoriesMetaFromField ( TFieldType* Field )	Returns "Categories" meta property from given field, used for filtering by tag widget
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
FString	GetCategoriesMetaFromPropertyHandle ( TSharedPtr< class IPropertyHandle >... )	Returns "Categories" meta property from given handle, used for filtering by tag widget
void	GetFilteredGameplayRootTags ( const FString& InFilterString, TArray< TSharedPtr< FGameplayTagNod... )	Gets a Filtered copy of the GameplayRootTags Array based on the comma delimited filter string passed in
UGameplayTag...	GetIfAllocated()	Returns possibly nullptr to the manager. Needed for some shutdown cases to avoid reallocating.
FGameplayTag...	GetNetIndexFromTag ( const FGameplayTag& InTag )
const TArray...	GetNetworkGameplayTagNodeIndex()
uint32	GetNetworkGameplayTagNodeIndexHash()	Returns the hash of NetworkGameplayTagNodeIndex
void	GetOwnersForTagSource ( const FString& SourceName, TArray< FString >& OutOwners )	Returns a list of the owners for a restricted tag config file. May be empty
void	GetRestrictedTagConfigFiles ( TArray< FString >& RestrictedConfi... )	Returns a list of the ini files that contain restricted tags
void	GetRestrictedTagSources ( TArray< const FGameplayTagSource&#... )	Returns a list of the source files that contain restricted tags
const FGamep...	GetSingleTagContainer ( const FGameplayTag& GameplayTag )	Helper function to get the stored TagContainer containing only this tag, which has searchable ParentTags
bool	GetTagEditorData ( FName TagName, FString& OutComment, FName& OutTagSource, bool& bOutIsTagExplicit, bool& bOutIsRestrictedTag, bool& bOutAllowNonRestrictedChildr... )	Returns information about tag. If not found return false
FName	GetTagNameFromNetIndex ( FGameplayTagNetIndex Index )	Gets a tag name from net index and vice versa, used for replication efficiency
bool	ImportSingleGameplayTag ( FGameplayTag& Tag, FName ImportedTagName )	Handles establishing a single tag from an imported tag name (accounts for redirects too).
bool	IsDictionaryTag ( FName TagName )	Returns true if this tag is directly in the dictionary already
bool	IsNativelyAddedTag ( FGameplayTag Tag )
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
void	LoadGameplayTagTables ( bool bAllowAsyncLoad )	Loads the tag tables referenced in the GameplayTagSettings object
void	NotifyGameplayTagDoubleClickedEditor ( FString TagName )
void	NotifyTagReplicated ( FGameplayTag Tag, bool WasInContainer )
FSimpleMulti...	OnLastChanceToAddNativeTags()
void	PrintReplicationFrequencyReport()	Mechanism for tracking what tags are frequently replicated
void	PrintReplicationIndices()
void	RedirectSingleGameplayTag ( FGameplayTag& Tag, FProperty* SerializingProperty )	Handles redirectors for a single tag, will also error on invalid tag.
void	RedirectTagsForContainer ( FGameplayTagContainer& Container, FProperty* SerializingProperty )	Handles redirectors for an entire container, will also error on invalid tags
void	RequestAllGameplayTags ( FGameplayTagContainer& TagContaine..., bool OnlyIncludeDictionaryTags )	Gets the list of all tags in the dictionary
FGameplayTag	RequestGameplayTag ( FName TagName, bool ErrorIfNotFound )	Gets the FGameplayTag that corresponds to the TagName
FGameplayTag...	RequestGameplayTagChildren ( const FGameplayTag& GameplayTag )	Gets a Tag Container containing the all tags in the hierarchy that are children of this tag.
FGameplayTag...	RequestGameplayTagChildrenInDictionary ( const FGameplayTag& GameplayTag )	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
void	RequestGameplayTagContainer ( const TArray< FString >& TagString..., FGameplayTagContainer& OutTagsCont..., bool bErrorIfNotFound )	Adds the gameplay tags corresponding to the strings in the array TagStrings to OutTagsContainer
FGameplayTag...	RequestGameplayTagDirectDescendantsInDictionary ( const FGameplayTag& GameplayTag, EGameplayTagSelectionType Selection... )	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
FGameplayTag	RequestGameplayTagDirectParent ( const FGameplayTag& GameplayTag )	Returns direct parent GameplayTag of this GameplayTag, calling on x.y will return x
FGameplayTag...	RequestGameplayTagParents ( const FGameplayTag& GameplayTag )	Gets a Tag Container containing the supplied tag and all of it's parents as explicit tags
bool	ShouldImportTagsFromINI()	Returns true if we should import tags from UGameplayTagsSettings objects (configured by INI files)
bool	ShouldUseFastReplication()	Should use fast replication
bool	ShouldWarnOnInvalidTags()	Should we print loading errors when trying to load invalid tags
bool	ShowGameplayTagAsHyperLinkEditor ( FString TagName )
void	SingleGameplayTagLoaded ( FGameplayTag& Tag, FProperty* SerializingProperty )	Notification that a gameplay tag has been loaded via serialize
void	SplitGameplayTagFName ( const FGameplayTag& Tag, TArray< FName >& OutNames )	Splits a tag such as x.y.z into an array of names {x,y,z}
FString	StaticGetCategoriesMetaFromPropertyHandle ( TSharedPtr< class IPropertyHandle >... )	Helper function, made to be called by custom OnGetCategoriesMetaFromPropertyHandle handlers
bool	ValidateTagCreation ( FName TagName )	Returns true if if the passed in name is in the tag dictionary and can be created

Typedefs

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

Constants

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

Deprecated Functions

		Name	Description
	bool	GameplayTagsMatch ( const FGameplayTag& GameplayTagOne, TEnumAsByte< EGameplayTagMatchType:..., const FGameplayTag& GameplayTagTwo, TEnumAsByte< EGameplayTagMatchType:... )	Call MatchesTag on FGameplayTag instead
	FString	GetCategoriesMetaFromStruct ( UScriptStruct* Struct )	Please call GetCategoriesMetaFromField instead.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss