1. Epic GamesDeveloper
  3. UGameUserSettings

UGameUserSettings

Stores user settings for a game (for example graphics and sound settings), with the ability to save and load to and from a file.

Unreal Engine C++ API Reference > Runtime > Engine > GameFramework

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/GameFramework/GameUserSettings.h
Include #include "GameFramework/GameUserSettings.h"

Syntax

UCLASS (Config=GameUserSettings, ConfigDoNotCheckDefaults, MinimalAPI)  
class UGameUserSettings : public UObject

Remarks

Stores user settings for a game (for example graphics and sound settings), with the ability to save and load to and from a file.

Variables

  Type Name Description
Protected variable UProperty Config int32 AudioQualityLevel  
Protected variable UProperty GlobalConfig bool bUseDesiredScreenHeight If true, the desired screen height will be used to scale the render resolution automatically.
Public variable UProperty Config bool bUseDynamicResolution Whether to use dynamic resolution or not. (public to allow UI to connect to it)
Protected variable UProperty Config bool bUseHDRDisplayOutput HDR
Public variable UProperty Config bool bUseVSync Whether to use VSync or not. (public to allow UI to connect to it)
Protected variable UProperty Config int32 DesiredScreenHeight Desired screen height used to calculate the resolution scale when user changes display mode
Protected variable UProperty Config int32 DesiredScreenWidth Desired screen width used to calculate the resolution scale when user changes display mode
Protected variable UProperty Config float FrameRateLimit Frame rate cap
Protected variable UProperty Config int32 FullscreenMode Game window fullscreen mode 0 = Fullscreen 1 = Windowed fullscreen 2 = Windowed
Protected variable UProperty Config int32 HDRDisplayOutputNits HDR
Protected variable UProperty Config int32 LastConfirmedAudioQualityLevel  
Protected variable UProperty Config int32 LastConfirmedFullscreenMode Last user confirmed fullscreen mode setting.
Protected variable UProperty Config float LastCPUBenchmarkResult Result of the last benchmark (CPU); -1 if there has not been a benchmark run
Protected variable UProperty Config TArray< float > LastCPUBenchmarkSteps Result of each individual sub-section of the last CPU benchmark; empty if there has not been a benchmark run
Protected variable UProperty Config float LastGPUBenchmarkMultiplier Multiplier used against the last GPU benchmark
Protected variable UProperty Config float LastGPUBenchmarkResult Result of the last benchmark (GPU); -1 if there has not been a benchmark run
Protected variable UProperty Config TArray< float > LastGPUBenchmarkSteps Result of each individual sub-section of the last GPU benchmark; empty if there has not been a benchmark run
Protected variable UProperty Config float LastRecommendedScreenHeight Result of the last benchmark; calculated resolution to use.
Protected variable UProperty Config float LastRecommendedScreenWidth Result of the last benchmark; calculated resolution to use.
Protected variable UProperty Config int32 LastUserConfirmedDesiredScreenHeight Desired screen height used to calculate the resolution scale when user changes display mode
Protected variable UProperty Config int32 LastUserConfirmedDesiredScreenWidth Desired screen width used to calculate the resolution scale when user changes display mode
Protected variable UProperty Config uint32 LastUserConfirmedResolutionSizeX Game screen resolution width, in pixels.
Protected variable UProperty Config uint32 LastUserConfirmedResolutionSizeY Game screen resolution height, in pixels.
Protected variable float MinResolutionScale Min resolution scale we allow in current display mode
Public variable FUpdateCloudDataFromGameUserSettings OnUpdateCloudDataFromGameUserSettings  
Public variable FUpdateGameUserSettingsFileFromCloud OnUpdateGameUserSettingsFileFromCloud  
Protected variable UProperty Config int32 PreferredFullscreenMode Fullscreen mode to use when toggling between windowed and fullscreen.
Protected variable UProperty Config uint32 ResolutionSizeX Game screen resolution width, in pixels.
Protected variable UProperty Config uint32 ResolutionSizeY Game screen resolution height, in pixels.
Public variable Scalability::FQualityLevels ScalabilityQuality Cached for the UI, current state if stored in console variables
Protected variable UProperty Config uint32 Version All settings will be wiped and set to default if the serialized version differs from UE_GAMEUSERSETTINGS_VERSION.
Protected variable UProperty Config int32 WindowPosX Window PosX
Protected variable UProperty Config int32 WindowPosY Window PosY

Constructors

  Type Name Description
Public function  

UGameUserSettings ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual UFunction BlueprintCallable, Category void Applies the settings stored in ScalabilityQuality and saves settings
Public function Virtual UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

ApplyResolutionSettings ( bool bCheckForCommandLineOverrides
)

  
Public function Virtual UFunction BlueprintCallable, Category, Meta void

ApplySettings ( bool bCheckForCommandLineOverrides
)

 Applies all current user settings to the game and saves to permanent storage (e.g. file), optionally checking for command line overrides.
Public function Virtual UFunction BlueprintCallable, Category void Mark current video mode settings (fullscreenmode/resolution) as being confirmed by the user
Public function UFunction BlueprintCallable, Category, Meta void

EnableHDRDisplayOutput ( bool bEnable,
int32 DisplayNits
)

 Enables or disables HDR display output. Can be called again to change the desired nit level
Protected function void

EnableHDRDisplayOutputInternal ( bool bEnable,
int32 DisplayNits,
bool bFromUserSettings
)

  
Protected function float

FindResolutionQualityForScreenSize ( float Width,
float Height
)

 Picks the best resolution quality for a given screen size
Public function Const UFunction BlueprintCallable, Category int32 Returns the anti-aliasing quality (0..4, higher is better)
Public function Const UFunction BlueprintPure, Category int32 Returns the user's audio quality level setting
Public function Static FString  
Public function Const UFunction BlueprintCallable, Category, Meta int32 Returns 0 if HDR isn't supported or is turned off
Public function Static UFunction BlueprintCallable, Category FIntPoint Returns the default resolution when no resolution is set
Public function Virtual UFunction BlueprintCallable, Category float Gets the desired resolution quality based on DesiredScreenWidth/Height and the current screen resolution
Public function Static UFunction BlueprintCallable, Category EWindowMode::Type Returns the default window mode when no mode is set
Public function Static UFunction BlueprintCallable, Category FIntPoint Returns the default window position when no position is set
Public function Const UFunction BlueprintPure, Category FIntPoint Returns user's desktop resolution, in pixels.
Protected function Virtual float Returns the effective frame rate limit (by default it returns the FrameRateLimit member)
Public function Const UFunction BlueprintCallable, Category int32 Returns the foliage quality (0..4, higher is better)
Public function Static UFunction BlueprintPure, Category int32 Gets the current frame pacing frame rate in fps, or 0 if none
Public function Const UFunction BlueprintPure, Category float Gets the user's frame rate limit (0 indiciates the frame rate limit is disabled)
Public function Const UFunction BlueprintPure, Category EWindowMode::Type Returns the user setting for game window fullscreen mode.
Public function Static UFunction BlueprintCallable, Category UGameUserSettings * Returns the game local machine settings (resolution, windowing mode, scalability settings, etc...)
Public function Const UFunction BlueprintCallable, Category int32 Returns the global illumination quality (0..4, higher is better)
Public function Const UFunction BlueprintPure, Category EWindowMode::Type Returns the last confirmed user setting for game window fullscreen mode.
Public function Const UFunction BlueprintPure, Category FIntPoint Returns the last confirmed user setting for game screen resolution, in pixels.
Public function Const float Returns the last CPU benchmark result (set by RunHardwareBenchmark)
Public function Const TArray< float > Returns each individual step of the last CPU benchmark result (set by RunHardwareBenchmark)
Public function Const float Returns the last GPU benchmark result (set by RunHardwareBenchmark)
Public function Const TArray< float > Returns each individual step of the last GPU benchmark result (set by RunHardwareBenchmark)
Public function Virtual Const UFunction BlueprintCallable, Category int32 Returns the overall scalability level (can return -1 if the settings are custom)
Public function Const UFunction BlueprintCallable, Category int32 Returns the post-processing quality (0..4, higher is better)
Public function Const UFunction BlueprintPure, Category EWindowMode::Type Returns the user setting for game window fullscreen mode.
Public function Virtual UFunction BlueprintCallable, Category float Gets the recommended resolution quality based on LastRecommendedScreenWidth/Height and the current screen resolution
Public function Const UFunction BlueprintCallable, Category int32 Returns the reflection quality (0..4, higher is better)
Public function Const UFunction BlueprintCallable, Category, Meta void

GetResolutionScaleInformationEx ( float& CurrentScaleNormalized,
float& CurrentScaleValue,
float& MinScaleValue,
float& MaxScaleValue
)

 Returns the current resolution scale and the range.
Public function Const UFunction BlueprintCallable, Category float Gets the current resolution scale as a normalized 0..1 value between MinScaleValue and MaxScaleValue.
Public function Const UFunction BlueprintPure, Category FIntPoint Returns the user setting for game screen resolution, in pixels.
Public function Const UFunction BlueprintCallable, Category int32 Returns the shading quality (0..4, higher is better)
Public function Const UFunction BlueprintCallable, Category int32 Returns the shadow quality (0..4, higher is better)
Public function Static UFunction BlueprintPure, Category int32 Gets the current vsync interval setting
Public function Const UFunction BlueprintCallable, Category int32 Returns the texture quality (0..4, higher is better)
Public function Const UFunction BlueprintCallable, Category int32 Returns the view distance quality (0..4, higher is better)
Public function Const UFunction BlueprintCallable, Category int32 Returns the visual effects quality (0..4, higher is better)
Public function Virtual FIntPoint  
Public function Virtual Const UFunction BlueprintPure, Category bool

IsDirty ()

 Checks if any user settings is different from current
Public function Const UFunction BlueprintPure, Category bool Checks if the dynamic resolution user setting is different from current system setting
Public function Virtual Const UFunction BlueprintPure, Category bool Returns the user setting for dynamic resolution.
Public function Const UFunction BlueprintPure, Category bool Checks if the FullscreenMode user setting is different from current
Public function Const UFunction BlueprintCallable, Category, Meta bool  
Public function Const UFunction BlueprintPure, Category bool Checks if the Screen Resolution user setting is different from current
Protected function Virtual bool Check if the current version of the game user settings is valid.
Public function Const UFunction BlueprintPure, Category bool Checks if the vsync user setting is different from current system setting
Public function Const UFunction BlueprintPure, Category bool Returns the user setting for vsync.
Public function Static void

LoadConfigIni ( bool bForceReload
)

 Loads the user .ini settings into GConfig
Public function Virtual UFunction BlueprintCallable, Category void

LoadSettings ( bool bForceReload
)

 Loads the user settings from persistent storage
Public function Static void

PreloadResolutionSettings ( bool bAllowCmdLineOverrides
)

 Loads the resolution settings before is object is available
Public function Static void

RequestResolutionChange ( int32 InResolutionX,
int32 InResolutionY,
EWindowMode::Type InWindowMode,
bool bInDoOverrides
)

 Request a change to the specified resolution and window mode. Optionally apply cmd line overrides.
Public function void  
Public function Virtual UFunction BlueprintCallable, Category void This function resets all settings to the current system settings
Public function UFunction BlueprintCallable, Category void Revert video mode (fullscreenmode/resolution) back to the last user confirmed values
Public function Virtual UFunction BlueprintCallable, Category void

RunHardwareBenchmark ( int32 WorkScale,
float CPUMultiplier,
float GPUMultiplier
)

 Runs the hardware benchmark and populates ScalabilityQuality as well as the last benchmark results config members, but does not apply the settings it determines.
Public function Virtual UFunction BlueprintCallable, Category void Save the user settings to persistent storage (automatically happens as part of ApplySettings)
Public function UFunction BlueprintCallable, Category void Sets the anti-aliasing quality (0..4, higher is better)
Public function UFunction BlueprintCallable, Category void

SetAudioQualityLevel ( int32 QualityLevel
)

 Sets the user's audio quality level setting
Public function UFunction BlueprintCallable, Category void Set scalability settings to sensible fallback values, for use when the benchmark fails or potentially causes a crash
Public function UFunction BlueprintCallable, Category void

SetDynamicResolutionEnabled ( bool bEnable
)

 Sets the user setting for dynamic resolution.
Public function UFunction BlueprintCallable, Category void Sets the foliage quality (0..4, higher is better)
Public function UFunction BlueprintCallable, Category void

SetFrameRateLimit ( float NewLimit
)

 Sets the user's frame rate limit (0 will disable frame rate limiting)
Protected function Static void

SetFrameRateLimitCVar ( float InLimit
)

 Sets the frame rate limit CVar to the passed in value, 0.0 indicates no limit
Public function UFunction BlueprintCallable, Category void

SetFullscreenMode ( EWindowMode::Type InFullscreenMode
)

 Sets the user setting for the game window fullscreen mode.
Public function UFunction BlueprintCallable, Category void Sets the global illumination quality (0..4, higher is better)
Public function Virtual UFunction BlueprintCallable, Category void Changes all scalability settings at once based on a single overall quality level
Public function UFunction BlueprintCallable, Category void Sets the post-processing quality (0..4, higher is better)
Public function UFunction BlueprintCallable, Category void Sets the reflection quality (0..4, higher is better)
Public function UFunction BlueprintCallable, Category void

SetResolutionScaleNormalized ( float NewScaleNormalized
)

 Sets the current resolution scale as a normalized 0..1 value between MinScaleValue and MaxScaleValue.
Public function UFunction BlueprintCallable, Category, Meta void

SetResolutionScaleValueEx ( float NewScaleValue
)

 Sets the current resolution scale.
Public function UFunction BlueprintCallable, Category void Sets the user setting for game screen resolution, in pixels.
Public function UFunction BlueprintCallable, Category void Sets the shading quality (0..4, higher is better)
Public function UFunction BlueprintCallable, Category void Sets the shadow quality (0..4, higher is better)
Protected function Static void

SetSyncTypeCVar ( int32 InInterval
)

 Sets the input latency mode 0 and 2
Public function UFunction BlueprintCallable, Category void Sets the texture quality (0..4, higher is better)
Public function Virtual UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void Sets the view distance quality (0..4, higher is better)
Public function UFunction BlueprintCallable, Category void Sets the visual effects quality (0..4, higher is better)
Public function UFunction BlueprintCallable, Category void

SetVSyncEnabled ( bool bEnable
)

 Sets the user setting for vsync.
Public function Virtual void

SetWindowPosition ( int32 WindowPosX,
int32 WindowPosY
)

  
Public function Virtual Const UFunction BlueprintCallable, Category, Meta bool Whether the curently running system supports HDR display output
Protected function void  
Protected function Virtual void Update the version of the game user settings to the current version
Public function Virtual UFunction BlueprintCallable, Category void Validates and resets bad user settings to default. Deletes stale user settings file if necessary.

Typedefs

Name Description
FUpdateCloudDataFromGameUserSettings We call this to notify any listening Cloud subsystem that we have updated the config file.
FUpdateGameUserSettingsFileFromCloud We call this to refresh the config file from a listening Cloud subsystem, before we open it.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page
Back to top
Games
Marketplaces
Tools
Online Services
Resources
Company

© 2004-2025, Epic Games, Inc. All rights reserved. Unreal and its logo are Epic’s trademarks or registered trademarks in the US and elsewhere.