Updated settings-fraemwork and how-to-report-an-issue

This commit is contained in:
jonpas
2015-08-25 04:05:43 +02:00
parent 1019450c30
commit 1048562a42
2 changed files with 30 additions and 26 deletions

View File

@ -17,6 +17,7 @@ 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:
```c++
class ACE_Settings {
class ACE_module_sampleSetting {
// Following 2 entries are redundant if isClientSettable = 0
displayName = "$STR_ACE_Common_SettingName"; // Stringtable entry with the setting name
@ -32,6 +33,7 @@ class ACE_module_sampleSetting {
// Following entry is present only in export
force = 0; // Force the setting (0-no, 1-yes), exported settings are forced by default
};
};
```
Settings are defined from the mod's config but can be adjusted through the following methods:
@ -82,18 +84,20 @@ class ACE_Settings {
#### 3.1.1 Notes
- If a setting is forced it cannot be changed further down the line, see `2. Load order` for the hierarchy.
- Client settings can be forced, include them while exporting (the button is right next to export on the UI)
- Client settings can be forced, include while exporting (the button is next to export on the UI)
- You can use `ACE_common_forceAllSettings` to force settings in a mission, it will lock **all** the settings (which are not already forced) to the values they are set in either modules or server config
- example of `ACE_common_forceAllSettings`
Example of `ACE_common_forceAllSettings`:
```c++
//^^ rest of your description.ext
//------------------------- ACE settings
class ACE_Settings {
class ACE_common_forceAllSettings {
value = 1;
typeName = "BOOL";
};
};
```
### 3.2 Loading up the server config
As stated before, the server config gets loaded through the optional `ace_server.pbo`. This PBO is only required (and should only be used) on the server - clients do not need to have this! It is for this reason we have not signed this PBO.

View File

@ -1,7 +1,7 @@
---
layout: wiki
title: How to report an issue
description: If you've found an issue with ACE3 please read this entry before reporting it.
description: If you have found an issue with ACE3 please read this entry before reporting it.
group: user
order: 10
parent: wiki
@ -9,13 +9,13 @@ parent: wiki
### Before reporting
If you've found an issue with ACE3 please make sure that ACE3 is really the cause of the problem. To do this try to reproduce the issue with using only `@cba_a3` and `@ACE3` on a newly created mission.
If you have found an issue with ACE3 please make sure that ACE3 is really the cause of the problem. To do this try to reproduce the issue with using only `@CBA_A3` and `@ace` on a newly created mission.
Indicate if the issue appears on stable or development version. In case it is the development version, please also include the commit SHA-1 hash.
<div class="panel callout">
<h5>Please note:</h5>
<p>It's not a valid to simply remove <code>@ACE3</code> from the mod list to confirm that ACE3 is the culprit.</p>
<p>It's not a valid to simply remove <code>@ace</code> from the mod list to confirm that ACE3 is the culprit.</p>
<p>If the error happens when using a <b>third-party mod</b> contact the author of the appropriate mod and report the issue there.</p>
</div>
@ -30,8 +30,8 @@ ACE3 Version: 3.x.x
(indicate if stable or dev, if dev indicate the commit the version is based on)
**Mods:**
* @cba_a3
* @ace3
* `@CBA_A3`
* `@ace`
**Placed ACE3 Modules:**
* *Add the list of modules you have placed on the map. Use 'None' if the error occurs without using any modules.*
@ -43,7 +43,7 @@ ACE3 Version: 3.x.x
* *Add the steps needed to reproduce the issue.*
**Where did the issue occur?**
*A possible answer might be "Multiplayer", "Singleplayer"*
* A possible answer might be "Multiplayer" or "Singleplayer" or "Editor"*
**RPT log file:**
* Add a link (pastebin.com) to the client or server RPT file.*