Skip to content

Class USFSettingDefinition_Discrete

ClassList > USFSettingDefinition_Discrete

Setting definition for setting an option among a list. More...

  • #include "Definitions/SFSettingDefinition.h"

Inherits the following classes: USFSettingDefinition

Public Attributes

Type Name
FGameplayTagContainer DeterminantSettingTags
TSubclassOf< class USFSettingOptionSource > OptionSource
TArray< struct FSFSettingOption > StaticOptions
TSubclassOf< USFSettingValue > ValueWrapperClass
bool bUseDynamicOptions = false

Public Attributes inherited from USFSettingDefinition

See USFSettingDefinition

Type Name
FText Description
FText DisplayName
TArray< TObjectPtr< class USFSettingCondition > > EditabilityConditions
FGameplayTag SettingTag
TArray< TObjectPtr< class USFSettingCondition > > VisibilityConditions
bool bRevertToDefaultOnDisable = false

Public Functions

Type Name
virtual class USFSettingValue * GetDefaultValue (const UObject * WorldContextObject) override const
TArray< struct FSFSettingOption > GetSettingOptions (const UObject * WorldContextObject) const
virtual TSubclassOf< USFSettingValue > GetValueClass () override const

Public Functions inherited from USFSettingDefinition

See USFSettingDefinition

Type Name
virtual class USFSettingValue * GetDefaultValue (const UObject * WorldContextObject) const
virtual TSubclassOf< USFSettingValue > GetValueClass () const

Protected Attributes inherited from USFSettingDefinition

See USFSettingDefinition

Type Name
TObjectPtr< class USFSettingValue > DefaultValue

Detailed Description

Setting definition for setting an option among a list. This is usually used for a dropdown or a rotator.

Blueprint display name: SF Discrete Setting.

Public Attributes Documentation

variable DeterminantSettingTags

FGameplayTagContainer USFSettingDefinition_Discrete::DeterminantSettingTags;

For dynamic options. The collection of settings that this setting should listen to to refresh its dynamic options. If the setting has a different refresh condition, explicitly call GetSettingOptions() for a new set of options.

Note:

EditDefaultsOnly BlueprintReadOnly

variable OptionSource

TSubclassOf<class USFSettingOptionSource> USFSettingDefinition_Discrete::OptionSource;

For dynamic options. The evaluator class that generates the options for this setting. The object created from this class is stored in USFSettingsSubsystem, and the logic from that object is run in GetSettingOptions() and GetDefaultValue().

Note:

EditDefaultsOnly BlueprintReadOnly

variable StaticOptions

TArray<struct FSFSettingOption> USFSettingDefinition_Discrete::StaticOptions;

For static options. The list of options to choose from for this setting. Each option has a display name and an underlying value. The value should be of the type specified by ValueWrapperClass.

Note:

EditDefaultsOnly BlueprintReadOnly

variable ValueWrapperClass

TSubclassOf<USFSettingValue> USFSettingDefinition_Discrete::ValueWrapperClass;

The underlying value type for the options in this setting.

Note:

EditDefaultsOnly

variable bUseDynamicOptions

bool USFSettingDefinition_Discrete::bUseDynamicOptions;

Does this setting have options that are generated dynamically at runtime?

Note:

EditDefaultsOnly

Public Functions Documentation

function GetDefaultValue

virtual class USFSettingValue * USFSettingDefinition_Discrete::GetDefaultValue (
    const UObject * WorldContextObject
) override const

Get the default value for this setting.

Returns:

If UseDynamicOptions is set to true, return the default value evaluated from the OptionSource. Else, return the fallback default value defined in the DefaultValue property.

Implements USFSettingDefinition::GetDefaultValue

function GetSettingOptions

TArray< struct FSFSettingOption > USFSettingDefinition_Discrete::GetSettingOptions (
    const UObject * WorldContextObject
) const

Get the option list for this setting.

Returns:

If UseDynamicOptions is set to true, return the option list evaluated from the OptionSource. Else, return the static option list defined in the StaticOptions property.

function GetValueClass

virtual TSubclassOf< USFSettingValue > USFSettingDefinition_Discrete::GetValueClass () override const

Get the USFSettingValue-derived class of the value this setting uses.

Returns:

The USFSettingValue-derived class of the value this setting uses.

Implements USFSettingDefinition::GetValueClass

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