Settings

Settings

Windows
MacOS
Linux
On this page

Actions

Add Action Mapping

Programmatically add an action mapping to the project defaults

Target is Input Settings

Add Axis Mapping

Programmatically add an axis mapping to the project defaults

Target is Input Settings

Apply Hardware Benchmark Results

Applies the settings stored in ScalabilityQuality and saves settings

Target is Game User Settings

Apply Non Resolution Settings

Apply Non Resolution Settings

Target is Game User Settings

Apply Resolution Settings

Apply Resolution Settings

Target is Game User Settings

Apply Settings

Applies all current user settings to the game and saves to permanent storage (e.g. file), optionally checking for command line overrides.

Target is Game User Settings

Confirm Video Mode

Mark current video mode settings (fullscreenmode/resolution) as being confirmed by the user

Target is Game User Settings

Enable HDR Display Output

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

Target is Game User Settings

Force Rebuild Keymaps

When changes are made to the default mappings, push those changes out to PlayerInput key maps

Target is Input Settings

Get Action Mapping by Name

Get Action Mapping by Name

Target is Input Settings

Get Action Mappings by Name

Retrieve all VirtualCamera action mappings by a certain name.

Target is Virtual Camera User Settings

Get Action Names

Populate a list of all defined action names

Target is Input Settings

Get Anti Aliasing Quality

Returns the anti-aliasing quality (0..4, higher is better)

Target is Game User Settings

Get Audio Quality Level

Returns the user's audio quality level setting

Target is Game User Settings

Get Axis Mapping by Name

Retrieve all axis mappings by a certain name.

Target is Input Settings

Get Axis Mappings by Name

Retrieve all VirtualCamera axis mappings by a certain name.

Target is Virtual Camera User Settings

Get Axis Names

Populate a list of all defined axis names

Target is Input Settings

Get Current HDR Display Nits

Returns 0 if HDR isn't supported or is turned off

Target is Game User Settings

Get Default Resolution

Returns the default resolution when no resolution is set

Target is Game User Settings

Get Default Resolution Scale

Gets the desired resolution quality based on DesiredScreenWidth/Height and the current screen resolution

Target is Game User Settings

Get Default Window Mode

Returns the default window mode when no mode is set

Target is Game User Settings

Get Default Window Position

Returns the default window position when no position is set

Target is Game User Settings

Get Desktop Resolution

Returns user's desktop resolution, in pixels.

Target is Game User Settings

Get Foliage Quality

Returns the foliage quality (0..4, higher is better)

Target is Game User Settings

Get Frame Pace

Gets the current frame pacing frame rate in fps, or 0 if none

Target is Game User Settings

Get Frame Rate Limit

Gets the user's frame rate limit (0 indiciates the frame rate limit is disabled)

Target is Game User Settings

Get Fullscreen Mode

Returns the user setting for game window fullscreen mode.

Target is Game User Settings

Get Game Maps and Modes Settings

Returns the game local maps settings

Target is Game Maps Settings

Get Game User Settings

Returns the game local machine settings (resolution, windowing mode, scalability settings, etc...)

Target is Game User Settings

Get Input Settings

Returns the game local input settings (action mappings, axis mappings, etc...)

Target is Input Settings

Get Last Confirmed Fullscreen Mode

Returns the last confirmed user setting for game window fullscreen mode.

Target is Game User Settings

Get Last Confirmed Screen Resolution

Returns the last confirmed user setting for game screen resolution, in pixels.

Target is Game User Settings

Get Overall Scalability Level

Returns the overall scalability level (can return -1 if the settings are custom)

Target is Game User Settings

Get Post Processing Quality

Returns the post-processing quality (0..4, higher is better)

Target is Game User Settings

Get Preferred Fullscreen Mode

Returns the user setting for game window fullscreen mode.

Target is Game User Settings

Get Recommended Resolution Scale

Gets the recommended resolution quality based on LastRecommendedScreenWidth/Height and the current screen resolution

Target is Game User Settings

Get Resolution Scale Normalized

Gets the current resolution scale as a normalized 0..1 value between MinScaleValue and MaxScaleValue

Target is Game User Settings

Get Screen Resolution

Returns the user setting for game screen resolution, in pixels.

Target is Game User Settings

Get Shading Quality

Returns the shading quality (0..4, higher is better)

Target is Game User Settings

Get Shadow Quality

Returns the shadow quality (0..4, higher is better)

Target is Game User Settings

Get Sync Interval

Get Sync Interval

Target is Game User Settings

Get Texture Quality

Returns the texture quality (0..4, higher is better)

Target is Game User Settings

Get View Distance Quality

Returns the view distance quality (0..4, higher is better)

Target is Game User Settings

Get Visual Effect Quality

Returns the visual effects quality (0..4, higher is better)

Target is Game User Settings

GetResolutionScaleInformation

Returns the current resolution scale and the range

Target is Game User Settings

Is Dirty

Checks if any user settings is different from current

Target is Game User Settings

Is Dynamic Resolution Dirty

Checks if the dynamic resolution user setting is different from current system setting

Target is Game User Settings

Is Dynamic Resolution Enabled

Returns the user setting for dynamic resolution.

Target is Game User Settings

Is Fullscreen Mode Dirty

Checks if the FullscreenMode user setting is different from current

Target is Game User Settings

Is HDR Enabled

Is HDREnabled

Target is Game User Settings

Is Screen Resolution Dirty

Checks if the Screen Resolution user setting is different from current

Target is Game User Settings

Is VSync Dirty

Checks if the vsync user setting is different from current system setting

Target is Game User Settings

Is VSync Enabled

Returns the user setting for vsync.

Target is Game User Settings

Load Settings

Loads the user settings from persistent storage

Target is Game User Settings

Remove Action Mapping

Programmatically remove an action mapping to the project defaults

Target is Input Settings

Remove Axis Mapping

Programmatically remove an axis mapping to the project defaults

Target is Input Settings

Reset to Current Settings

This function resets all settings to the current system settings

Target is Game User Settings

Revert Video Mode

Revert video mode (fullscreenmode/resolution) back to the last user confirmed values

Target is Game User Settings

Run Hardware Benchmark

Runs the hardware benchmark and populates ScalabilityQuality as well as the last benchmark results config members, but does not apply the settings it determines. Designed to be called in conjunction with ApplyHardwareBenchmarkResults

Target is Game User Settings

Save Key Mappings

Flush the current mapping values to the config file

Target is Input Settings

Save Settings

Save the user settings to persistent storage (automatically happens as part of ApplySettings)

Target is Game User Settings

Set Anti Aliasing Quality

Sets the anti-aliasing quality (0..4, higher is better)

Target is Game User Settings

Set Audio Quality Level

Sets the user's audio quality level setting

Target is Game User Settings

Set Benchmark Fallback Values

Set scalability settings to sensible fallback values, for use when the benchmark fails or potentially causes a crash

Target is Game User Settings

Set Dynamic Resolution Enabled

Sets the user setting for dynamic resolution. See UGameUserSettings::bUseDynamicResolution.

Target is Game User Settings

Set Foliage Quality

Sets the foliage quality (0..4, higher is better)

Target is Game User Settings

Set Frame Rate Limit

Sets the user's frame rate limit (0 will disable frame rate limiting)

Target is Game User Settings

Set Fullscreen Mode

Sets the user setting for the game window fullscreen mode. See UGameUserSettings::FullscreenMode.

Target is Game User Settings

Set Overall Scalability Level

Changes all scalability settings at once based on a single overall quality level

Target is Game User Settings

Set Post Processing Quality

Sets the post-processing quality (0..4, higher is better)

Target is Game User Settings

Set Resolution Scale Normalized

Sets the current resolution scale as a normalized 0..1 value between MinScaleValue and MaxScaleValue

Target is Game User Settings

Set Screen Resolution

Sets the user setting for game screen resolution, in pixels.

Target is Game User Settings

Set Shading Quality

Sets the shading quality (0..4, higher is better)

Target is Game User Settings

Set Shadow Quality

Sets the shadow quality (0..4, higher is better)

Target is Game User Settings

Set Texture Quality

Sets the texture quality (0..4, higher is better)

Target is Game User Settings

Set to Defaults

Set to Defaults

Target is Game User Settings

Set View Distance Quality

Sets the view distance quality (0..4, higher is better)

Target is Game User Settings

Set Visual Effect Quality

Sets the visual effects quality (0..4, higher is better)

Target is Game User Settings

Set VSync Enabled

Sets the user setting for vsync. See UGameUserSettings::bUseVSync.

Target is Game User Settings

SetResolutionScaleValue

Sets the current resolution scale

Target is Game User Settings

Supports HDR Display Output

Whether the curently running system supports HDR display output

Target is Game User Settings

Validate Settings

Validates and resets bad user settings to default. Deletes stale user settings file if necessary.

Target is Game User Settings

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss