Class USFSettingsDeveloperSettings

ClassList > USFSettingsDeveloperSettings

Developer settings to define project-wide configurations for the Settings Framework plugin. More...

• #include "SFSettingsDeveloperSettings.h"

Inherits the following classes: UDeveloperSettings

Public Attributes

Type	Name
TSubclassOf< class USFCategoryTabButtonBase >	BranchTabButtonClass
TSubclassOf< class USFCategoryTab_Branch >	BranchTabContentClass
ESFKeybindCollisionResolution	DefaultKeybindCollisionResolution = ESFKeybindCollisionResolution::Overwrite
TSubclassOf< class USFCategoryTab_Leaf >	LeafTabContentClass
int32	MaxUpdateDepth = 10
TSubclassOf< class USFCategoryTabButtonBase >	RootTabButtonClass
FString	SaveGameSlotName = TEXT("SF\_SaveSlot")
TMap< TSubclassOf< class USFSettingDefinition >, TSubclassOf< class USFSettingEntryWidget > >	SettingEntryWidgetClasses
TSubclassOf< class USFSettingGroupWidget >	SettingGroupWidgetClass
TSoftObjectPtr< class USFSettingsRegistry >	SettingsRegistry

Public Functions

Type	Name
virtual FName	GetCategoryName () override const

Detailed Description

Developer settings to define project-wide configurations for the Settings Framework plugin. Accessed through Project Settings > Plugins > Settings Framework in the Unreal Editor.

Note:

Config=Game

Public Attributes Documentation

variable BranchTabButtonClass

TSubclassOf<class USFCategoryTabButtonBase> USFSettingsDeveloperSettings::BranchTabButtonClass;

The widget class for the Settings Screen UI's branch category tab buttons.

Note:

Config EditAnywhere

---

variable BranchTabContentClass

TSubclassOf<class USFCategoryTab_Branch> USFSettingsDeveloperSettings::BranchTabContentClass;

The widget class for displaying the content of a Branch category (containing sub-categories) in the Settings Screen UI.

Note:

Config EditAnywhere

---

variable DefaultKeybindCollisionResolution

ESFKeybindCollisionResolution USFSettingsDeveloperSettings::DefaultKeybindCollisionResolution;

The default keybind collision resolution policy when adding a new keybind that conflicts with an existing one.

Note:

Config EditAnywhere

---

variable LeafTabContentClass

TSubclassOf<class USFCategoryTab_Leaf> USFSettingsDeveloperSettings::LeafTabContentClass;

The widget class for displaying the content of a Leaf category (containing setting groups and setting entries) in the Settings Screen UI.

Note:

Config EditAnywhere

---

variable MaxUpdateDepth

int32 USFSettingsDeveloperSettings::MaxUpdateDepth;

The recursion guard for conditional dependencies: Maximum depth for updating setting dependencies to prevent infinite loops. If the depth is exceeded, a warning will be logged and the update will be halted.

Note:

Config EditAnywhere

---

variable RootTabButtonClass

TSubclassOf<class USFCategoryTabButtonBase> USFSettingsDeveloperSettings::RootTabButtonClass;

The widget class for the Settings Screen UI's root category tab buttons.

Note:

Config EditAnywhere

---

variable SaveGameSlotName

FString USFSettingsDeveloperSettings::SaveGameSlotName;

Save slot name for saving and loading setting values to and from disk.

Note:

Config EditAnywhere

---

variable SettingEntryWidgetClasses

TMap<TSubclassOf<class USFSettingDefinition>, TSubclassOf<class USFSettingEntryWidget> > USFSettingsDeveloperSettings::SettingEntryWidgetClasses;

The mapping of widget classes to display each variation of setting definition (e.g. a slider widget for a scalar setting) in the Settings Screen UI. *

Note:

Config EditAnywhere

---

variable SettingGroupWidgetClass

TSubclassOf<class USFSettingGroupWidget> USFSettingsDeveloperSettings::SettingGroupWidgetClass;

The widget class for displaying a setting group in the Settings Screen UI.

Note:

Config EditAnywhere

---

variable SettingsRegistry

TSoftObjectPtr<class USFSettingsRegistry> USFSettingsDeveloperSettings::SettingsRegistry;

The master registry asset containing setting hierarchy and definitions. Loaded asynchronously on USFSettingsSubsystem initialization.

Note:

Config EditAnywhere

---

Public Functions Documentation

function GetCategoryName

inline virtual FName USFSettingsDeveloperSettings::GetCategoryName () override const

---

---

The documentation for this class was generated from the following file Source/SettingsFramework/Public/SFSettingsDeveloperSettings.h