Navigation
API > API/Developer > API/Developer/Settings > API/Developer/Settings/ISettingsModule
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< ISettingsSection > RegisterSettings
(
const FName& ContainerName, |
Adds a settings section to the specified settings container (using a settings object). | ISettingsModule.h | |
TSharedPtr< ISettingsSection > RegisterSettings
(
const FName& ContainerName, |
Adds a settings section to the specified settings container (using a custom settings widget). | ISettingsModule.h |
RegisterSettings(const FName &, const FName &, const FName &, const FText &, const FText &, const TWeakObjectPtr< UObject > &)
Description
Adds a settings section to the specified settings container (using a settings object).
If a section with the specified settings objects already exists, the existing section will be replaced.
| Name | RegisterSettings |
| Type | function |
| Header File | /Engine/Source/Developer/Settings/Public/ISettingsModule.h |
| Include Path | #include "ISettingsModule.h" |
TSharedPtr < ISettingsSection > RegisterSettings
(
const FName & ContainerName,
const FName & CategoryName,
const FName & SectionName,
const FText & DisplayName,
const FText & Description,
const TWeakObjectPtr < UObject > & SettingsObject
)
The added settings section, or nullptr if the category does not exist.
Parameters
| Name | Remarks |
|---|---|
| ContainerName | The name of the container that will contain the settings. |
| CategoryName | The name of the category within the container. |
| SectionName | The name of the section within the category. |
| DisplayName | The section's localized display name. |
| Description | The section's localized description text. |
| SettingsObject | The object that holds the section's settings. |
RegisterSettings(const FName &, const FName &, const FName &, const FText &, const FText &, const TSharedRef< SWidget > &)
Description
Adds a settings section to the specified settings container (using a custom settings widget).
If a section with the specified settings objects already exists, the existing section will be replaced.
| Name | RegisterSettings |
| Type | function |
| Header File | /Engine/Source/Developer/Settings/Public/ISettingsModule.h |
| Include Path | #include "ISettingsModule.h" |
TSharedPtr < ISettingsSection > RegisterSettings
(
const FName & ContainerName,
const FName & CategoryName,
const FName & SectionName,
const FText & DisplayName,
const FText & Description,
const TSharedRef < SWidget > & CustomWidget
)
The added settings section, or nullptr if the category does not exist.
Parameters
| Name | Remarks |
|---|---|
| ContainerName | The name of the container that will contain the settings. |
| CategoryName | The name of the category within the container. |
| SectionName | The name of the section within the category. |
| DisplayName | The section's localized display name. |
| Description | The section's localized description text. |
| CustomWidget | A custom settings widget. |