Wardrobe - Add support for converting items (Face, Head, NVG) (#11364)

* new fnc: getTypeNumber

* add automatic target slot desc

* fixes

* little cleanup

* upt to hashmap

* upt handling + hashmap

* rework, replaceData, cleanup

* better notification

* Update wardrobe-framework.md

* re-add _extendedInfo

* improve compats to test stuff

* extend bg of notification

* Update addons/wardrobe/functions/fnc_replaceOther.sqf

Co-authored-by: PabstMirror <pabstmirror@gmail.com>

* Update addons/wardrobe/functions/fnc_replaceContainer.sqf

Co-authored-by: PabstMirror <pabstmirror@gmail.com>

* clean up headers

* Update docs/wiki/framework/wardrobe-framework.md

* Update docs/wiki/framework/wardrobe-framework.md

* Update docs/wiki/framework/wardrobe-framework.md

---------

Co-authored-by: PabstMirror <pabstmirror@gmail.com>

Author: OverlordZorn

addons/compat_rhs_afrf3/compat_rhs_afrf3_wardrobe/ACE_Wardrobe_Headgear.hpp

@@ -1,5 +1,5 @@
-BASE_PAIR(rhs_facewear_6m2,rhs_6m2_nvg);
-BASE_PAIR(rhs_facewear_6m2_1,rhs_6m2_1_nvg);
+BASE_TRIPLET(rhs_6m2,rhs_facewear_6m2,rhs_6m2_nvg);
+BASE_TRIPLET(rhs_6m2_1,rhs_facewear_6m2_1,rhs_6m2_1_nvg);
 
 #define HEADSET rhs_facewear_6m2
 #define HEADSET_MIC rhs_facewear_6m2_1

addons/wardrobe/XEH_PREP.hpp

@@ -11,8 +11,10 @@ PREP(getDuration);
 PREP(getGesture);
 PREP(getIcon);
 PREP(getItemVariants);
+PREP(getSlotName);
 PREP(getSound);
 PREP(getSoundTiming);
+PREP(getTypeNumber);
 PREP(isModifiable);
 PREP(replace);
 PREP(replaceContainer);

addons/wardrobe/XEH_preInit.sqf

@@ -19,16 +19,17 @@ GVAR(replaceHashmap) = createHashMapFromArray [
     [TYPE_GOGGLE,   LINKFUNC(replaceOther)    ]
 ];
 
-// Cache Wardrobe Replace Exceptions
+// Handle Variables on containers (key is varName, values is global-broadcast)
+GVAR(containerVarsToTransfer) = createHashMapFromArray [
+    [toLower QEGVAR(gunbag,gunbagWeapon), true],
+    [toLower QEGVAR(movement,vload), true],
+    [toLower "radio_settings", true] // From TFAR
+];
+
+// Exception Handling
 private _map = createHashMap;
 {
-    _map set [
-        configName _x,
-        [
-            toLower getText (_x >> "mode"),
-            getText (_x >> "code") call CBA_fnc_convertStringCode
-        ]
-    ];
+    _map set [ configName _x, [ toLower getText (_x >> "mode"), getText (_x >> "code") call CBA_fnc_convertStringCode ] ];
 } forEach ("true" configClasses (configFile >> QGVAR(exceptions)));
 GVAR(exceptions) = _map;
 
@@ -37,11 +38,5 @@ GVAR(exceptions) = _map;
     { _this call (GVAR(exceptions) get (_this#0) select 1) }
 ] call CBA_fnc_addEventHandler;
 
-// Variables to transfer when changing containers (key is varName, values is global-broadcast)
-GVAR(containerVarsToTransfer) = createHashMapFromArray [
-    [toLower QEGVAR(gunbag,gunbagWeapon), true],
-    [toLower QEGVAR(movement,vload), true],
-    [toLower "radio_settings", true] // From TFAR
-];
 
 ADDON = true;

addons/wardrobe/functions/fnc_getDisplayName.sqf

@@ -23,7 +23,7 @@ private _classOrigin = configName _cfgOrigin;
 private _classTarget = configName _cfgTarget;
 
 switch (true) do {
-   
+
     // check legacy directional
     case (
         isText  (configFile >> QUOTE(ADDON) >> _classOrigin >> "modifiableTo" >> _classTarget >> "directionalActionName")
@@ -55,6 +55,18 @@ switch (true) do {
 
     // Fallback displayName of Item
     default {
-        getText (_cfgTarget  >> "displayName")
+
+        private _return = getText (_cfgTarget  >> "displayName");
+
+        // Adds type-descriptor when its converting to a different slot
+        private _typeOrigin = _cfgOrigin call LINKFUNC(getTypeNumber);
+        private _typeTarget = _cfgTarget call LINKFUNC(getTypeNumber);
+
+        if (_typeOrigin isNotEqualTo _typeTarget) then {
+            _return = _return + " (" + ( _typeTarget call LINKFUNC(getSlotName) ) + ")";
+        };
+
+        _return
+
     };
-};
+} // return

addons/wardrobe/functions/fnc_getSlotName.sqf

@@ -0,0 +1,28 @@
+#include "../script_component.hpp"
+/*
+ * Author: OverlordZorn
+ * Getter Function
+ *
+ * Arguments:
+ * 0: TYPENUMBER <NUMBER>
+ *
+ * Return Value:
+ * Localised Displayname <STRING>
+ *
+ * Example:
+ * TYPE_HMD call ace_wardrobe_fnc_getSlotName;
+ *
+ * Public: No
+ */
+
+params ["_typeNumber"];
+
+switch (_typeNumber) do {
+    case TYPE_UNIFORM:  { localize "str_a3_rscdisplayarsenal_tab_uniform" };
+    case TYPE_VEST:     { localize "str_a3_rscdisplayarsenal_tab_vest" };
+    case TYPE_BACKPACK: { localize "str_a3_rscdisplayarsenal_tab_backpack" };
+    case TYPE_HEADGEAR: { localize "str_a3_rscdisplayarsenal_tab_headgear" };
+    case TYPE_GOGGLE:   { localize "str_a3_rscdisplayarsenal_tab_goggles" };
+    case TYPE_HMD:      { localize "str_a3_rscdisplayarsenal_tab_nvgs" };
+    default { "" };
+} // return

addons/wardrobe/functions/fnc_getTypeNumber.sqf

@@ -0,0 +1,35 @@
+#include "../script_component.hpp"
+/*
+ * Author: OverlordZorn
+ * Returns typenumber of item based on config. Simplified for Wardrobe.
+ *
+ * Arguments:
+ * 0: Item Config <CONFIG>
+ *
+ * Return Value:
+ * TypeNumber <NUMBER>
+ *
+ * Example:
+ * [configFile >> "CfgWeapons" >> "U_B_CTRG_1", configFile >> "CfgWeapons" >> "U_B_CTRG_3"] call ace_wardrobe_fnc_getTypeNumber;
+ *
+ * Public: No
+ */
+
+params ["_itemConfig"];
+
+private _typeNumber = getNumber (_itemConfig >> "ItemInfo" >> "type");
+
+
+// Handle Edgecases
+if (_typeNumber isEqualTo 0) then {
+    private _className = configName _itemConfig;
+
+    _typeNumber = switch (true) do {
+        case (isClass (configFile >> "CfgGlasses" >> _className)): { TYPE_GOGGLE }; // CfgGlasses items do not have ItemInfo subclass
+        case (getNumber (configFile >> "CfgVehicles" >> _className >> "isBackpack") isEqualTo 1): { TYPE_BACKPACK }; // Backpacks
+        default { 0 };
+    };
+};
+
+//return
+_typeNumber

addons/wardrobe/functions/fnc_replace.sqf

@@ -22,49 +22,64 @@
 params ["", "_player", "_actionParams"];
 _actionParams params ["_cfgOrigin", "_cfgTarget"];
 
-private _classTarget = configName _cfgTarget;
+
+// PREP
 private _classOrigin = configName _cfgOrigin;
-private _cfgWardobeTarget = configFile >> QUOTE(ADDON) >> _classTarget;
+private _classTarget = configName _cfgTarget;
+
+private _typeOrigin = _cfgOrigin call LINKFUNC(getTypeNumber);
+private _typeTarget = _cfgTarget call LINKFUNC(getTypeNumber);
 
-// duration of the "animation"
+// Duration of Animationphase
 private _duration = _actionParams call LINKFUNC(getDuration);
 
-// replace the main Item
-private _typeNumber = getNumber (_cfgOrigin >> "ItemInfo" >> "type");
-
-if (_typeNumber isEqualTo 0) then {
-    
-    // Switch-statement incase there will be more edge cases like CfgGlassess
-    _typeNumber = switch (true) do {
-        // CfgGlasses items do not have a ItemInfo subclass and therefore, will return 0
-        case (isClass (configFile >> "CfgGlasses" >> _classOrigin)): { TYPE_GOGGLE };
-        case (getNumber (configFile >> "CfgVehicles" >> _classOrigin >> "isBackpack") isEqualTo 1): { TYPE_BACKPACK };
-        default { 0 };
-    };
-};
 
-private _replaceCode = GVAR(replaceHashmap) get _typeNumber;
+private _replaceCode = GVAR(replaceHashmap) get _typeOrigin;
 
-if (isNil "_replaceCode") exitWith { ERROR_2("typeNumber undefined: %1 - %2",_typeNumber,_classOrigin); };
 
-private _extendedInfo = createHashMap;
-[QGVAR(itemChangedStart), [_player, _classOrigin, _classTarget, _typeNumber, _extendedInfo]] call CBA_fnc_localEvent;
+// FAIL CONDITIONS
+private _isNotEqualTypeNumber = _typeOrigin isNotEqualTo _typeTarget;
 
-// temp action disabled
+if (isNil "_replaceCode") exitWith { ERROR_2("typeNumber undefined: %1 - %2",_typeOrigin,_classOrigin); };
+if (_isNotEqualTypeNumber && { _typeTarget in [TYPE_UNIFORM, TYPE_VEST, TYPE_BACKPACK] }) exitWith {
+    ERROR_4("Convertion of containers not supported: %1: %2 -> %3: %4",_classOrigin,_typeOrigin,_classTarget,_typeTarget)
+};
+if (_isNotEqualTypeNumber && {
+        switch (_typeTarget) do {
+            case TYPE_HEADGEAR: { "" isNotEqualTo headgear _player };
+            case TYPE_GOGGLE:   { "" isNotEqualTo goggles _player };
+            case TYPE_HMD:      { "" isNotEqualTo hmd _player };
+        }
+    }
+) exitWith { [ [LLSTRING(slotOccupied), _typeTarget call LINKFUNC(getSlotName)], 2 ] call EFUNC(common,displayTextStructured); };
+
+// REPLACE MECHANIC
+// Disables Wardrobe Action temporarily
 GVAR(inProgress) = true;
 
-[{
-    params ["_player", "_classOrigin", "_classTarget", "_typeNumber", "_replaceCode", "_extendedInfo"];
+// use hashmap instead of array to futureproofing - espl. regarding API Events - extended data can simply be added
+private _replaceData = createHashMapFromArray [
+    ["player", _player],
+    ["classOrigin", _classOrigin],
+    ["classTarget", _classTarget],
+    ["typeOrigin", _typeOrigin],
+    ["typeTarget", _typeTarget]
+];
+
+private _extendedInfo = createHashMap;
+[QGVAR(itemChangedStart), [_replaceData, _extendedInfo]] call CBA_fnc_localEvent; // API
 
-    [QGVAR(itemChangedBegin), [_player, _classOrigin, _classTarget, _typeNumber, _extendedInfo]] call CBA_fnc_localEvent;
+[{
+    params ["_replaceData", "_replaceCode", "_extendedInfo"];
 
-    [_player, _classTarget, _typeNumber] call _replaceCode;
+    [QGVAR(itemChangedBegin), [_replaceData, _extendedInfo]] call CBA_fnc_localEvent; // API
+    _replaceData call _replaceCode;
+    [QGVAR(itemChangedEnd), [_replaceData, _extendedInfo]] call CBA_fnc_localEvent; // API
 
-    [QGVAR(itemChangedEnd), [_player, _classOrigin, _classTarget, _typeNumber, _extendedInfo]] call CBA_fnc_localEvent;
+}, [_replaceData, _replaceCode, _extendedInfo], _duration] call CBA_fnc_waitAndExecute;
 
-}, [_player, _classOrigin, _classTarget, _typeNumber, _replaceCode, _extendedInfo], _duration] call CBA_fnc_waitAndExecute;
 
-// handle components
+// HANDLE COMPONENTS
 [_classOrigin, _classTarget] call FUNC(compareComponents) params ["_missing", "_surplus"];
 
 // add surplus
@@ -89,11 +104,12 @@ GVAR(inProgress) = true;
     };
 } forEach _missing;
 
-// handle effects
+
+// EFFECTS
 // animation/gestures
 [_player, _actionParams call LINKFUNC(getGesture)] call EFUNC(common,doGesture);
 
-// plays random sound at the beginning
+// Soundseffects
 private _sound = _actionParams call LINKFUNC(getSound);
 if (_sound isNotEqualTo "") then {
     [
@@ -103,7 +119,7 @@ if (_sound isNotEqualTo "") then {
     ] call CBA_fnc_waitAndExecute;
 };
 
-// notification
+// Notification
 private _imgNotify = getText (_cfgTarget >> "picture");
 if !(".paa" in _imgNotify) then {
     // some vanilla items dont have the .paa and cba notify will display the path as a string without the .paa

addons/wardrobe/functions/fnc_replaceContainer.sqf

@@ -4,21 +4,22 @@
  * Function to replace a units wearable container while maintaining the content of the container.
  *
  * Arguments:
- * 0: Unit <OBJECT>
- * 1: Desired variant as classname <STRING>
- * 2: Type of wearable container <STRING>
+ * 0: Params Hash <HASHMAP>
  *
  * Return Value:
  * None
  *
  * Example:
- * [player, "U_B_CTRG_3", "UNIFORM"] call ace_wardrobe_fnc_replaceContainer
- * [player, "U_B_CTRG_1", "UNIFORM"] call ace_wardrobe_fnc_replaceContainer
+ * [_replaceData] call ace_wardrobe_fnc_replaceContainer
  *
  * Public: No
  */
 
-params ["_player", "_classTarget", "_typeNumber"];
+params ["_replaceData"];
+private _player = _replaceData get "player";
+private _classTarget = _replaceData get "classTarget";
+private _typeTarget = _replaceData get "typeTarget";
+
 
 private _allMags = (magazinesAmmoFull _player) apply { _x#0 };
 
@@ -51,7 +52,7 @@ private _containerVars = [];
 } forEach [uniformContainer _player, vestContainer _player, backpackContainer _player];
 
 // Replace Wearable Container
-switch (_typeNumber) do {
+switch (_typeTarget) do {
     case TYPE_UNIFORM:  { _loadout # 3 set [0, _classTarget]; };
     case TYPE_VEST:     { _loadout # 4 set [0, _classTarget]; };
     case TYPE_BACKPACK: { _loadout # 5 set [0, _classTarget]; };

addons/wardrobe/functions/fnc_replaceOther.sqf

@@ -1,36 +1,47 @@
 #include "../script_component.hpp"
 /*
  * Author: OverlordZorn
- * Function to replace a unit's goggles/facewear.
+ * Function to replace a unit's Facewear, NVG/HMD or Headgear.
  *
  * Arguments:
- * 0: Unit <OBJECT>
- * 1: Desired variant as classname <STRING>
- * 2: Type of wearable container <STRING>
+ * 0: Params Hash <HASHMAP>
  *
  * Return Value:
  * None
  *
  * Example:
- * [player, "G_Bandanna_blk", "FACEWEAR"] call ace_wardrobe_fnc_replaceOther
- * [player, "G_Bandanna_aviator", "FACEWEAR"] call ace_wardrobe_fnc_replaceOther
+ * [_replaceData] call ace_wardrobe_fnc_replaceOther
  *
  * Public: No
  */
 
-params ["_player", "_classTarget", "_typeNumber"];
+params ["_replaceData"];
 
-switch (_typeNumber) do {
+private _player = _replaceData get "player";
+
+// Remove
+switch (_replaceData get "typeOrigin") do {
     case TYPE_HEADGEAR: {
         removeHeadgear _player;
-        _player addHeadgear _classTarget;
     };
     case TYPE_GOGGLE: {
         removeGoggles _player;
-        _player addGoggles _classTarget;
     };
     case TYPE_HMD: {
-        _player linkItem _classTarget;
+        _player unlinkItem (_replaceData get "classOrigin")
+    };
+};
+
+// ADD
+switch (_replaceData get "typeTarget") do {
+    case TYPE_HEADGEAR: {
+        _player addHeadgear (_replaceData get "classTarget");
+    };
+    case TYPE_GOGGLE: {
+        _player addGoggles (_replaceData get "classTarget");
+    };
+    case TYPE_HMD: {
+        _player linkItem (_replaceData get "classTarget");
     };
 };
 

addons/wardrobe/stringtable.xml

@@ -152,6 +152,9 @@
             <Russian>Надеть маску</Russian>
             <Japanese>マスクを着ける</Japanese>
         </Key>
+        <Key ID="STR_ACE_Wardrobe_slotOccupied">
+            <English>Your %1 slot is already occupied</English>
+        </Key>
         <Key ID="STR_ACE_Wardrobe_missingComponents">
             <English>Cannot switch to&lt;br/&gt;%1&lt;br/&gt;due to missing components</English>
             <French>Impossible de passer à&lt;br/&gt;%1&lt;br/&gt;en raison de composants manquants</French>