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 > UGameplayTagsSettings

Light Theme

Dark Theme

UGameplayTagsSettings

Class for importing GameplayTags directly from a config file.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UGameplayTagsList

UGameplayTagsSettings

References

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

Syntax

class UGameplayTagsSettings : public UGameplayTagsList

Remarks

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).

Variables

	Name	Description
TArray< FGamepl...	CategoryRemapping	Category remapping.
bool	ClearInvalidTags	If true, will clear any invalid tags when reading in saved tag references that are not in the dictionary
TArray< FName >	CommonlyReplicatedTags	List of most frequently replicated tags
bool	FastReplication	If true, will replicate gameplay tags by index instead of name.
TArray< FGamepl...	GameplayTagRedirects	List of active tag redirects
TArray< FSoftOb...	GameplayTagTableList	List of data tables to load tags from
bool	ImportTagsFromConfig	If true, will import tags from ini files in the config/tags folder
FString	InvalidTagCharacters	These characters cannot be used in gameplay tags, in addition to special ones like newline
int32	NetIndexFirstBitSegment	The length in bits of the first segment when net serializing tags.
int32	NumBitsForContainerSize	Numbers of bits to use for replicating container size, set this based on how large your containers tend to be
TArray< FRestri...	RestrictedConfigFiles	A list of .ini files used to store restricted gameplay tags.
FString	RestrictedTagList	Dummy parameter used to hook the editor UI.
bool	WarnOnInvalidTags	If true, will give load warnings when reading in saved tag references that are not in the dictionary

Constructors

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

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
	void	PreEditChange ( FProperty* PropertyAboutToChan... )	This is called when a property is about to be modified externally

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

Take our survey

Dismiss