UGameplayTagsSettings

Class for importing GameplayTags directly from a config file.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

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

Public variable

TArray< FGamepl...

 

CategoryRemapping

Category remapping.

Public variable

bool

 

ClearInvalidTags

If true, will clear any invalid tags when reading in saved tag references that are not in the dictionary

Public variable

TArray< FName >

 

CommonlyReplicatedTags

List of most frequently replicated tags

Public variable

bool

 

FastReplication

If true, will replicate gameplay tags by index instead of name.

Public variable

TArray< FGamepl...

 

GameplayTagRedirects

List of active tag redirects

Public variable

TArray< FSoftOb...

 

GameplayTagTableList

List of data tables to load tags from

Public variable

bool

 

ImportTagsFromConfig

If true, will import tags from ini files in the config/tags folder

Public variable

FString

 

InvalidTagCharacters

These characters cannot be used in gameplay tags, in addition to special ones like newline

Public variable

int32

 

NetIndexFirstBitSegment

The length in bits of the first segment when net serializing tags.

Public variable

int32

 

NumBitsForContainerSize

Numbers of bits to use for replicating container size, set this based on how large your containers tend to be

Public variable

TArray< FRestri...

 

RestrictedConfigFiles

A list of .ini files used to store restricted gameplay tags.

Public variable

FString

 

RestrictedTagList

Dummy parameter used to hook the editor UI.

Public variable

bool

 

WarnOnInvalidTags

If true, will give load warnings when reading in saved tag references that are not in the dictionary

Constructors

Name Description

Public function

UGameplayTagsSettings

(
    const FObjectInitializer& ObjectIn...
)

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PreEditChange

(
    FProperty* PropertyAboutToChan...
)

This is called when a property is about to be modified externally