Navigation
API > API/Developer > API/Developer/Settings
References
| Module | Settings |
| Header | /Engine/Source/Developer/Settings/Public/ISettingsContainer.h |
| Include | #include "ISettingsContainer.h" |
Syntax
class ISettingsContainer
Remarks
Interface for setting containers.
A settings container is a collection of setting categories. Each category holds a collection of setting sections, which contain the actual settings in the form of UObject properties.
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Virtual destructor. |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | Updates the details of this settings container. | |
 |
void | DescribeCategory
(
const FName& CategoryName, |
Updates the details of the specified settings category. |
  |
int32 | GetCategories
(
TArray< TSharedPtr< ISettingsCategory > >& OutCategories |
Gets the setting categories. |
  |
TSharedPtr< ISettingsCategory > | GetCategory
(
const FName& CategoryName |
Gets the category with the specified name. |
  |
const FText & | Gets the container's localized description text. | |
  |
const FText & | Gets the container's localized display name. | |
  |
const FName & | GetIconName () |
Gets the name of the container's icon. |
  |
const FName & | GetName () |
Gets the container's name. |
 |
FOnCategoryModified & | ||
 |
FOnSectionRemoved & | ||
 |
void | ResetCategorySortPriority
(
FName CategoryName |
Resets the sort priority of a category to its default value Sort priority |
 |
void | SetCategorySortPriority
(
FName CategoryName, |
Sets the sort priority of a category A lower priority value means the category is listed first The priority value is 0 by default |
Typedefs
| Name | Description |
|---|---|
| FOnCategoryModified | A delegate that is executed when a settings category has been added or modified. |
| FOnSectionRemoved | A delegate that is executed when a settings section has been removed. |