Class: COptionsManager
Main-menu options manager binding.
Source
C++ class COptionsManager
Custom Constructor
COptionsManager
Remarks
Operates on option item groups registered by the options UI.
Constructors
Constructor
ts
new COptionsManager(): COptionsManager;Create an options manager script proxy.
Returns
COptionsManager
Methods
NeedSystemRestart()
ts
NeedSystemRestart(): boolean;Check whether accepted options require a system restart.
Returns
boolean
Whether a system restart is needed.
NeedVidRestart()
ts
NeedVidRestart(): boolean;Check whether accepted options require a video restart.
Returns
boolean
Whether a video restart is needed.
OptionsPostAccept()
ts
OptionsPostAccept(): void;Run post-accept handling after options are saved.
Returns
void
SaveBackupValues()
ts
SaveBackupValues(group: string): void;Save current option values as the backup for a group.
Parameters
| Parameter | Type | Description |
|---|---|---|
group | string | Options group name. |
Returns
void
SaveValues()
ts
SaveValues(group: string): void;Persist current option values for a group.
Parameters
| Parameter | Type | Description |
|---|---|---|
group | string | Options group name. |
Returns
void
SendMessage2Group()
ts
SendMessage2Group(group: string, message: string): void;Send a UI options message to every option item in a group.
Parameters
| Parameter | Type | Description |
|---|---|---|
group | string | Options group name. |
message | string | Message name. |
Returns
void
SetCurrentValues()
ts
SetCurrentValues(group: string): void;Apply current engine option values to controls in a group.
Parameters
| Parameter | Type | Description |
|---|---|---|
group | string | Options group name. |
Returns
void
UndoGroup()
ts
UndoGroup(group: string): void;Restore options in a group from their backup values.
Parameters
| Parameter | Type | Description |
|---|---|---|
group | string | Options group name. |
Returns
void