UGameplayTagsSettings | Unreal Engine 5.7 Documentation

API > API/Runtime > API/Runtime/GameplayTags

Class for importing GameplayTags directly from a config file. FGameplayTagsEditorModule::StartupModule adds this class to the Project Settings menu to be edited. Editing this in Project Settings will output changes to Config/DefaultGameplayTags.ini.

Primary advantages of this approach are: -Adding new tags doesn't require checking out external and editing file (CSV or xls) then reimporting. -New tags are mergeable since .ini are text and non exclusive checkout.

To do: -Better support could be added for adding new tags. We could match existing tags and autocomplete subtags as the user types (e.g, autocomplete 'Damage.Physical' as the user is adding a 'Damage.Physical.Slash' tag).


Name	UGameplayTagsSettings
Type	class
Header File	/Engine/Source/Runtime/GameplayTags/Classes/GameplayTagsSettings.h
Include Path	#include "GameplayTagsSettings.h"

Syntax

UCLASS (Config=GameplayTags, defaultconfig, MinimalAPI)  
class UGameplayTagsSettings : public UGameplayTagsList

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UGameplayTagsList → UGameplayTagsSettings

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UGameplayTagsSettings ( const FObjectInitializer& ObjectInitializer )		GameplayTagsSettings.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
AllowEditorTagUnloading	bool	If true, will allow unloading of tags in the editor when plugins are removed	GameplayTagsSettings.h	Config EditAnywhere Category="Advanced Gameplay Tags"
AllowGameTagUnloading	bool	If true, will allow unloading of tags in a non-editor gebuild when plugins are removed, this is potentially unsafe and affects requests to unload during play in editor	GameplayTagsSettings.h	Config EditAnywhere Category="Advanced Gameplay Tags"
bDynamicReplication	bool	If true, will replicate gameplay tags dynamically by index per connection.	GameplayTagsSettings.h	Config EditAnywhere Category="Advanced Replication" Meta=(EditCondition="!FastReplication")
CategoryRemapping	TArray< FGameplayTagCategoryRemap >	Category remapping.	GameplayTagsSettings.h	Config EditAnywhere Category=GameplayTags
CleanupUnusedTags	FString	Find and remove unused tags	GameplayTagsSettings.h	EditAnywhere Transient Category="GameplayTags"
ClearInvalidTags	bool		GameplayTagsSettings.h	Config
CommonlyReplicatedTags	TArray< FName >	List of most frequently replicated tags	GameplayTagsSettings.h	Config EditAnywhere Category="Advanced Replication"
FastReplication	bool	If true, will replicate gameplay tags by index instead of name.	GameplayTagsSettings.h	Config EditAnywhere Category="Advanced Replication"
GameplayTagTableList	TArray< FSoftObjectPath >	List of data tables to load tags from	GameplayTagsSettings.h	Config EditAnywhere Category=GameplayTags Meta=(AllowedClasses="/Script/Engine.DataTable")
ImportTagsFromConfig	bool	If true, will import tags from ini files in the config/tags folder	GameplayTagsSettings.h	Config EditAnywhere Category=GameplayTags
InvalidTagCharacters	FString	These characters cannot be used in gameplay tags, in addition to special ones like newline	GameplayTagsSettings.h	Config EditAnywhere Category=GameplayTags
NetIndexFirstBitSegment	int32	The length in bits of the first segment when net serializing tags.	GameplayTagsSettings.h	Config EditAnywhere Category="Advanced Replication"
NewTagSource	FString	Add a new gameplay tag config file for saving plugin or game-specific tags.	GameplayTagsSettings.h	EditAnywhere Transient Category="GameplayTags"
NumBitsForContainerSize	int32	Numbers of bits to use for replicating container size, set this based on how large your containers tend to be	GameplayTagsSettings.h	Config EditAnywhere Category="Advanced Replication"
RestrictedConfigFiles	TArray< FRestrictedConfigInfo >	A list of .ini files used to store restricted gameplay tags.	GameplayTagsSettings.h	Config EditAnywhere AdvancedDisplay Category="Advanced Gameplay Tags"
RestrictedTagList	FString	Dummy parameters used to hook the editor UI.	GameplayTagsSettings.h	EditAnywhere AdvancedDisplay Transient Category="Advanced Gameplay Tags"
WarnOnInvalidTags	bool	If true, will give load warnings when reading in saved tag references that are not in the dictionary	GameplayTagsSettings.h	Config EditAnywhere Category=GameplayTags Meta=(ConfigRestartRequired=true)

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
RestrictedConfigFilesTempCopy	TArray< FRestrictedConfigInfo >	Temporary copy of RestrictedConfigFiles that we use to identify changes in the list this is required to autopopulate the owners field	GameplayTagsSettings.h

Functions

Public

Overridden from UObject

Name	Remarks	Include Path	Unreal Specifiers
virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent )		GameplayTagsSettings.h
virtual void PreEditChange ( FProperty* PropertyThatWillChange )		GameplayTagsSettings.h

Navigation

Syntax

Inheritance Hierarchy

Constructors

Variables

Public

Protected

Functions

Public

Overridden from UObject