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

Light Theme

Dark Theme

ISettingsSection

Interface for setting sections.

Windows

MacOS

Linux

References

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

Syntax

class ISettingsSection

Remarks

Interface for setting sections.

A setting section is a collection of settings that logically belong together (i.e. all settings for the PS4 Platform). Internally, the individual settings are represented as the properties of an UObject. One or more setting sections can the be hierarchically arranged in a setting category.

Destructors

	Name	Description
	~ISettingsSection()	Virtual destructor.

Functions

	Name	Description
bool	CanEdit()	Checks whether this section can be edited right now.
bool	CanExport()	Checks whether this section can export its settings to a file.
bool	CanImport()	Checks whether this section can import its settings from a file.
bool	CanResetDefaults()	Checks whether this section can have its settings reset to default.
bool	CanSave()	Checks whether this section can have its settings saved.
bool	CanSaveDefaults()	Checks whether this section can have its settings saved as default.
bool	Export ( const FString& Filename )	Exports the settings in this section to the specified file.
TWeakPtr< IS...	GetCategory()	Gets the settings category that this section belongs to.
TWeakPtr< SW...	GetCustomWidget()	Gets the custom settings widget for this settings section.
const FText ...	GetDescription()	Gets the section's localized description text.
const FText ...	GetDisplayName()	Gets the section's localized display name.
const FName ...	GetName()	Gets the section's name.
TWeakObjectP...	GetSettingsObject()	Gets the UObject holding the section's settings.
FText	GetStatus()	Gets the section's optional status text.
bool	HasDefaultSettingsObject()	Checks whether this section holds a settings object that saves directly to default configuration files.
bool	Import ( const FString& Filename )	Imports the settings in this section from the specified file.
bool	NotifySectionOnPropertyModified()	Notifies a section that a single property has been modified
FOnCanEdit &	OnCanEdit()
FOnExport &	OnExport()
FOnImport &	OnImport()
FOnModified ...	OnModified()
FOnResetDefa...	OnResetDefaults()
FOnSave &	OnSave()
FOnSaveDefau...	OnSaveDefaults()
FOnSelect &	OnSelect()
FOnStatus &	OnStatus()
bool	ResetDefaults()	Resets the settings in this section to their default value.
bool	Save()	Saves the settings in this section.
bool	SaveDefaults()	Saves the settings in this section as defaults.
void	Select()	Called when the current section is selected.

Typedefs

Name	Description
FOnCanEdit	A delegate that is executed to check whether a settings section can be edited.
FOnExport	A delegate that is executed when a settings section should export its values to a file.
FOnImport	A delegate that is executed when a settings section should import its values from a file.
FOnModified	A delegate that is executed when a settings section has been modified.
FOnResetDefaults	A delegate that is executed when a settings section should have its values reset to default.
FOnSave	A delegate that is executed when a settings section should have its values saved.
FOnSaveDefaults	A delegate that is executed when a settings section should have its values saved as default.
FOnSelect	A delegate that is executed to check whether a settings section can be edited.
FOnStatus	A delegate that is executed to retrieve a status message for a settings section.

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

Take our survey

Dismiss