Arsenal - Favorites System

addons/arsenal/XEH_PREP.hpp

@@ -21,6 +21,7 @@ PREP(buttonActionsPage);
 PREP(buttonCargo);
 PREP(buttonClearAll);
 PREP(buttonExport);
+PREP(buttonFavorites);
 PREP(buttonHide);
 PREP(buttonImport);
 PREP(buttonLoadoutsDelete);
@@ -55,6 +56,7 @@ PREP(onLoadoutsClose);
 PREP(onLoadoutsOpen);
 PREP(onMouseButtonDown);
 PREP(onMouseButtonUp);
+PREP(onPanelDblClick);
 PREP(onSelChangedLeft);
 PREP(onSelChangedLoadouts);
 PREP(onSelChangedRight);

addons/arsenal/defines.hpp

@@ -5,7 +5,7 @@
 
 #define WIDTH_TOTAL (safezoneW - 2 * (93 * GRID_W))
 #define WIDTH_GAP (WIDTH_TOTAL / 100)
-#define WIDTH_SINGLE ((WIDTH_TOTAL - 6 * WIDTH_GAP) / 5)
+#define WIDTH_SINGLE ((WIDTH_TOTAL - 7 * WIDTH_GAP) / 6)
 
 // IDDs
 #define IDD_MISSION 46
@@ -19,6 +19,9 @@
 #define ASCENDING 0
 #define DESCENDING 1
 
+// Favorites
+#define FAVORITES_COLOR (GVAR(favoritesColor) + [1])
+
 // IDCs
 #define IDD_ace_arsenal 1127001
 #define IDC_mouseArea 0
@@ -39,6 +42,7 @@
 #define IDC_buttonLoadouts 1003
 #define IDC_buttonExport 1004
 #define IDC_buttonImport 1005
+#define IDC_buttonFavorites 1006
 #define IDC_infoBox 11
 #define IDC_infoBackground 1101
 #define IDC_infoName 1102

addons/arsenal/functions/fnc_addListBoxItem.sqf

@@ -1,4 +1,5 @@
 #include "script_component.hpp"
+#include "..\defines.hpp"
 /*
  * Author: Dedmen, johnb43
  * Add a listbox row.
@@ -20,6 +21,26 @@
 
 params ["_configCategory", "_className", "_ctrlPanel", ["_pictureEntryName", "picture", [""]]];
 
+private _skip = GVAR(favoritesOnly) && {!(_className in GVAR(currentItems))} && {!((toLower _className) in GVAR(favorites))};
+if (_skip) then {
+    switch (GVAR(currentLeftPanel)) do {
+        case IDC_buttonPrimaryWeapon: {
+            _skip = !(_className in (GVAR(currentItems) select IDX_CURR_PRIMARY_WEAPON_ITEMS));
+        };
+        case IDC_buttonHandgun: {
+            _skip = !(_className in (GVAR(currentItems) select IDX_CURR_HANDGUN_WEAPON_ITEMS));
+        };
+        case IDC_buttonSecondaryWeapon: {
+            _skip = !(_className in (GVAR(currentItems) select IDX_CURR_PRIMARY_WEAPON_ITEMS));
+        };
+        case IDC_buttonBinoculars: {
+            _skip = !(_className in (GVAR(currentItems) select IDX_CURR_BINO_ITEMS));
+        };
+    };
+};
+
+if (_skip) exitWith {};
+
 // Sanitise key, as it's public; If not in cache, find info and cache it for later use
 ((uiNamespace getVariable QGVAR(addListBoxItemCache)) getOrDefaultCall [_configCategory + _className, {
     // Get classname (config case), display name, picture and DLC
@@ -35,3 +56,8 @@ _ctrlPanel lbSetData [_lbAdd, _className];
 _ctrlPanel lbSetPicture [_lbAdd, _itemPicture];
 _ctrlPanel lbSetPictureRight [_lbAdd, ["", _modPicture] select GVAR(enableModIcons)];
 _ctrlPanel lbSetTooltip [_lbAdd, format ["%1\n%2", _displayName, _className]];
+
+if ((toLower _className) in GVAR(favorites)) then {
+    _ctrlPanel lbSetColor [_lbAdd, FAVORITES_COLOR];
+    _ctrlPanel lbSetSelectColor [_lbAdd, FAVORITES_COLOR];
+};

addons/arsenal/functions/fnc_buttonFavorites.sqf

@@ -0,0 +1,32 @@
+#include "script_component.hpp"
+#include "..\defines.hpp"
+/*
+ * Author: LinkIsGrim
+ * Switches the arsenal between displaying all items and favorites
+ *
+ * Arguments:
+ * 0: Arsenal display <DISPLAY>
+ * 1: Button control <CONTROL>
+ *
+ * Return Value:
+ * None
+ *
+ * Public: No
+*/
+
+params ["_display", "_control"];
+
+private _firstRun = false;
+
+if (isNil QGVAR(favoritesOnly)) then {
+    GVAR(favoritesOnly) = GVAR(defaultToFavorites);
+    _firstRun = true;
+} else {
+    GVAR(favoritesOnly) = !GVAR(favoritesOnly);
+};
+
+_control ctrlSetText format ["%1: %2", localize "STR_GEAR_ITEMS", localize (["str_word_all", "STR_3DEN_Favorite_textPlural"] select GVAR(favoritesOnly))];
+
+if (_firstRun) exitWith {};
+
+[false] call FUNC(refresh);

addons/arsenal/functions/fnc_buttonImport.sqf

@@ -51,7 +51,7 @@ if (GVAR(shiftState) && {is3DEN}) then {
         [GVAR(center), _extendedLoadout] call CBA_fnc_setLoadout;
 
         // Update current item list and unique items
-        call FUNC(refresh);
+        [true] call FUNC(refresh);
 
         _extendedLoadout params ["_loadout", "_extendedInfo"];
 

addons/arsenal/functions/fnc_buttonLoadoutsLoad.sqf

@@ -38,7 +38,7 @@ private _extendedLoadout = switch (GVAR(currentLoadoutsTab)) do {
 [GVAR(center), _extendedLoadout, true] call CBA_fnc_setLoadout;
 
 // Update current item list and unique items
-call FUNC(refresh);
+[true] call FUNC(refresh);
 
 _extendedLoadout params ["_loadout", "_extendedInfo"];
 

addons/arsenal/functions/fnc_fillRightPanel.sqf

@@ -43,9 +43,13 @@ private _cfgMagazines = configFile >> "CfgMagazines";
 private _cfgWeapons = configFile >> "CfgWeapons";
 private _rightPanelCache = uiNamespace getVariable QGVAR(rightPanelCache);
 
+private _currentCargo = itemsWithMagazines GVAR(center);
+
 private _fnc_fillRightContainer = {
     params ["_configCategory", "_className", "_hasItemInfo", ["_isUnique", false, [false]], ["_unknownOrigin", false, [false]]];
 
+    if (GVAR(favoritesOnly) && {!(_className in _currentCargo)} && {!((toLower _className) in GVAR(favorites))}) exitWith {};
+
     // If item is not in the arsenal, it must be unique
     if (!_isUnique && {!(_className in GVAR(virtualItemsFlat))}) then {
         _isUnique = true;
@@ -94,11 +98,16 @@ private _fnc_fillRightContainer = {
     }, true]) params ["_displayName", "_picture", "_mass"];
 
     private _lbAdd = _ctrlPanel lnbAddRow ["", _displayName, "0"];
+    _ctrlPanel lnbSetText [[_lbAdd, 1], _displayName];
     _ctrlPanel lnbSetData [[_lbAdd, 0], _className];
     _ctrlPanel lnbSetPicture [[_lbAdd, 0], _picture];
     _ctrlPanel lnbSetValue [[_lbAdd, 0], _mass];
     _ctrlPanel lnbSetValue [[_lbAdd, 2], [0, 1] select _isUnique];
     _ctrlPanel lnbSetTooltip [[_lbAdd, 0], format ["%1\n%2", _displayName, _className]];
+    if ((toLower _className) in GVAR(favorites)) then {
+        _ctrlPanel lnbSetColor [[_lbAdd, 1], FAVORITES_COLOR];
+        _ctrlPanel lnbSetColorRight [[_lbAdd, 1], FAVORITES_COLOR];
+    };
 };
 
 private _ctrlPanel = _display displayCtrl IDC_rightTabContent;

addons/arsenal/functions/fnc_handleActions.sqf

@@ -94,10 +94,9 @@ _actionsCurrentPageCtrl ctrlCommit 0;
         case ACTION_TYPE_BUTTON: {
             _actionButtonCtrl ctrlRemoveAllEventHandlers "ButtonClick";
             _actionButtonCtrl ctrlAddEventHandler ["ButtonClick", {
-                if (is3DEN) exitWith {call FUNC(refresh)};
-
+                if (is3DEN) exitWith {[true] call FUNC(refresh)};
                 [{
-                    call FUNC(refresh);
+                    [true] call FUNC(refresh);
                 }] call CBA_fnc_execNextFrame;
             }];
             _actionButtonCtrl ctrlAddEventHandler ["ButtonClick", _statement];

addons/arsenal/functions/fnc_onArsenalClose.sqf

@@ -127,6 +127,10 @@ GVAR(statsInfo) =  nil;
 GVAR(showActions) = nil;
 GVAR(currentActionPage) = nil;
 
+profileNamespace setVariable [QGVAR(favorites), GVAR(favorites)];
+GVAR(favoritesOnly) = nil;
+GVAR(favorites) = nil;
+
 GVAR(center) = nil;
 GVAR(centerNotPlayer) = nil;
 

addons/arsenal/functions/fnc_onArsenalOpen.sqf

@@ -95,6 +95,10 @@ GVAR(currentActionPage) = 0;
 // Update current item list
 call FUNC(updateCurrentItemsList);
 
+// Setup favorites button text and switch to default mode defined by setting
+[_display, _display displayCtrl IDC_buttonFavorites] call FUNC(buttonFavorites);
+GVAR(favorites) = profileNamespace getVariable [QGVAR(favorites), createHashMap];
+
 // This takes care of unique inventory items and unique equipment (arsenal doesn't have items/equipment whitelisted)
 call FUNC(updateUniqueItemsList);
 

addons/arsenal/functions/fnc_onPanelDblClick.sqf

@@ -0,0 +1,50 @@
+#include "script_component.hpp"
+#include "..\defines.hpp"
+#include "\a3\ui_f\hpp\defineResincl.inc"
+/*
+ * Author: LinkIsGrim
+ * Add or remove item(s) to favorites when LShift is pressed
+ *
+ * Arguments:
+ * 0: Left panel control <CONTROL>
+ * 1: Left panel selection <NUMBER>
+ *
+ * Return Value:
+ * None
+ *
+ * Public: No
+*/
+params ["_control", "_curSel"];
+
+if !(GVAR(shiftState)) exitWith {};
+
+if (GVAR(currentLeftPanel) in [IDC_buttonFace, IDC_buttonVoice, IDC_buttonInsigina]) exitWith {};
+
+private _isLnB = (ctrlType _control) == CT_LISTNBOX;
+
+private _favorited = false;
+
+// Favorites/blacklist will always be lowercase to handle configCase changes
+private _item = "";
+if (_isLnB) then {
+    _item = toLower (_control lnbData [_curSel, 0]);
+} else {
+    _item = toLower (_control lbData _curSel);
+};
+
+if (_item in GVAR(favorites)) then {
+    GVAR(favorites) deleteAt _item;
+} else {
+    GVAR(favorites) set [_item, nil];
+    _favorited = true;
+};
+
+private _color = ([[1, 1, 1], GVAR(favoritesColor)] select _favorited) + [1];
+
+if (_isLnB) then {
+    _control lnbSetColor [[_curSel, 1], _color];
+    _control lnbSetColorRight [[_curSel, 1], _color];
+} else {
+    _control lbSetColor [_curSel, _color];
+    _control lbSetSelectColor [_curSel, _color];
+};

addons/arsenal/functions/fnc_refresh.sqf

@@ -4,17 +4,26 @@
  * Author: Brett Mayson, johnb43
  * Refreshes the arsenal to show external changes.
  *
+ * Arguments:
+ * 0: Update current and unique items lists <BOOL> (default: true)
+ *
  * Return Value:
  * None
  *
- * Public: No
+ * Example:
+ * call ace_arsenal_fnc_refresh
+ *
+ * Public: Yes
 */
+params [["_updateItems", true, [true]]];
 
-// Update current item list
-call FUNC(updateCurrentItemsList);
+if (_updateItems) then {
+    // Update current item list
+    call FUNC(updateCurrentItemsList);
 
-// This takes care of unique inventory items (arsenal doesn't have it whitelisted)
-call FUNC(updateUniqueItemsList);
+    // This takes care of unique inventory items (arsenal doesn't have it whitelisted)
+    call FUNC(updateUniqueItemsList);
+};
 
 // Don't refresh left panel if in loadout tab
 if (!isNull findDisplay IDD_loadouts_display) exitWith {};

addons/arsenal/functions/fnc_updateRightPanel.sqf

@@ -22,15 +22,18 @@ private _rightPanelCache = uiNamespace getVariable [QGVAR(rightPanelCache), crea
 
 private _mass = -1;
 private _color = [];
+private _alpha = 1;
 
 // Grey out items that are too big to fit in remaining space of the container
 for "_row" from 0 to (lnbSize _control select 0) - 1 do {
     _mass = _rightPanelCache getOrDefault [_control lnbData [_row, 0], 0];
+    _color = _control lnbColor [_row, 1];
 
     // Lower alpha on color for items that can't fit
-    _color = [1, 1, 1, [0.25, 1] select (_mass <= _loadRemaining)];
+    _alpha = [0.25, 1] select (_mass <= _loadRemaining);
+    _color set [3, _alpha];
     _control lnbSetColor [[_row, 1], _color];
-    _control lnbSetColor [[_row, 2], _color];
+    _control lnbSetColor [[_row, 2], [1, 1, 1, _alpha]];
 };
 
 private _display = ctrlParent _control;

addons/arsenal/initSettings.sqf

@@ -33,26 +33,47 @@ private _category = LLSTRING(settingCategory);
     true
 ] call CBA_fnc_addSetting;
 
+[
+    QGVAR(defaultToFavorites),
+    "CHECKBOX",
+    [LSTRING(defaultToFavoritesSetting), LSTRING(defaultToFavoritesTooltip)],
+    _category,
+    false,
+    2 // never overwrite the client
+] call CBA_fnc_addSetting;
+
+[
+    QGVAR(favoritesColor),
+    "COLOR",
+    [LSTRING(favoritesColorSetting), LSTRING(favoritesColorTooltip)],
+    _category,
+    [0.9, 0.875, 0.6],
+    2 // never overwrite the client
+] call CBA_fnc_addSetting;
+
 private _loadoutCategory = LLSTRING(loadoutSubcategory);
 
 // Arsenal loadouts
-[QGVAR(allowDefaultLoadouts),
+[
+    QGVAR(allowDefaultLoadouts),
     "CHECKBOX",
     [LSTRING(allowDefaultLoadoutsSetting), LSTRING(defaultLoadoutsTooltip)],
     [_category, _loadoutCategory],
     true,
     true
 ] call CBA_fnc_addSetting;
 
-[QGVAR(allowSharedLoadouts),
+[
+    QGVAR(allowSharedLoadouts),
     "CHECKBOX",
     LLSTRING(allowSharingSetting),
     [_category, _loadoutCategory],
     true,
     true
 ] call CBA_fnc_addSetting;
 
-[QGVAR(EnableRPTLog),
+[
+    QGVAR(EnableRPTLog),
     "CHECKBOX",
     [LSTRING(printToRPTSetting),
     LSTRING(printToRPTTooltip)],
@@ -61,21 +82,24 @@ private _loadoutCategory = LLSTRING(loadoutSubcategory);
     false
 ] call CBA_fnc_addSetting;
 
-[QGVAR(loadoutsSaveFace),
+[
+    QGVAR(loadoutsSaveFace),
     "CHECKBOX",
     LLSTRING(loadoutsSaveFaceSetting),
     [_category, _loadoutCategory],
     false
 ] call CBA_fnc_addSetting;
 
-[QGVAR(loadoutsSaveVoice),
+[
+    QGVAR(loadoutsSaveVoice),
     "CHECKBOX",
     LLSTRING(loadoutsSaveVoiceSetting),
     [_category, _loadoutCategory],
     false
 ] call CBA_fnc_addSetting;
 
-[QGVAR(loadoutsSaveInsignia),
+[
+    QGVAR(loadoutsSaveInsignia),
     "CHECKBOX",
     LLSTRING(loadoutsSaveInsigniaSetting),
     [_category, _loadoutCategory],