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()

Sub-functions

ConfirmChanges

ConfirmChanges

ConfirmChanges();

Info & Usage

GetGroup

GetGroup

GetGroup(groupPath : CName) : ref:ConfigGroup;

Info & Usage

GetMenuIndex

GetMenuIndex

GetMenuIndex() : Int32;

Info & Usage

GetRootGroup

GetRootGroup

GetRootGroup() : ref:ConfigGroup;

Info & Usage

GetUserSettingsLoadStatus

GetUserSettingsLoadStatus

GetUserSettingsLoadStatus() : UserSettingsLoadStatus;

Info & Usage

GetVar

GetVar

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

Info & Usage

HasGroup

HasGroup

HasGroup(groupPath : CName) : Bool;

Info & Usage

HasVar

HasVar

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

Info & Usage

NeedsConfirmation

NeedsConfirmation

NeedsConfirmation() : Bool;

Info & Usage

NeedsLoadLastCheckpoint

NeedsLoadLastCheckpoint

NeedsLoadLastCheckpoint() : Bool;

Info & Usage

NeedsRestartToApply

NeedsRestartToApply

NeedsRestartToApply() : Bool;

Info & Usage

RejectChanges

RejectChanges

RejectChanges();

Info & Usage

RequestConfirmationDialog

RequestConfirmationDialog

RequestConfirmationDialog();

Info & Usage

RequestLoadLastCheckpointDialog

RequestLoadLastCheckpointDialog

RequestLoadLastCheckpointDialog();

Info & Usage

RequestNeedsRestartDialog

RequestNeedsRestartDialog

RequestNeedsRestartDialog();

Info & Usage

RequestRestoreDefaultDialog

RequestRestoreDefaultDialog

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

Info & Usage

RestoreVarToDefault

RestoreVarToDefault

RestoreVarToDefault(groupPath : CName, varName : CName);

Info & Usage

SetMenuIndex

SetMenuIndex

SetMenuIndex(index : Int32);

Info & Usage

WasModifiedSinceLastSave

WasModifiedSinceLastSave

WasModifiedSinceLastSave() : Bool;

Info & Usage