Navigation
API > API/Developer > API/Developer/Settings
Interface for settings UI modules.
| Name | ISettingsModule |
| Type | class |
| Header File | /Engine/Source/Developer/Settings/Public/ISettingsModule.h |
| Include Path | #include "ISettingsModule.h" |
Syntax
class ISettingsModule : public IModuleInterface
Implements Interfaces
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ISettingsModule() |
Virtual destructor. | ISettingsModule.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnContainerAdded | TMulticastDelegate_OneParam< void, const FName & > | A delegate that is executed when a settings container has been added. | ISettingsModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< ISettingsContainer > GetContainer
(
const FName& ContainerName |
Gets the global settings container with the specified name. | ISettingsModule.h | |
| Gets the names of all known setting containers. | ISettingsModule.h | ||
FOnContainerAdded & OnContainerAdded() |
ISettingsModule.h | ||
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 | |
void RegisterViewer
(
const FName& ContainerName, |
Registers a viewer for the specified settings container. | ISettingsModule.h | |
| Shows the settings viewer for the specified settings container. | ISettingsModule.h | ||
| Removes a settings section from the specified settings container. | ISettingsModule.h | ||
void UnregisterViewer
(
const FName& ContainerName |
Unregisters the currently assigned viewer for the specified settings container. | ISettingsModule.h |