Skip to content

Class USFSettingValue

ClassList > USFSettingValue

Abstract base class for all setting values. More...

  • #include "Core/SFSettingValue.h"

Inherits the following classes: UObject

Inherited by the following classes: USFSettingValue_Bool, USFSettingValue_Key, USFSettingValue_Scalar, USFSettingValue_String, USFSettingValue_Tag

Public Functions

Type Name
virtual void DeserializeFromString (const FString & InString)
virtual USFSettingValue * Duplicate (UObject * Outer) const
virtual bool Equals (const USFSettingValue * Other) const
virtual FString SerializeToString () const
virtual FString ToString () const

Detailed Description

Abstract base class for all setting values. Wraps raw data (float, bool, key) into a generic UObject for safe transport.

Note:

Abstract BlueprintType Blueprintable EditInlineNew DefaultToInstanced

Public Functions Documentation

function DeserializeFromString

virtual void USFSettingValue::DeserializeFromString (
    const FString & InString
)

Load value from string

Parameters:

  • InString The string to parse the value from, typically loaded from disk.

function Duplicate

inline virtual USFSettingValue * USFSettingValue::Duplicate (
    UObject * Outer
) const

Creates a deep copy of this value

Parameters:

  • Outer The outer for the new duplicated object. Typically the caller should pass in itself as the outer, so that the duplicated value will be owned by the same object that owns this value.

Returns:

A deep copy of this value object.

function Equals

virtual bool USFSettingValue::Equals (
    const USFSettingValue * Other
) const

Checks equality with another value object.

Parameters:

  • Other The other value object to compare with.

Returns:

true if the two value objects are considered equal in terms of their underlying value, false otherwise.

function SerializeToString

virtual FString USFSettingValue::SerializeToString () const

Convert current value to string for saving

Returns:

The string representation of the current value. Should be parseable by DeserializeFromString().

function ToString

inline virtual FString USFSettingValue::ToString () const

Helper function for debugging. Simply calls SerializeToString().

Returns:

The string representation of the current value, same as SerializeToString().

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