API ReferenceGE Extensionscoresettings
Settings Graphic
Manages all graphics settings: display mode, resolution, refresh rate, GPU selection, quality presets, reflections, mirrors, post-processing effects, and more.
Manages all graphics settings: display mode, resolution, refresh rate, GPU selection, quality presets, reflections, mirrors, post-processing effects, and more.
Overview
Extension: core_settings_graphic - The largest settings module. Builds option helpers for the graphics settings UI, applies video mode changes, manages quality group presets, and handles display driver enumeration.
Public Functions
| Function | Description |
|---|---|
M.getOptions(optionName) | Returns single option helper or full table |
M.getDisplayInformation() | Returns cached GPU, API, monitor outputs, and window region |
M.buildOptionHelpers() | Builds all graphics option get/set/getModes helpers |
M.onInitSettings(data) | Initializes settings from persisted data |
M.onFirstUpdateSettings() | Runs on first update; shows canvas, gathers display info |
M.refreshGraphicsState(newState) | Updates display driver/mode/resolution/refresh from new state |
M.applyGraphicsState() | Applies current options to the video mode and saves |
M.onUiChangedState(toState, fromState) | Captures/restores graphics state when entering/leaving options UI |
M.load(newState) | Refreshes then applies full graphics state |
M.onSettingsChanged() | Checks if current settings match an overall quality preset |
M.autoDetectApplyGraphicsQuality() | Stub for auto-detection (currently disabled) |
M.toggleFullscreen() | Toggles fullscreen via Canvas |
M.getOverallQualityPresets() | Returns the presets JSON table |
M.openMonitorConfiguration | () |
Key Option Helpers
| Option Key | Type | Description |
|---|---|---|
GraphicDisplayModes | enum | Window / Fullscreen / Borderless |
GraphicDisplayResolutions | string | "width height" |
GraphicDisplayRefreshRates | number | Hz value |
GraphicDisplayDriver | string | Monitor output path |
GraphicGPU | string | GPU device name |
GraphicOverallQuality | enum | Custom/Lowest/Low/SteamDeck/Normal/High/Ultra |
GraphicMeshQuality | enum | Mesh LOD preset |
GraphicTextureQuality | enum | Texture reduction preset |
GraphicLightingQuality | enum | Light manager + shadow filter |
GraphicShadowsQuality | enum | Shadow texture scalar + disable flag |
GraphicShaderQuality | enum | Parallax, specular, water reflections |
GraphicAntialias | enum | Off / x1 / x2 / x4 (SMAA or FXAA) |
GraphicAnisotropic | enum | Off / x4 / x8 / x16 |
vsync | bool | V-Sync toggle |
PostFXDOFGeneralEnabled | bool | Depth of field |
PostFXBloomGeneralEnabled | bool | Bloom |
PostFXLightRaysEnabled | bool | God rays |
PostFXMotionBlurEnabled | bool | Motion blur |
PostFXSSAOGeneralEnabled | bool | Screen-space ambient occlusion |
GraphicDynReflection* | various | Dynamic reflection settings |
GraphicDynMirrors* | various | Dynamic mirror settings |
Module State
| Variable | Type | Default |
|---|---|---|
triggered_manual_save | boolean | nil (set during applyGraphicsState) |
appliedChanges | boolean | nil (set after applyGraphicsState) |
selected_displayMode | string | Set on options UI entry |
selected_displayDriver | string | Set on options UI entry |
selected_resolution | string | Set on options UI entry |
selected_refreshRate | number | Set on options UI entry |
current_windowPlacement | string | Set on options UI entry |
Usage Examples
-- Apply Ultra quality preset
local opts = core_settings_graphic.getOptions()
opts.GraphicOverallQuality.set('Ultra')
-- Toggle fullscreen
core_settings_graphic.toggleFullscreen()
-- Get current resolution
local res = core_settings_graphic.getOptions('GraphicDisplayResolutions').get()See Also
- GraphicsQualityGroup - Quality group class
- Settings - Main settings persistence