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

Light Theme

Dark Theme

ISettingsModule::RegisterSettings

Adds a settings section to the specified settings container (using a settings object).

Windows

MacOS

Linux

References

Module	Settings
Header	/Engine/Source/Developer/Settings/Public/ISettingsModule.h
Include	#include "ISettingsModule.h"

Syntax

TSharedPtr< ISettingsSection > RegisterSettings
(
    const FName & ContainerName,
    const FName & CategoryName,
    const FName & SectionName,
    const FText & DisplayName,
    const FText & Description,
    const TWeakObjectPtr< UObject > & SettingsObject
)

Remarks

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.

Returns

The added settings section, or nullptr if the category does not exist.

Parameters

Parameter	Description
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.

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

Take our survey

Dismiss