ULimenVSyncSetting
Overview
ULimenVSyncSetting is a subclass of ULimenSelectionSetting designed to handle the VSync configuration. It provides functionality to apply the current setting and set default values. The class uses static strings to represent the enabled and disabled states, which are formatted and parsed for user selection.
Properties
Type | Name | Access | Description |
|---|---|---|---|
FString | Enabled | Private | Static string representing the "Enabled" state of VSync. |
FString | Disabled | Private | Static string representing the "Disabled" state of VSync. |
Functions
Return Type | Signature | Description |
|---|---|---|
void | ApplyCurrentSetting(bool bUserRequest) | Applies the current VSync setting based on user request. Calls the base class method and updates the engine's game user settings with the parsed value from |
void | SetDefaults() | Sets default values for the possible selections and the default selection. Adds "Enabled" and "Disabled" to |
FString | FormatVSyncSetting(const bool bIsEnabled) | Formats a boolean value indicating whether VSync is enabled or disabled into a string representation ("Enabled" or "Disabled"). |
bool | UnFormatVSyncSetting(const FString& Selection) | Parses a string representation of the VSync state ("Enabled" or "Disabled") and returns a boolean value indicating whether VSync is enabled. |
Usage & Implementation Notes
This class does not have any specific threading constraints, replication requirements, memory lifetime management, or initialization dependencies beyond those inherent to Unreal Engine's settings system.
The
checkNoEntry()macro is used in theUnFormatVSyncSettingfunction to ensure that only valid selections are processed. If an invalid selection is encountered, it will trigger a runtime error.