Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Developer > Settings > ISettingsModule

Light Theme

Dark Theme

ISettingsModule

Interface for settings UI modules.

Windows

MacOS

Linux

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

	Name	Description
	~ISettingsModule()	Virtual destructor.

Functions

	Name	Description
TSharedPtr< ...	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< ...	RegisterSettings ( const FName& ContainerName, const FName& CategoryName, const FName& SectionName, const FText& DisplayName, const FText& Description, const TWeakObjectPtr< UObject >& S... )	Adds a settings section to the specified settings container (using a settings object).
TSharedPtr< ...	RegisterSettings ( const FName& ContainerName, const FName& CategoryName, const FName& SectionName, const FText& DisplayName, const FText& Description, const TSharedRef< SWidget >& Custo... )	Adds a settings section to the specified settings container (using a custom settings widget).
void	RegisterViewer ( const FName& ContainerName, ISettingsViewer& SettingsViewer )	Registers a viewer for the specified settings container.
void	ShowViewer ( const FName& ContainerName, const FName& CategoryName, const FName& SectionName )	Shows the settings viewer for the specified settings container.
void	UnregisterSettings ( const FName& ContainerName, const FName& CategoryName, const FName& SectionName )	Removes a settings section from the specified settings container.
void	UnregisterViewer ( const FName& ContainerName )	Unregisters the currently assigned viewer for the specified settings container.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss