Basic functionality for any adjustment that can be managed in the "Essentials Settings Window" More...
Public Member Functions | |
| abstract void | Apply () |
| Applies the desired modification. More... | |
| abstract void | Revert () |
| Reverts the modification leaving the state of the platform as it was before applying it. More... | |
| void | OpenInfoURL () |
| Opens the URL containing the information of the modification More... | |
Properties | |
| abstract string | title [get] |
| Title or short definition of the configuration modification More... | |
| virtual string | applyAdjustmentShortExplanation [get] |
| Short explanation of what will be the actions done while applying the modification More... | |
| virtual string | revertAdjustmentShortExplanation [get] |
| Short explanation of what will be the actions done while reverting the modification More... | |
| abstract string | applyButtonText [get] |
| Text displayed on the button to apply the modification More... | |
| abstract string | revertButtonText [get] |
| Text displayed on the button to revert the modification More... | |
| string | infoButtonText [get] |
| Text displayed on the button to get more information about the modification More... | |
| abstract string | infoURL [get] |
| URL where the information regarding the modification can be found More... | |
| virtual bool | showInSettingsWindow [get] |
| If the modification should be displayed or not in the Essentials' settings window More... | |
Detailed Description
Basic functionality for any adjustment that can be managed in the "Essentials Settings Window"
Definition at line 8 of file Adjustment.cs.
Member Function Documentation
◆ Apply()
|
pure virtual |
Applies the desired modification.
Implements Essentials.EssentialsSettings.IAdjustment.
◆ OpenInfoURL()
| void Essentials.EssentialsSettings.Adjustment.OpenInfoURL | ( | ) |
Opens the URL containing the information of the modification
Implements Essentials.EssentialsSettings.IAdjustment.
Definition at line 62 of file Adjustment.cs.
◆ Revert()
|
pure virtual |
Reverts the modification leaving the state of the platform as it was before applying it.
Implements Essentials.EssentialsSettings.IAdjustment.
Property Documentation
◆ applyAdjustmentShortExplanation
|
get |
Short explanation of what will be the actions done while applying the modification
Definition at line 30 of file Adjustment.cs.
◆ applyButtonText
|
get |
Text displayed on the button to apply the modification
Definition at line 39 of file Adjustment.cs.
◆ infoButtonText
|
get |
Text displayed on the button to get more information about the modification
Definition at line 48 of file Adjustment.cs.
◆ infoURL
|
get |
URL where the information regarding the modification can be found
Definition at line 52 of file Adjustment.cs.
◆ revertAdjustmentShortExplanation
|
get |
Short explanation of what will be the actions done while reverting the modification
Definition at line 34 of file Adjustment.cs.
◆ revertButtonText
|
get |
Text displayed on the button to revert the modification
Definition at line 43 of file Adjustment.cs.
◆ showInSettingsWindow
|
get |
If the modification should be displayed or not in the Essentials' settings window
Definition at line 57 of file Adjustment.cs.
◆ title
|
get |
Title or short definition of the configuration modification
Definition at line 14 of file Adjustment.cs.
The documentation for this class was generated from the following file:
