Class USFSettingCategory
ClassList > USFSettingCategory
Defines a Category that can contain either Sub-Categories (Branch) or individual Settings (Leaf). More...
#include "Definitions/SFSettingCategory.h"
Inherits the following classes: UDataAsset
Public Attributes
| Type | Name |
|---|---|
| FGameplayTag | CategoryTag |
| ESFCategoryType | CategoryType = ESFCategoryType::Leaf |
| FText | DisplayName |
| TArray< FSFSettingGroup > | SettingGroups |
| TArray< TObjectPtr< class USFSettingDefinition > > | Settings |
| TArray< TObjectPtr< USFSettingCategory > > | Subcategories |
Detailed Description
Defines a Category that can contain either Sub-Categories (Branch) or individual Settings (Leaf).
Note:
BlueprintType
Public Attributes Documentation
variable CategoryTag
FGameplayTag USFSettingCategory::CategoryTag;
The category's unique identifier.
Note:
EditDefaultsOnly BlueprintReadOnly
variable CategoryType
ESFCategoryType USFSettingCategory::CategoryType;
Is this a Branch category that contains sub-categories, or a Leaf category that contains individual settings?
Note:
EditDefaultsOnly BlueprintReadOnly
variable DisplayName
FText USFSettingCategory::DisplayName;
The player-facing name of this category, displayed on UI.
Note:
EditDefaultsOnly BlueprintReadOnly
variable SettingGroups
TArray<FSFSettingGroup> USFSettingCategory::SettingGroups;
For Leaf category. The collection of setting groups under this category.
Note:
EditDefaultsOnly BlueprintReadOnly
variable Settings
TArray<TObjectPtr<class USFSettingDefinition> > USFSettingCategory::Settings;
For Leaf category. If setting groups are not desired, individual settings can be added directly to the category without grouping.
Note:
EditDefaultsOnly BlueprintReadOnly
variable Subcategories
TArray<TObjectPtr<USFSettingCategory> > USFSettingCategory::Subcategories;
For Branch category. The collection of sub-categories under this category.
Note:
EditDefaultsOnly BlueprintReadOnly
The documentation for this class was generated from the following file Source/SettingsFramework/Public/Definitions/SFSettingCategory.h