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 > ISettingsContainer

Light Theme

Dark Theme

ISettingsContainer

Interface for setting containers.

Windows

MacOS

Linux

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

	Name	Description
	~ISettingsContainer()	Virtual destructor.

Functions

	Name	Description
void	Describe ( const FText& InDisplayName, const FText& InDescription, const FName& InIconName )	Updates the details of this settings container.
void	DescribeCategory ( const FName& CategoryName, const FText& DisplayName, const FText& Description )	Updates the details of the specified settings category.
int32	GetCategories ( TArray< TSharedPtr< ISettingsCatego... )	Gets the setting categories.
TSharedPtr< ...	GetCategory ( const FName& CategoryName )	Gets the category with the specified name.
const FText ...	GetDescription()	Gets the container's localized description text.
const FText ...	GetDisplayName()	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.
FOnCategoryM...	OnCategoryModified()
FOnSectionRe...	OnSectionRemoved()

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.

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

Take our survey

Dismiss