Class USFSettingsScreen

ClassList > USFSettingsScreen

The native base class for the outer-most widget of the settings screen UI. A widget blueprint subclass of this is to be added to a project's CommonUI widget stack. More...

#include "UI/SFSettingsScreen.h"

Inherits the following classes: UCommonActivatableWidget

Protected Attributes

Type	Name
TObjectPtr< class UCommonTabListWidgetBase >	CategoryTabList
TObjectPtr< class UInputAction >	ResetToDefaultAction
TObjectPtr< class UInputAction >	RevertAction
TObjectPtr< class UInputAction >	SaveAction
TObjectPtr< class USFSettingInfoDisplay >	SettingInfoDisplay
TObjectPtr< class UCommonActivatableWidgetSwitcher >	TabContentSwitcher

Protected Functions

Type	Name
void	InitializeSettingsScreen ()
void	ResetSettingsToDefault ()
void	RevertSettings ()
void	SaveSettings ()

Detailed Description

On initialization, this widget queries the USFSettingsSubsystem instance for setting categories and definitions, constructs and populates itself with the appropriate tabs and setting widgets.

The skeletal settings screen UI in Settings Framework only allows for one level of category nesting, meaning only root categories are allowed to be branch-type categories (containing sub-categories). Any branch-type categories under that level are ignored when constructing the UI.

This widget also requests the USFSettingsSubsystem instance to perform actions such as saving, reverting, or resetting settings when initiated by the player from the UI.

Note:

Abstract BlueprintType Blueprintable

Protected Attributes Documentation

variable CategoryTabList

TObjectPtr<class UCommonTabListWidgetBase> USFSettingsScreen::CategoryTabList;

The Common Tab List widget containing tab buttons representing the root setting categories.

Note:

BlueprintReadOnly BindWidget

variable ResetToDefaultAction

TObjectPtr<class UInputAction> USFSettingsScreen::ResetToDefaultAction;

The optional EnhancedInput action to automatically call ResetSettingsToDefault. Requires Enhanced Input support to be enabled in Common Input settings.

Note:

EditDefaultsOnly BlueprintReadOnly

variable RevertAction

TObjectPtr<class UInputAction> USFSettingsScreen::RevertAction;

The optional EnhancedInput action to automatically call RevertSettings. Requires Enhanced Input support to be enabled in Common Input settings.

Note:

EditDefaultsOnly BlueprintReadOnly

variable SaveAction

TObjectPtr<class UInputAction> USFSettingsScreen::SaveAction;

The optional EnhancedInput action to automatically call SaveSettings. Requires Enhanced Input support to be enabled in Common Input settings.

Note:

EditDefaultsOnly BlueprintReadOnly

variable SettingInfoDisplay

TObjectPtr<class USFSettingInfoDisplay> USFSettingsScreen::SettingInfoDisplay;

The widget displaying detailed information about the currently focused setting, such as its display name, description, etc.

Note:

BlueprintReadOnly BindWidget

variable TabContentSwitcher

TObjectPtr<class UCommonActivatableWidgetSwitcher> USFSettingsScreen::TabContentSwitcher;

The Common Activatable Widget Switcher containing the content for each root setting category, switched by the CategoryTabList.

Note:

BlueprintReadOnly BindWidget

Protected Functions Documentation

function InitializeSettingsScreen

void USFSettingsScreen::InitializeSettingsScreen ()

Initializes the settings screen by querying the USFSettingsSubsystem for setting categories and definitions, constructing and populating tabs and setting widgets, and binding to subsystem events. Called on widget activation to allow for lazy loading.

function ResetSettingsToDefault

void USFSettingsScreen::ResetSettingsToDefault ()

Requests the USFSettingsSubsystem to reset all setting values to their default values. Can be called manually or bound to ResetToDefaultAction.

Note:

BlueprintPure

function RevertSettings

void USFSettingsScreen::RevertSettings ()

Requests the USFSettingsSubsystem to revert all setting values to their saved values. Can be called manually or bound to RevertAction.

Note:

BlueprintPure

function SaveSettings

void USFSettingsScreen::SaveSettings ()

Requests the USFSettingsSubsystem to save all setting values. Can be called manually or bound to SaveAction.

Note:

BlueprintPure

The documentation for this class was generated from the following file Source/SettingsFramework/Public/UI/SFSettingsScreen.h