Static Public Member Functions
Static Functions
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Setting Object
FSettingDescription	m_Description
	The description of this setting.
int	m_PlatformExclusivityMask
	If any platforms are set the setting is exclusive to them and won't be shown on others.
int	m_InputAvailabilityMask
	If any Input modes are set the setting will only available when they are used, and unavailable otherwise.
const FSettingDescription	Description
	Returns the descriptive text of this setting.
const FText	DisplayName
	Returns the display name.
const ESettingsType	SettingsType
	Returns the type of this setting.
FText	m_DisplayName
	The display name of this setting.
bool	IsAvailable () const
	Returns if this setting is currently available, e.g. by the current display mode (will be grayer out if not).
const FSettingDescription &	GetDescription () const
	Returns the descriptive text of this setting.
const FText &	GetDisplayName () const
	Returns the display name.
ESettingsType	GetSettingsType () const
	Returns the type of this setting.
bool	HideUnavailable () const
	Whether this setting should be hidden if not available.
void	ConfirmValue ()
	To be called when the user wants to confirm the new value of this setting.
bool	IsInputModeSupported () const
	Returns if this setting is supported for the current input mode.
bool	IsPlattformSupported () const
	Returns if this setting is supported for the current platform.
bool	IsSupported () const
	Returns if this setting is even supported, e.g. by soft- or hardware (won't show up at all if not).
void	RevertToLastConfirmedValue ()
	To be called when the user wants to revert the value of this setting to the last confirmed value.

Additional Inherited Members
Public Member Functions inherited from UObject
bool	MarkPackageDirty () const
void	RemoveFromRoot ()
bool	GetIsRooted () const
bool	IsTransient () const
bool	Modify (bool bAlwaysMarkDirty=true)
void	SetTransactional (bool bTransactional)
bool	IsSupportedForNetworking () const
UClass	GetClass () const
UObject	GetOuter () const
UObject	GetTypedOuter (TSubclassOf< UObject > Target) const
	Traverses the outer chain searching for the next object of a certain type.
UPackage	GetOutermost () const
UPackage	GetPackage () const
void	AddToRoot ()
UWorld	GetWorld () const
FName	GetName () const
FString	GetFullName (const UObject StopOuter=nullptr) const
FString	GetPathName (const UObject StopOuter=nullptr) const
bool	IsA (const UClass Class) const
	Returns true if this object is of the specified type, or a child of that type.
void	SaveConfig ()
void	LoadConfig ()
void	ReloadConfig ()
void	CopyScriptPropertiesFrom (const UObject OtherObject)
void	opCast (?&Address) const
FString	ToString () const
Public Attributes inherited from UObject
const UClass	Class
const UObject	Outer
const UPackage	Outermost
const UPackage	Package
const UWorld	World
const FName	Name
const bool	IsRooted

Detailed Description

USettingObject.

A UObject encapsulating a single setting.

Member Function Documentation

◆ ConfirmValue()

void ConfirmValue ( )

To be called when the user wants to confirm the new value of this setting.

◆ GetDescription()

const FSettingDescription & GetDescription ( ) const

Returns the descriptive text of this setting.

◆ GetDisplayName()

const FText & GetDisplayName ( ) const

Returns the display name.

◆ GetSettingsType()

ESettingsType GetSettingsType ( ) const

Returns the type of this setting.

◆ HideUnavailable()

bool HideUnavailable ( ) const

Whether this setting should be hidden if not available.

◆ IsAvailable()

bool IsAvailable ( ) const

Returns if this setting is currently available, e.g. by the current display mode (will be grayer out if not).

◆ IsInputModeSupported()

bool IsInputModeSupported ( ) const

Returns if this setting is supported for the current input mode.

◆ IsPlattformSupported()

bool IsPlattformSupported ( ) const

Returns if this setting is supported for the current platform.

◆ IsSupported()

bool IsSupported ( ) const

Returns if this setting is even supported, e.g. by soft- or hardware (won't show up at all if not).

◆ RevertToLastConfirmedValue()

void RevertToLastConfirmedValue ( )

To be called when the user wants to revert the value of this setting to the last confirmed value.

◆ StaticClass()

UClass StaticClass ( )

static

Member Data Documentation

◆ Description

const FSettingDescription Description

Returns the descriptive text of this setting.

◆ DisplayName

const FText DisplayName

Returns the display name.

◆ m_Description

FSettingDescription m_Description

The description of this setting.

◆ m_DisplayName

FText m_DisplayName

The display name of this setting.

◆ m_InputAvailabilityMask

int m_InputAvailabilityMask

If any Input modes are set the setting will only available when they are used, and unavailable otherwise.

◆ m_PlatformExclusivityMask

int m_PlatformExclusivityMask

If any platforms are set the setting is exclusive to them and won't be shown on others.

◆ SettingsType

const ESettingsType SettingsType