Arma3_Epoch/ACE3
1
0
Fork 0
mirror of https://github.com/acemod/ACE3.git synced 2024-08-30 18:23:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix settings.md formatting

Browse Source
This commit is contained in:
bux578 2015-05-18 09:56:42 +02:00
parent f121cc9ea9
commit 9db69add69
1 changed files with 32 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
documentation/framework/settings.md
View File

@ -16,40 +16,42 @@ Part of this settings framework are global settings and client settings. Both us
Settings are entries in the config that get translated to `missionnamespace` global variables. An example settings entry looks like this:
```
class ACE_module_sampleSetting {
// Value
value = 1;
// Type (SCALAR, BOOL, STRING, ARRAY, COLOR)
typeName = "SCALAR";
// Force the setting?
force = 0;
// Does it appear on the options menu?
isClientSettable = 1;
// The following settings only apply when isClientSettable == 1
// Stringtable entry with the setting name
displayName = "$STR_ACE_Common_SettingName";
// Stringtable entry with the setting description
description = "$STR_ACE_Common_SettingDescription";
// Stringtable entries that describe the options
// Only applies if typeName == "SCALAR"; and is optional
values[] = {"Disabled", "Enabled", "Only Cursor", "Only On Keypress", "Only Cursor and KeyPress"};
};
```c++
class ACE_module_sampleSetting {
// Value
value = 1;
// Type (SCALAR, BOOL, STRING, ARRAY, COLOR)
typeName = "SCALAR";
// Force the setting?
force = 0;
// Does it appear on the options menu?
isClientSettable = 1;
// The following settings only apply when isClientSettable == 1
// Stringtable entry with the setting name
displayName = "$STR_ACE_Common_SettingName";
// Stringtable entry with the setting description
description = "$STR_ACE_Common_SettingDescription";
// Stringtable entries that describe the options
// Only applies if typeName == "SCALAR"; and is optional
values[] = {"Disabled", "Enabled", "Only Cursor", "Only On Keypress", "Only Cursor and KeyPress"};
};
```
Settings are defined from the mods config but can be adjusted through the following methods:
* Optional config entries
* Mission side modules
## 2. Load order
The load order for the settings are:
* 1. Mod Config
* 2. Server Config
* 3. Mission config
@ -59,18 +61,18 @@ What this means is that at any the 3 points after the mod config it is possible
## 3. How do I use them?
In the 'how do they work' chapter an example of settings was shown. This is the same for any settings config. The only difference is the location. For ACE modules, the settings are placed in the class `ACE_settings`. The same goes for the mission config.
In the 'how do they work' chapter an example of settings was shown. This is the same for any settings config. The only difference is the location. For ACE3 modules, the settings are placed in the class `ACE_settings`. The same goes for the mission config.
The server config setting entries are done through our optional ACE_server.pbo, which can be found in the optionals folder of @ace. It also contains a userconfig folder, which inside contains the file ace\serverconfig.hpp. This is the location ACE settings are placed. There is no need for a sub class.
The server config setting entries are done through our optional ACE_server.pbo, which can be found in the optionals folder of @ace. It also contains a userconfig folder, which inside contains the file ace\serverconfig.hpp. This is the location ACE3 settings are placed. There is no need for a sub class.
### 3.1 Getting all the settings!
ACE contains a lot of settings; to tweak everything to your liking manually therefor can be quite a task. We have provided the option to export all settings in single player. For this, follow these simple steps:
ACE3 contains a lot of settings; to tweak everything to your liking manually therefor can be quite a task. We have provided the option to export all settings in single player. For this, follow these simple steps:
* Open the editor (Singleplayer).
* Under modules (f7), find ACE, `Config Export [ACE]`.
* Under modules (<kbd>F7</kbd>), find ACE, `Config Export [ACE]`.
* Place down the module, ensure that the allow parameter is set to yes.
* Press preview, once in game, press Esc and open the ACE Options dialog (top left)
* Press preview, once in game, press Esc and open the ACE3 Options dialog (top left)
* This is the dialog where you can modify client side settings. On the bottom left of it, you will now see a button called 'Config Export'. Press it and a new dialog opens.
* You are now in the dialog that allows you to adjust all settings from ACE. Tweak this to your liking.
* Once you are done tweaking, press the 'Export' button and all settings will be copied to your clipboard.