Class USFSettingOptionSource

ClassList > USFSettingOptionSource

Base class for providing a dynamic runtime list of options for a setting. More...

#include "Definitions/SFSettingOptionSource.h"

Inherits the following classes: UObject

Public Functions

Type	Name
TArray< struct FSFSettingOption >	GetAvailableOptions (const UObject * WorldContextObject) const
virtual TArray< struct FSFSettingOption >	GetAvailableOptions_Implementation (const UObject * WorldContextObject) const
class USFSettingValue *	GetDefaultValue (const UObject * WorldContextObject) const
virtual class USFSettingValue *	GetDefaultValue_Implementation (const UObject * WorldContextObject) const

Detailed Description

Base class for providing a dynamic runtime list of options for a setting.

This class is used in USFSettingDefinition_Discrete when UseDynamicOptions is true.

Note:

Abstract Blueprintable EditInlineNew

Public Functions Documentation

function GetAvailableOptions

TArray< struct FSFSettingOption > USFSettingOptionSource::GetAvailableOptions (
    const UObject * WorldContextObject
) const

Get the list of options to choose from for this setting

Parameters:

WorldContextObject The world context object from which to get the world object.

Returns:

The list of options to choose from for this setting. The value should be of the type specified by the setting definition's ValueWrapperClass.

Note:

BlueprintNativeEvent

function GetAvailableOptions_Implementation

inline virtual TArray< struct FSFSettingOption > USFSettingOptionSource::GetAvailableOptions_Implementation (
    const UObject * WorldContextObject
) const

Native implementation of GetAvailableOptions.

function GetDefaultValue

class USFSettingValue * USFSettingOptionSource::GetDefaultValue (
    const UObject * WorldContextObject
) const

Get the default value for this setting. This is optional to implement, and if not implemented, the setting will use the fallback default value defined in the DefaultValue property of the setting definition.

Parameters:

WorldContextObject The world context object from which to get the world object.

Returns:

The default value for this setting. The value should be of the type specified by the setting definition's ValueWrapperClass.

Note:

BlueprintNativeEvent

function GetDefaultValue_Implementation

inline virtual class USFSettingValue * USFSettingOptionSource::GetDefaultValue_Implementation (
    const UObject * WorldContextObject
) const

Native implementation of GetDefaultValue.

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