1. Epic GamesDeveloper
  3. UGameplayTagsSettings

UGameplayTagsSettings

Class for importing GameplayTags directly from a config file.

Unreal Engine C++ API Reference > Runtime > GameplayTags

Inheritance Hierarchy

References

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

Syntax

UCLASS (Config=GameplayTags, defaultconfig, MinimalAPI)  
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

  Type Name Description
Public variable UProperty Category, EditAnywhere Config bool AllowEditorTagUnloading If true, will allow unloading of tags in the editor when plugins are removed
Public variable UProperty Category, EditAnywhere Config bool AllowGameTagUnloading 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
Public variable UProperty Category, EditAnywhere, Meta Config bool bDynamicReplication If true, will replicate gameplay tags dynamically by index per connection.
Public variable UProperty Category, EditAnywhere Config TArray< FGameplayTagCategoryRemap > CategoryRemapping Category remapping.
Public variable UProperty Category, EditAnywhere Transient FString CleanupUnusedTags Find and remove unused tags
Public variable UProperty Config bool ClearInvalidTags  
Public variable UProperty Category, EditAnywhere Config TArray< FName > CommonlyReplicatedTags List of most frequently replicated tags
Public variable UProperty Category, EditAnywhere Config bool FastReplication If true, will replicate gameplay tags by index instead of name.
Public variable UProperty Category, EditAnywhere, Meta Config TArray< FGameplayTagRedirect > GameplayTagRedirects List of active tag redirects
Public variable UProperty Category, EditAnywhere, Meta Config TArray< FSoftObjectPath > GameplayTagTableList List of data tables to load tags from
Public variable UProperty Category, EditAnywhere Config bool ImportTagsFromConfig If true, will import tags from ini files in the config/tags folder
Public variable UProperty Category, EditAnywhere Config FString InvalidTagCharacters These characters cannot be used in gameplay tags, in addition to special ones like newline
Public variable UProperty Category, EditAnywhere Config int32 NetIndexFirstBitSegment The length in bits of the first segment when net serializing tags.
Public variable UProperty Category, EditAnywhere Transient FString NewTagSource Add a new gameplay tag config file for saving plugin or game-specific tags.
Public variable UProperty Category, EditAnywhere Config int32 NumBitsForContainerSize Numbers of bits to use for replicating container size, set this based on how large your containers tend to be
Public variable UProperty Category, EditAnywhere, AdvancedDisplay Config TArray< FRestrictedConfigInfo > RestrictedConfigFiles A list of .ini files used to store restricted gameplay tags.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay Transient FString RestrictedTagList Dummy parameters used to hook the editor UI.
Public variable UProperty Category, EditAnywhere, Meta Config bool WarnOnInvalidTags If true, will give load warnings when reading in saved tag references that are not in the dictionary

Constructors

  Type Name Description
Public function  

UGameplayTagsSettings ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void

PreEditChange ( FProperty* PropertyThatWillChange
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page