Navigation
API > API/Developer > API/Developer/Settings
Inheritance Hierarchy
- IModuleInterface
- ISettingsModule
References
| Module | Settings |
| Header | /Engine/Source/Developer/Settings/Public/ISettingsModule.h |
| Include | #include "ISettingsModule.h" |
Syntax
class ISettingsModule : public IModuleInterface
Remarks
Interface for settings UI modules.
Destructors
| Type | Name | Description | |
|---|---|---|---|
| Virtual destructor. |
Functions
| Type | Name | Description | |
|---|---|---|---|
| TSharedPtr< ISettingsContainer > | GetContainer
(
const FName& ContainerName |
Gets the global settings container with the specified name. | |
| void | GetContainerNames
(
TArray< FName >& OutNames |
Gets the names of all known setting containers. | |
| TSharedPtr< ISettingsSection > | RegisterSettings
(
const FName& ContainerName, |
Adds a settings section to the specified settings container (using a settings object). | |
| TSharedPtr< ISettingsSection > | RegisterSettings
(
const FName& ContainerName, |
Adds a settings section to the specified settings container (using a custom settings widget). | |
| void | RegisterViewer
(
const FName& ContainerName, |
Registers a viewer for the specified settings container. | |
| void | ShowViewer
(
const FName& ContainerName, |
Shows the settings viewer for the specified settings container. | |
| void | UnregisterSettings
(
const FName& ContainerName, |
Removes a settings section from the specified settings container. | |
| void | UnregisterViewer
(
const FName& ContainerName |
Unregisters the currently assigned viewer for the specified settings container. |