struct
FArcGameSettingDef
What a game hands FGameUserSettings::RegisterRow to put a row on the player's settings screen: an id, a label, a type, a default, where the value goes (a console variable or a callback), when it is available and what the quality preset sets it to. Persistence, the revert countdown and the save location are the existing screen's.
- Module
- ArcUI
- Header
#include "ArcUI/Settings/FGameUserSettings.h"- Namespace
Mowo
Properties
| Type | Name | Description |
|---|---|---|
std::string | Id | The persisted key. With a CvarName the row is that cvar's row and the id is still what the file stores it under, so renaming the cvar later does not orphan a player's choice. |
std::string | Label | |
std::string | Description | |
std::string | Suffix | |
EArcSettingCategory | Category | Default EArcSettingCategory::Gameplay. |
std::string | Page | A page of the game's own (its name is the rail label). Empty = the category. |
EArcSettingValue | ValueType | Default EArcSettingValue::Bool. |
EArcSettingControl | Control | Default EArcSettingControl::Toggle. |
std::vector<FArcSettingChoice> | Choices | |
float | MinValue | Default 0.0f. |
float | MaxValue | Default 1.0f. |
float | Step | Default 0.01f. |
std::string | DefaultValue | |
std::string | CvarName | The console variable the value is read from at start and written to on Apply. Empty = a pure callback row. |
std::function<void(const std::string& value, bool persist)> | OnApply | |
std::function<bool()> | Requirement | Availability. A false Requirement greys the row and prints the reason in place of the description (or removes it, with HideWhenUnavailable). The check runs when the model is built and on RefreshRequirements(). |
std::string | RequirementReason | |
bool | HideWhenUnavailable | Default false. |
std::vector<std::string> | TierValues | |
bool | NeedsRestart | Default false. |
bool | NeedsConfirmation | Default false. |
Generated from ArcUI/Settings/FGameUserSettings.h via arcui.json · Nov 4, 2026Version 1.0.0