indicate settings that need a mission restart (#894)

* setting state new icons, color * disable debug mode * add and implement needRestart flag * add tooltip * don't highlight as needing restart while edited in 3den
CBATeam · Jul 26, 2018 · 4fcb330 · 4fcb330
1 parent d6afdf6
commit 4fcb330
Show file tree

Hide file tree

Showing 12 changed files with 59 additions and 13 deletions.
diff --git a/addons/settings/applies_ca.paa b/addons/settings/applies_ca.paa
diff --git a/addons/settings/fnc_gui_saveTempData.sqf b/addons/settings/fnc_gui_saveTempData.sqf
@@ -36,3 +36,6 @@ Author:
         };
     } forEach ["client", "mission", "server"];
 } forEach GVAR(allSettings);
+
+GVAR(awaitingRestart) = GVAR(awaitingRestartTemp);
+nil
diff --git a/addons/settings/fnc_gui_settingOverwrite.sqf b/addons/settings/fnc_gui_settingOverwrite.sqf
@@ -113,30 +113,48 @@ _controlsGroup setVariable [QFUNC(updateUI_locked), {
         private _ctrlLocked = _x controlsGroupCtrl IDC_SETTING_LOCKED;
 
         if (_source isEqualTo _priority) then {
-            _ctrlLocked ctrlSetText "";
-            _ctrlLocked ctrlSetTooltip "";
+            if (toLower _setting in GVAR(awaitingRestartTemp)) then {
+                _ctrlLocked ctrlSetText ICON_NEED_RESTART;
+                _ctrlLocked ctrlSetTextColor COLOR_NEED_RESTART;
+                _ctrlLocked ctrlSetTooltip LLSTRING(need_restart);
+            } else {
+                _ctrlLocked ctrlSetText ICON_APPLIES;
+                _ctrlLocked ctrlSetTextColor COLOR_APPLIES;
+                _ctrlLocked ctrlSetTooltip LLSTRING(applies);
+            };
         } else {
             switch [_source, _priority] do {
                 case ["client", "server"];
                 case ["mission", "server"]: {
-                    _ctrlLocked ctrlSetText QPATHTOF(locked_ca.paa);
+                    _ctrlLocked ctrlSetText ICON_OVERWRITTEN;
+                    _ctrlLocked ctrlSetTextColor COLOR_OVERWRITTEN;
                     _ctrlLocked ctrlSetTooltip LLSTRING(overwritten_by_server_tooltip);
                 };
                 case ["client", "mission"];
                 case ["server", "mission"]: {
-                    _ctrlLocked ctrlSetText QPATHTOF(locked_ca.paa);
+                    _ctrlLocked ctrlSetText ICON_OVERWRITTEN;
+                    _ctrlLocked ctrlSetTextColor COLOR_OVERWRITTEN;
                     _ctrlLocked ctrlSetTooltip LLSTRING(overwritten_by_mission_tooltip);
                 };
                 case ["mission", "client"]: {
-                    _ctrlLocked ctrlSetText QPATHTOF(locked_ca.paa);
+                    _ctrlLocked ctrlSetText ICON_OVERWRITTEN;
+                    _ctrlLocked ctrlSetTextColor COLOR_OVERWRITTEN;
                     _ctrlLocked ctrlSetTooltip LLSTRING(overwritten_by_client_tooltip);
                 };
                 case ["server", "client"]: {
                     if (isServer) then {
-                        _ctrlLocked ctrlSetText "";
-                        _ctrlLocked ctrlSetTooltip "";
+                        if (toLower _setting in GVAR(awaitingRestartTemp)) then {
+                            _ctrlLocked ctrlSetText ICON_NEED_RESTART;
+                            _ctrlLocked ctrlSetTextColor COLOR_NEED_RESTART;
+                            _ctrlLocked ctrlSetTooltip LLSTRING(need_restart);
+                        } else {
+                            _ctrlLocked ctrlSetText ICON_APPLIES;
+                            _ctrlLocked ctrlSetTextColor COLOR_APPLIES;
+                            _ctrlLocked ctrlSetTooltip LLSTRING(applies);
+                        };
                     } else {
-                        _ctrlLocked ctrlSetText QPATHTOF(locked_ca.paa);
+                        _ctrlLocked ctrlSetText ICON_OVERWRITTEN;
+                        _ctrlLocked ctrlSetTextColor COLOR_OVERWRITTEN;
                         _ctrlLocked ctrlSetTooltip LLSTRING(overwritten_by_client_tooltip_server);
                     };
                 };

diff --git a/addons/settings/fnc_init.sqf b/addons/settings/fnc_init.sqf
@@ -13,6 +13,7 @@ Parameters:
     _valueInfo   - Extra properties of the setting depending of _settingType. See examples below <ANY>
     _isGlobal    - 1: all clients share the same setting, 2: setting can't be overwritten (optional, default: 0) <ARRAY>
     _script      - Script to execute when setting is changed. (optional) <CODE>
+    _needRestart - Setting will be marked as needing mission restart after being changed. (optional, default false) <BOOL>
 
 Returns:
     _return - Error code <NUMBER>
@@ -56,7 +57,8 @@ params [
     ["_categoryArg", "", ["", []]],
     ["_valueInfo", []],
     ["_isGlobal", false, [false, 0]],
-    ["_script", {}, [{}]]
+    ["_script", {}, [{}]],
+    ["_needRestart", false, [false]]
 ];
 
 if (_setting isEqualTo "") exitWith {
@@ -205,4 +207,8 @@ if (isServer) then {
     [QGVAR(refreshSetting), _setting] call CBA_fnc_localEvent;
 };
 
+if (_needRestart) then {
+    GVAR(needRestart) pushBackUnique toLower _setting;
+};
+
 0
diff --git a/addons/settings/fnc_initDisplayGameOptions.sqf b/addons/settings/fnc_initDisplayGameOptions.sqf
@@ -65,6 +65,8 @@ with uiNamespace do {
     GVAR(serverTemp)  = _display ctrlCreate ["RscText", -1];
 };
 
+GVAR(awaitingRestartTemp) = + GVAR(awaitingRestart);
+
 // ----- create addons list (filled later)
 private _ctrlAddonList = _display ctrlCreate [QGVAR(AddonsList), -1, _ctrlAddonsGroup];
 

diff --git a/addons/settings/gui.hpp b/addons/settings/gui.hpp
@@ -229,8 +229,6 @@ class GVAR(Row_Base): RscControlsGroupNoScrollbars {
         };
         class Locked: RscPicture {
             idc = IDC_SETTING_LOCKED;
-            text = QPATHTOF(locked_ca.paa);
-            colorText[] = {1,0,0,1};
             x = POS_W(28);
             y = POS_H(0) + TABLE_LINE_SPACING/2;
             w = POS_W(1);

diff --git a/addons/settings/initSettings.sqf b/addons/settings/initSettings.sqf
@@ -59,4 +59,7 @@ if (isNil QGVAR(default)) then {
 
         GVAR(missionConfig) setVariable [_setting, [_value, _priority]];
     } forEach ([_missionConfig, false] call FUNC(parse));
+
+    GVAR(needRestart) = [];
+    GVAR(awaitingRestart) = [];
 };
diff --git a/addons/settings/locked_ca.paa b/addons/settings/locked_ca.paa
diff --git a/addons/settings/need_restart_ca.paa b/addons/settings/need_restart_ca.paa
diff --git a/addons/settings/overwritten_ca.paa b/addons/settings/overwritten_ca.paa
diff --git a/addons/settings/script_component.hpp b/addons/settings/script_component.hpp
@@ -93,6 +93,13 @@
 #define COLOR_BUTTON_DISABLED [0, 0, 0, 1]
 
 #define ICON_DEFAULT "\a3\3den\Data\Displays\Display3DEN\ToolBar\undo_ca.paa"
+#define ICON_APPLIES QPATHTOF(applies_ca.paa)
+#define ICON_OVERWRITTEN QPATHTOF(overwritten_ca.paa)
+#define ICON_NEED_RESTART QPATHTOF(need_restart_ca.paa)
+
+#define COLOR_APPLIES [0, 0.95, 0, 1]
+#define COLOR_OVERWRITTEN [0.95, 0, 0, 1]
+#define COLOR_NEED_RESTART [0.95, 0.95, 0, 1]
 
 #define CAN_SET_SERVER_SETTINGS ((isServer || FUNC(whitelisted)) && {!isNull GVAR(server)}) // in single player, as host (local server) or as logged in (not voted) admin connected to a dedicated server
 #define CAN_SET_CLIENT_SETTINGS !isServer // in multiplayer as dedicated client
@@ -109,8 +116,9 @@
 #define GET_TEMP_NAMESPACE_VALUE(setting,source)    (GET_TEMP_NAMESPACE(source) getVariable [setting, [nil, nil]] select 0)
 #define GET_TEMP_NAMESPACE_PRIORITY(setting,source) (GET_TEMP_NAMESPACE(source) getVariable [setting, [nil, nil]] select 1)
 
-#define SET_TEMP_NAMESPACE_VALUE(setting,value,source)       (GET_TEMP_NAMESPACE(source) setVariable [setting, [value, GET_TEMP_NAMESPACE_PRIORITY(setting,source)]])
-#define SET_TEMP_NAMESPACE_PRIORITY(setting,priority,source) (GET_TEMP_NAMESPACE(source) setVariable [setting, [GET_TEMP_NAMESPACE_VALUE(setting,source), priority]])
+#define SET_TEMP_NAMESPACE_AWAITING_RESTART(setting) if (toLower setting in GVAR(needRestart) && {!is3den}) then {GVAR(awaitingRestartTemp) pushBackUnique toLower setting}
+#define SET_TEMP_NAMESPACE_VALUE(setting,value,source)       GET_TEMP_NAMESPACE(source) setVariable [setting, [value, GET_TEMP_NAMESPACE_PRIORITY(setting,source)]]; SET_TEMP_NAMESPACE_AWAITING_RESTART(setting)
+#define SET_TEMP_NAMESPACE_PRIORITY(setting,priority,source) GET_TEMP_NAMESPACE(source) setVariable [setting, [GET_TEMP_NAMESPACE_VALUE(setting,source), priority]]; SET_TEMP_NAMESPACE_AWAITING_RESTART(setting)
 
 #define TEMP_PRIORITY(setting) (call {private _arr = [\
     (uiNamespace getVariable QGVAR(clientTemp))  getVariable [setting, [nil, [setting,  "client"] call FUNC(priority)]] select 1,\

diff --git a/addons/settings/stringtable.xml b/addons/settings/stringtable.xml
@@ -250,6 +250,14 @@
             <French>Overwrite\nServer</French>
             <Polish>Nadpisz\nSerwer</Polish>
         </Key>
+        <Key ID="STR_cba_settings_applies">
+            <English>This setting applies.</English>
+            <German>Diese Einstellung gilt.</German>
+        </Key>
+        <Key ID="STR_cba_settings_need_restart">
+            <English>This setting applies after the next mission restart.</English>
+            <German>Diese Einstellung gilt nach dem nächsten Neustart der Mission.</German>
+        </Key>
         <Key ID="STR_cba_settings_overwritten_by_client_tooltip">
             <English>This setting is overwritten by the clients.</English>
             <German>Diese Einstellung wird von den Clients überschrieben.</German>