diff --git a/documentation/framework/settings-framework.md b/documentation/framework/settings-framework.md index 107e9378bf..b809e19a61 100644 --- a/documentation/framework/settings-framework.md +++ b/documentation/framework/settings-framework.md @@ -17,20 +17,22 @@ 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_module_sampleSetting { - // Following 2 entries are redundant if isClientSettable = 0 - displayName = "$STR_ACE_Common_SettingName"; // Stringtable entry with the setting name - description = "$STR_ACE_Common_SettingDescription"; // Stringtable entry with the setting description +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 + description = "$STR_ACE_Common_SettingDescription"; // Stringtable entry with the setting description - isClientSettable = 1; // Show in client options menu (0-no, 1-yes) - typeName = "SCALAR"; // Type (BOOL/SCALAR/STRING/ARRAY/COLOR) - value = 1; // Value + isClientSettable = 1; // Show in client options menu (0-no, 1-yes) + typeName = "SCALAR"; // Type (BOOL/SCALAR/STRING/ARRAY/COLOR) + value = 1; // Value - // Following entry is redundant if typeName is NOT "SCALAR" - values[] = {"Disabled", "Enabled", "Only Cursor", "Only On Keypress", "Only Cursor and KeyPress"}; // (Optional) Stringtable entries that describe the options + // Following entry is redundant if typeName is NOT "SCALAR" + values[] = {"Disabled", "Enabled", "Only Cursor", "Only On Keypress", "Only Cursor and KeyPress"}; // (Optional) Stringtable entries that describe the options - // Following entry is present only in export - force = 0; // Force the setting (0-no, 1-yes), exported settings are forced by default + // Following entry is present only in export + force = 0; // Force the setting (0-no, 1-yes), exported settings are forced by default + }; }; ``` @@ -82,17 +84,19 @@ 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` - ```c++ - //^^ rest of your description.ext - //------------------------- ACE settings + +Example of `ACE_common_forceAllSettings`: +```c++ +class ACE_Settings { class ACE_common_forceAllSettings { value = 1; typeName = "BOOL"; }; - ``` +}; +``` + ### 3.2 Loading up the server config diff --git a/documentation/user/how-to-report-an-issue.md b/documentation/user/how-to-report-an-issue.md index 4960baa3af..5c6ed78997 100644 --- a/documentation/user/how-to-report-an-issue.md +++ b/documentation/user/how-to-report-an-issue.md @@ -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> @@ -24,29 +24,29 @@ Indicate if the issue appears on stable or development version. In case it is th Head over to the <a href="{{ site.githubUrl }}/issues" target="_blank">ACE3 GitHub issue tracker</a> and press the <a href="{{ site.githubUrl }}/issues/new" target="_blank">"New issue"</a> button in the top right corner. Add a descriptive title and copy the following issue template in to the text area: ``` -*PRO-TIP :The english language allows individuals to correct each other's mistakes in a respectful manner.* +*PRO-TIP: The english language allows individuals to correct each other's mistakes in a respectful manner.* 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.* **Description:** -*Add a detailed description of the error. This makes it easier for us to fix the issue.* +* Add a detailed description of the error. This makes it easier for us to fix the issue.* **Steps to reproduce:** * *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.* +* Add a link (pastebin.com) to the client or server RPT file.* ``` A video of the issue might be helpful in resolving it faster.