class

FGameUserSettings

UE5's GameUserSettings, in the shape this engine already has: cvars for the renderer knobs, GlobalConfig for the audio buses, and a per-user MDF file under <project>/Saved/Config that keeps the player's choices out of the committed project tier.

Module
ArcUI
Header
#include "ArcUI/Settings/FGameUserSettings.h"
Namespace
Mowo

Type aliases

AliasDescription
using FHostApplier = std::function<void(const FArcSettingRow& row, const std::string& value, bool persist)>persist is false for the startup push, which is replaying values the store already holds — or, on a fresh machine, the table defaults. A host that writes its own file must honour it, or first launch overwrites a configuration some other path wrote and stamps it as the player's.
using FDisplayOptionProvider = std::function<std::vector<FArcDisplayOption>(const std::string& key)>

Public functions

ReturnsNameDescription
FGameUserSettings&Get
std::stringStorePath<project>/Saved/Config/GameUserSettings.ini, or the per-user product dir when no project is open.
voidBuildModelBuilds every row against the given device profile.
boolIsBuilt
boolEnsureVendorRuntimesProbedA model built without the vendor runtimes offers every choice the API allows.
boolIsVendorProbePending
uint64_tModelRevisionBumps whenever the model is rebuilt with new device answers, so an open screen knows to rebuild its rows.
const std::vector<FArcSettingRow>&Rows
std::vector<const FArcSettingRow*>RowsIn
const FArcSettingRow*FindRow
boolRegisterRowAdds a row (and, through def.Page, a page) to the settings screen.
boolUnregisterRow
voidRefreshRequirementsRe-evaluates every registered Requirement, for a game whose availability changes at run time (a world loaded, a device plugged in).
std::vector<std::string>PagesThe game's own pages in registration order, and the rows on one.
std::vector<const FArcSettingRow*>RowsOnPage
std::stringTierValueThe value a tier-mapped row takes at tier (clamped), empty when the row has no mapping.
std::vector<std::string>AmbiguousChoiceRowsOne entry per pair of choices in one row that carry the same value.
boolSetPendingStages an edit.
boolIsDirty
boolIsDirty
boolApplyPushes every staged value at its backend and writes the store.
voidRevertThrows the staged edits away.
voidResetToDefaults
voidResetToDefaults
voidResetPageToDefaults
boolIsAwaitingConfirmationA mode change that leaves the display dark cannot be undone by a player who cannot see the screen, so Apply arms a countdown and reverts on its own unless the player confirms.
floatConfirmationSecondsRemaining
voidSetConfirmationSeconds
boolTickConfirmationDrive from the UI tick.
voidKeepConfirmedChanges
voidRevertConfirmedChanges
boolLoad
boolLoad
boolSave
boolSave
voidApplyToBackendsPushes the applied values at their backends without touching the file — the startup path, run once the model is built and the store is read.
voidSetHostApplierThe runtime host owns the window, so it owns everything the Display category actually changes.
voidSetDisplayOptionProvider
voidSetAppliesArcPaletteWhether High Contrast UI also swaps Arc's Mowo palette (the colours the settings screen and other built-in menus paint with).
boolAppliesArcPalette
int32_tApplyArcPaletteLoads a Mowo palette file (the editor's theme JSON: a "colors" table of token name → "#RRGGBB" or "#RRGGBBAA") over the default colours, or resets to the defaults when the path is empty.
voidRefreshDisplayOptionsRefills the choice lists of the Host rows from the provider.
const char*CategoryLabel

Function details

Get

C++
static FGameUserSettings& Get()

StorePath

C++
static std::string StorePath()

<project>/Saved/Config/GameUserSettings.ini, or the per-user product dir when no project is open. Never the project's Config dir: that one is committed and belongs to the team, not to one player's machine.

BuildModel

C++
void BuildModel(const FArcDeviceProfile& profile)

Builds every row against the given device profile. Safe to call again — pending edits are dropped and the applied values re-read.

IsBuilt

C++
bool IsBuilt() const

EnsureVendorRuntimesProbed

C++
bool EnsureVendorRuntimesProbed()

A model built without the vendor runtimes offers every choice the API allows. The settings screen calls this before it shows anything: the model is rebuilt from a full probe and the store read again, so a choice this GPU cannot run is withdrawn. True when it rebuilt.

IsVendorProbePending

C++
bool IsVendorProbePending() const

ModelRevision

C++
uint64_t ModelRevision() const

Bumps whenever the model is rebuilt with new device answers, so an open screen knows to rebuild its rows.

Rows

C++
const std::vector<FArcSettingRow>& Rows() const

RowsIn

C++
std::vector<const FArcSettingRow*> RowsIn(EArcSettingCategory category) const

FindRow

C++
const FArcSettingRow* FindRow(const std::string& key) const

RegisterRow

C++
bool RegisterRow(const FArcGameSettingDef& def)

Adds a row (and, through def.Page, a page) to the settings screen. May be called before or after BuildModel: the definition is kept and re-applied on every rebuild, so a vendor-probe rebuild never drops it. Returns false — and logs why — for an empty or already-used id, a cvar-bound row whose cvar does not exist, a choice row with no choices or with two choices that share a value. Calling it again with the same id replaces the definition.

UnregisterRow

C++
bool UnregisterRow(const std::string& id)

RefreshRequirements

C++
void RefreshRequirements()

Re-evaluates every registered Requirement, for a game whose availability changes at run time (a world loaded, a device plugged in). Bumps the model revision when an answer changed, so an open screen redraws.

Pages

C++
std::vector<std::string> Pages() const

The game's own pages in registration order, and the rows on one. The six built-in categories never list a registered page's rows.

RowsOnPage

C++
std::vector<const FArcSettingRow*> RowsOnPage(const std::string& page) const

TierValue

C++
static std::string TierValue(const FArcSettingRow& row, int32_t tier)

The value a tier-mapped row takes at tier (clamped), empty when the row has no mapping.

AmbiguousChoiceRows

C++
std::vector<std::string> AmbiguousChoiceRows() const

One entry per pair of choices in one row that carry the same value. The combo box, the companion write and the saved file all resolve a choice BY value, so such a pair is unrepresentable: the player picks one option and a different one is applied. Must come back empty; BuildModel logs any entry as an error.

SetPending

C++
bool SetPending(const std::string& key, const std::string& value)

Stages an edit. Refused for a row the device cannot do, which is what keeps a greyed control from being driven by a stale saved file.

IsDirty

C++
bool IsDirty() const

IsDirty

C++
bool IsDirty(EArcSettingCategory category) const

Apply

C++
bool Apply()

Pushes every staged value at its backend and writes the store. Returns false only when the store could not be written — the values are live either way, because refusing what the player just asked for is worse than a settings file that failed to save.

Revert

C++
void Revert()

Throws the staged edits away.

ResetToDefaults

C++
void ResetToDefaults()

ResetToDefaults

C++
void ResetToDefaults(EArcSettingCategory category)

ResetPageToDefaults

C++
void ResetPageToDefaults(const std::string& page)

IsAwaitingConfirmation

C++
bool IsAwaitingConfirmation() const

A mode change that leaves the display dark cannot be undone by a player who cannot see the screen, so Apply arms a countdown and reverts on its own unless the player confirms.

ConfirmationSecondsRemaining

C++
float ConfirmationSecondsRemaining() const

SetConfirmationSeconds

C++
void SetConfirmationSeconds(float seconds)

TickConfirmation

C++
bool TickConfirmation(float deltaSeconds)

Drive from the UI tick. True on the frame the countdown ran out and the previous display values were put back.

KeepConfirmedChanges

C++
void KeepConfirmedChanges()

RevertConfirmedChanges

C++
void RevertConfirmedChanges()

Load

C++
bool Load()

Load

C++
bool Load(const std::string& filepath)

Save

C++
bool Save()

Save

C++
bool Save(const std::string& filepath)

ApplyToBackends

C++
void ApplyToBackends()

Pushes the applied values at their backends without touching the file — the startup path, run once the model is built and the store is read.

SetHostApplier

C++
void SetHostApplier(FHostApplier applier)

The runtime host owns the window, so it owns everything the Display category actually changes. Without an applier those rows still record and persist; they simply do not take effect.

SetDisplayOptionProvider

C++
void SetDisplayOptionProvider(FDisplayOptionProvider provider)

SetAppliesArcPalette

C++
void SetAppliesArcPalette(bool applies)

Whether High Contrast UI also swaps Arc's Mowo palette (the colours the settings screen and other built-in menus paint with). Only the game host turns it on: the editor owns that palette through its Appearance preference, and a game setting must never repaint the editor.

AppliesArcPalette

C++
bool AppliesArcPalette() const

ApplyArcPalette

C++
static int32_t ApplyArcPalette(const std::string& vfsPath)

Loads a Mowo palette file (the editor's theme JSON: a "colors" table of token name → "#RRGGBB" or "#RRGGBBAA") over the default colours, or resets to the defaults when the path is empty. Returns the number of colours applied.

RefreshDisplayOptions

C++
void RefreshDisplayOptions()

Refills the choice lists of the Host rows from the provider. Called by BuildModel, and again by the screen when a monitor is hot-plugged.

CategoryLabel

C++
static const char* CategoryLabel(EArcSettingCategory category)
Generated from ArcUI/Settings/FGameUserSettings.h via arcui.json · Nov 4, 2026Version 1.0.0