Skip to content

Class USFFunctionLibrary

ClassList > USFFunctionLibrary

Utility function library for the SettingsFramework. More...

  • #include "SFFunctionLibrary.h"

Inherits the following classes: UBlueprintFunctionLibrary

Public Static Functions

Type Name
ECommonInputType GetCurrentInputMethod (const UObject * WorldContextObject)
class USFSettingsSubsystem * GetSettingsSubsystem (const UObject * WorldContextObject)

Detailed Description

Utility function library for the SettingsFramework.

Public Static Functions Documentation

function GetCurrentInputMethod

static ECommonInputType USFFunctionLibrary::GetCurrentInputMethod (
    const UObject * WorldContextObject
)

Retrieves the current CommonUI input method (e.g., Gamepad, MouseAndKeyboard).

Parameters:

  • WorldContextObject World context object to get the world from. Can be any object that has a valid world, such as an actor, a component, a widget, etc.

Returns:

The active ECommonInputType. Defaults to MouseAndKeyboard if unable to determine.

function GetSettingsSubsystem

static class USFSettingsSubsystem * USFFunctionLibrary::GetSettingsSubsystem (
    const UObject * WorldContextObject
)

Get the USFSettingsSubsystem instance.

Parameters:

  • WorldContextObject World context object to get the world from. Can be any object that has a valid world, such as an actor, a component, a widget, etc.

Returns:

The USFSettingsSubsystem instance.

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