Move garage GETDLC macro to common function (#183)

* Move garage GETDLC macro to common function * Update return value description
zen-mod · Oct 5, 2019 · acc11cf · acc11cf
1 parent 0a4942d
commit acc11cf
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 16 deletions.
diff --git a/addons/common/XEH_PREP.hpp b/addons/common/XEH_PREP.hpp
@@ -10,6 +10,7 @@ PREP(earthquake);
 PREP(ejectPassengers);
 PREP(getActiveTree);
 PREP(getAllTurrets);
+PREP(getDLC);
 PREP(getInventory);
 PREP(getPhoneticName);
 PREP(getPlayers);

diff --git a/addons/common/functions/fnc_getDLC.sqf b/addons/common/functions/fnc_getDLC.sqf
@@ -0,0 +1,31 @@
+#include "script_component.hpp"
+/*
+ * Author: mharis001
+ * Returns the DLC that the given config belongs to.
+ *
+ * Arguments:
+ * 0: Config <CONFIG>
+ *
+ * Return Value:
+ * DLC Classname <STRING>
+ *
+ * Example:
+ * [configFile >> "CfgVehicles" >> "CAManBase"] call zen_common_fnc_getDLC
+ *
+ * Public: No
+ */
+
+params [["_config", configNull, [configNull]]];
+
+private _dlc = "";
+private _addons = configSourceAddonList _config;
+
+if !(_addons isEqualTo []) then {
+    private _mods = configSourceModList (configFile >> "CfgPatches" >> _addons select 0);
+
+    if !(_mods isEqualTo []) then {
+        _dlc = _mods select 0;
+    };
+};
+
+_dlc
diff --git a/addons/common/functions/fnc_getSideIcon.sqf b/addons/common/functions/fnc_getSideIcon.sqf
@@ -4,10 +4,10 @@
  * Returns the side icon for given group or unit.
  *
  * Arguments:
- * 0: Unit <OBJECT|GROUP>
+ * 0: Unit or Group <OBJECT|GROUP>
  *
  * Return Value:
- * Icon file path <STRING>
+ * Icon File Path <STRING>
  *
  * Example:
  * [player] call zen_common_fnc_getSideIcon

diff --git a/addons/garage/functions/fnc_showVehicleInfo.sqf b/addons/garage/functions/fnc_showVehicleInfo.sqf
@@ -29,7 +29,7 @@ _ctrlInfoAuthor ctrlSetText _authorName;
 
 private _ctrlDLC = _display displayCtrl IDC_DLC_ICON;
 private _ctrlDLCBackground = _display displayCtrl IDC_DLC_BACKGROUND;
-private _vehicleDLC = _vehicleConfig call GETDLC;
+private _vehicleDLC = _vehicleConfig call EFUNC(common,getDLC);
 
 if (_vehicleDLC != "") then {
     private _dlcParams = modParams [_vehicleDLC, ["name", "logo", "logoOver"]];

diff --git a/addons/garage/script_component.hpp b/addons/garage/script_component.hpp
@@ -29,19 +29,6 @@
 #define ICON_UNCHECKED "\a3\ui_f\data\gui\rsccommon\rsccheckbox\checkbox_unchecked_ca.paa"
 #define CHECK_ICONS    [ICON_UNCHECKED, ICON_CHECKED]
 
-#define GETDLC \
-    { \
-        private _dlc = ""; \
-        private _addons = configSourceAddonList _this; \
-        if !(_addons isEqualTo []) then { \
-            private _mods = configSourceModList (configFile >> "CfgPatches" >> _addons select 0); \
-            if !(_mods isEqualTo []) then { \
-                _dlc = _mods select 0; \
-            }; \
-        }; \
-        _dlc \
-    }
-
 #define FADE_DELAY 0.15
 
 #define ZEUS_DISPLAY (findDisplay IDD_RSCDISPLAYCURATOR)