UserSettings

Documents the UserSettings class and its functions.

NOT DOCUMENTED We currently don't have information on how these functions work. They are being documented here for visibility.

Invoking UserSettings

To invoke the user settings, use the following Global function:

us = Game.UserSettings()

ConfirmChanges();

GetGroup(groupPath : CName) : ref:ConfigGroup;

GetMenuIndex() : Int32;

GetRootGroup() : ref:ConfigGroup;

GetUserSettingsLoadStatus() : UserSettingsLoadStatus;

GetVar(groupPath : CName, varName : CName) : ref:ConfigVar;

HasGroup(groupPath : CName) : Bool;

HasVar(groupPath : CName, varName : CName) : Bool;

NeedsConfirmation() : Bool;

NeedsLoadLastCheckpoint() : Bool;

NeedsRestartToApply() : Bool;

RejectChanges();

RequestConfirmationDialog();

RequestLoadLastCheckpointDialog();

RequestNeedsRestartDialog();

RequestRestoreDefaultDialog(isPreGame : Bool, onlyVisible : Bool, optional groupPath : CName);

RestoreVarToDefault(groupPath : CName, varName : CName);

SetMenuIndex(index : Int32);

WasModifiedSinceLastSave() : Bool;

Last updated 3 years ago