more common code cleanup

2024-08-30 18:23:18 +00:00 · 2015-09-21 13:53:12 +02:00 · 2015-09-21 13:53:12 +02:00 · b0f9eab1f7
commit b0f9eab1f7
parent 5adca6616d
4 changed files with 71 additions and 55 deletions
--- a/addons/common/functions/fnc_getMapGridData.sqf
+++ b/addons/common/functions/fnc_getMapGridData.sqf
@ -1,12 +1,13 @@
 /*
- * Author: PabstMirror (ideas from Nou's mapGridToPos and BIS_fnc_gridToPos)
+ * Author: PabstMirror
 * Finds real x/y offset and map step for a 10 digit grid
 * Save time by preparing data one time at startup
+ * Ideas from Nou's mapGridToPos and BIS_fnc_gridToPos
 *
- * Argument:
+ * Arguments:
 * None
 *
- * Return values:
+ * Return Value:
 * None
 *
 * Example:
@ -16,10 +17,10 @@
 */
 #include "script_component.hpp"

-private["_cfgGrid", "_formatX", "_formatY", "_heightOffset", "_offsetX", "_offsetY", "_originGrid", "_realOffsetY", "_startGrid", "_stepX", "_stepY", "_zoom", "_zoomMax", "_letterGrid"];
-
 GVAR(mapGridData) = [];

+private ["_cfgGrid", "_offsetX", "_offsetY", "_zoomMax", "_formatX", "_formatY", "_stepX", "_stepY", "_zoom", "_letterGrid", "_heightOffset", "_startGrid", "_originGrid", "_realOffsetY"];
+
 //--- Extract grid values from world config (Borrowed from BIS_fnc_gridToPos)
 _cfgGrid = configFile >> "CfgWorlds" >> worldName >> "Grid";
 _offsetX = getNumber (_cfgGrid >> "offsetX");
@ -29,6 +30,7 @@ _formatX = "";
 _formatY = "";
 _stepX = 1e10;
 _stepY = 1e10;
+
 {
    _zoom = getnumber (_x >> "zoomMax");
    if (_zoom < _zoomMax) then {
@ -38,11 +40,14 @@ _stepY = 1e10;
        _stepX = getNumber (_x >> "stepX");
        _stepY = getNumber (_x >> "stepY");
    };
-} foreach configProperties [_cfgGrid, "isClass _x", false];
+    false
+} count configProperties [_cfgGrid, "isClass _x", false];

 _letterGrid = false;
-if (((toLower _formatX) find "a") != -1) then {_letterGrid = true};
-if (((toLower _formatY) find "a") != -1) then {_letterGrid = true};
+
+if (toLower _formatX find "a" != -1) then {_letterGrid = true};
+if (toLower _formatY find "a" != -1) then {_letterGrid = true};
+
 if (_letterGrid) exitWith {
    ACE_LOGWARNING_3("Map Grid Warning (%1) - Map uses letter grids [%2, %3]",worldName,_formatX,_formatY);
 };
@ -51,13 +56,14 @@ if (_letterGrid) exitWith {
 _heightOffset = 500;
 _startGrid = mapGridPosition [0, _heightOffset];
 _originGrid = _startGrid;
+
 while {_startGrid == _originGrid} do {
    _heightOffset = _heightOffset + 1;
    _originGrid = mapGridPosition [0, _heightOffset];
 };

 //Calculate the real y offset
-_realOffsetY = parseNumber (_originGrid select [(count _formatX), (count _formatY)]) * _stepY + _heightOffset - 1;
+_realOffsetY = (parseNumber (_originGrid select [count _formatX, count _formatY])) * _stepY + _heightOffset - 1;

 //Calculate MGRS 10digit step - they should both be 1 meter:
 _stepXat5 = _stepX * 10 ^ ((count _formatX) - 5);
@ -66,10 +72,12 @@ _stepYat5 = -1 * _stepY * 10 ^ ((count _formatY) - 5);
 if (_stepYat5 < 0) then {
    ACE_LOGWARNING_1("Map Grid Warning (%1) - Northing is reversed.",worldName);
 };
+
 if (_stepXat5 != 1) then {
    ACE_LOGWARNING_2("Map Grid Warning (%1) - MGRS 10 digit grid does not equal 1 meter: (%2) for x.",worldName,_stepXat5);
 };
-if ((_stepYat5 != 1) && {_stepYat5 != -1}) then {
+
+if (_stepYat5 != 1 && {_stepYat5 != -1}) then {
    ACE_LOGWARNING_2("Map Grid Warning (%1) - MGRS 10 digit grid does not equal 1 meter: (%2) for y.",worldName,_stepXat5);
 };

--- a/addons/common/functions/fnc_getMapPosFromGrid.sqf
+++ b/addons/common/functions/fnc_getMapPosFromGrid.sqf
@ -2,9 +2,9 @@
 * Author: PabstMirror
 * Gets position from grid cords
 *
- * Argument:
+ * Arguments:
 * 0: Grid Cords <STRING>
- * 1: Get Center or bottom right <BOOL><OPTIONAL>
+ * 1: Grid center (true), Grid Bottom Right (false) (default: true) <BOOL>
 *
 * Return values:
 * Position <ARRAY>
@ -16,24 +16,23 @@
 */
 #include "script_component.hpp"

-PARAMS_1(_inputString);
-DEFAULT_PARAM(1,_getCenterOfGrid,true);
+params ["_inputString", ["_getCenterOfGrid", true]];

-private["_countInput", "_countInputHalf", "_xPart", "_xPos", "_yPart", "_yPos"];
-
-if ((count GVAR(mapGridData)) == 0) exitWith {
+if (count GVAR(mapGridData) == 0) exitWith {
    ERROR("Map has bad data, falling back to BIS_fnc_gridToPos");
    (_this call BIS_fnc_gridToPos) select 0
 };

-EXPLODE_4_PVT(GVAR(mapGridData),_offsetX,_realOffsetY,_stepXat5,_stepYat5);
+GVAR(mapGridData) params ["_offsetX", "_realOffsetY", "_stepXat5", "_stepYat5"];
+
+private ["_countInput", "_countInputHalf", "_xPart", "_yPart", "_xPos", "_yPos"];

 _countInput = count _inputString;
 _countInputHalf = floor (_countInput / 2);

 //Split string, ignoring middle
 _xPart = _inputString select [0, _countInputHalf];
-_yPart = _inputString select [(ceil (_countInput / 2)), _countInputHalf];
+_yPart = _inputString select [ceil (_countInput / 2), _countInputHalf];

 _xPos = ((parseNumber _xPart) * _stepXat5 * 10 ^ (5 - _countInputHalf)) + _offsetX;
 _yPos = ((parseNumber _yPart) * _stepYat5 * 10 ^ (5 - _countInputHalf)) + _realOffsetY;
@ -43,4 +42,4 @@ if (_getCenterOfGrid) then {
    _yPos = _yPos + 0.5 * _stepYat5 * 10 ^ (5 - _countInputHalf);
 };

-[_xPos, _yPos, 0];
+[_xPos, _yPos, 0]
--- a/addons/common/functions/fnc_getMarkerType.sqf
+++ b/addons/common/functions/fnc_getMarkerType.sqf
@ -1,19 +1,20 @@
 /*
 * Author: KoffeinFlummi
- *
 * Get the apropriate marker for a group.
 *
 * Arguments:
 * 0: Group
 *
 * Return Value:
- * Marker Type (string)
+ * Marker Type <STRING>
+ *
+ * Public: No
 */
 #include "script_component.hpp"

-private ["_leader","_vehicle","_side"];
+params ["_group"];

-PARAMS_1(_group);
+private ["_leader", "_vehicle", "_side"];

 _leader = leader _group;
 _vehicle = vehicle _leader;
@ -21,56 +22,61 @@ _side = side _leader;

 if (_vehicle == _leader) exitWith {
    if (
-        (getNumber (configFile >> "CfgVehicles" >> (typeOf _leader) >> "detectSkill") > 20) or
-        (getNumber (configFile >> "CfgVehicles" >> (typeOf _leader) >> "camouflage") < 1) or
-        (getText (configFile >> "CfgVehicles" >> (typeOf _leader) >> "textsingular") == "diver")
-        ) then {
-        ["n_recon", "b_recon", "o_recon"] select ((["GUER", "WEST", "EAST"] find (str _side)) max 0)
+        getNumber (configFile >> "CfgVehicles" >> typeOf _leader >> "detectSkill") > 20 ||
+        getNumber (configFile >> "CfgVehicles" >> typeOf _leader >> "camouflage") < 1 ||
+        getText   (configFile >> "CfgVehicles" >> typeOf _leader >> "textsingular") == "diver"
+    ) then {
+        ["n_recon", "b_recon", "o_recon"] select ((["GUER", "WEST", "EAST"] find str _side) max 0)
    } else {
-        ["n_inf", "b_inf", "o_inf"] select ((["GUER", "WEST", "EAST"] find (str _side)) max 0)
+        ["n_inf", "b_inf", "o_inf"] select ((["GUER", "WEST", "EAST"] find str _side) max 0)
    };
 };

-if (getNumber (configFile >> "CfgVehicles" >> (typeOf _vehicle) >> "attendant") == 1) exitWith {
-    ["n_med", "b_med", "o_med"] select ((["GUER", "WEST", "EAST"] find (str _side)) max 0)
+if (getNumber (configFile >> "CfgVehicles" >> typeOf _vehicle >> "attendant") == 1) exitWith {
+    ["n_med", "b_med", "o_med"] select ((["GUER", "WEST", "EAST"] find str _side) max 0)
 };
+
 if (
-    (getNumber (configFile >> "CfgVehicles" >> (typeOf _vehicle) >> "transportRepair") > 0) or
-    (getNumber (configFile >> "CfgVehicles" >> (typeOf _vehicle) >> "transportFuel") > 0) or
-    (getNumber (configFile >> "CfgVehicles" >> (typeOf _vehicle) >> "transportAmmo") > 0) or
-    (getNumber (configFile >> "CfgVehicles" >> (typeOf _vehicle) >> "ACE_canRepair") > 0) or
-    (getNumber (configFile >> "CfgVehicles" >> (typeOf _vehicle) >> "ACE_fuelCapacityCargo") > 0)
-    ) exitWith {
-    ["n_maint", "b_maint", "o_maint"] select ((["GUER", "WEST", "EAST"] find (str _side)) max 0)
+    getNumber (configFile >> "CfgVehicles" >> typeOf _vehicle >> "transportRepair") > 0 ||
+    getNumber (configFile >> "CfgVehicles" >> typeOf _vehicle >> "transportFuel") > 0 ||
+    getNumber (configFile >> "CfgVehicles" >> typeOf _vehicle >> "transportAmmo") > 0 ||
+    getNumber (configFile >> "CfgVehicles" >> typeOf _vehicle >> "ACE_canRepair") > 0 ||
+    getNumber (configFile >> "CfgVehicles" >> typeOf _vehicle >> "ACE_fuelCapacityCargo") > 0
+) exitWith {
+    ["n_maint", "b_maint", "o_maint"] select ((["GUER", "WEST", "EAST"] find str _side) max 0)
 };

 if (_vehicle isKindOf "Plane") exitWith {
-    ["n_plane", "b_plane", "o_plane"] select ((["GUER", "WEST", "EAST"] find (str _side)) max 0)
+    ["n_plane", "b_plane", "o_plane"] select ((["GUER", "WEST", "EAST"] find str _side) max 0)
 };
+
 if (_vehicle isKindOf "Air") exitWith {
-    ["n_air", "b_air", "o_air"] select ((["GUER", "WEST", "EAST"] find (str _side)) max 0)
+    ["n_air", "b_air", "o_air"] select ((["GUER", "WEST", "EAST"] find str _side) max 0)
 };

 if (_vehicle isKindOf "StaticMortar") exitWith {
-    ["n_mortar", "b_mortar", "o_mortar"] select ((["GUER", "WEST", "EAST"] find (str _side)) max 0)
+    ["n_mortar", "b_mortar", "o_mortar"] select ((["GUER", "WEST", "EAST"] find str _side) max 0)
 };
-if (getNumber (configFile >> "CfgVehicles" >> (typeOf _vehicle) >> "artilleryScanner") == 1) exitWith {
-    ["n_art", "b_art", "o_art"] select ((["GUER", "WEST", "EAST"] find (str _side)) max 0)
+
+if (getNumber (configFile >> "CfgVehicles" >> typeOf _vehicle >> "artilleryScanner") == 1) exitWith {
+    ["n_art", "b_art", "o_art"] select ((["GUER", "WEST", "EAST"] find str _side) max 0)
 };

 if (_vehicle isKindOf "Car") exitWith {
-    ["n_motor_inf", "b_motor_inf", "o_motor_inf"] select ((["GUER", "WEST", "EAST"] find (str _side)) max 0)
-};
-if ((_vehicle isKindOf "Tank") and (getNumber (configFile >> "CfgVehicles" >> (typeOf _vehicle) >> "transportSoldier") > 0)) exitWith {
-    ["n_mech_inf", "b_mech_inf", "o_mech_inf"] select ((["GUER", "WEST", "EAST"] find (str _side)) max 0)
+    ["n_motor_inf", "b_motor_inf", "o_motor_inf"] select ((["GUER", "WEST", "EAST"] find str _side) max 0)
 };
+
 if (_vehicle isKindOf "Tank") exitWith {
-    ["n_armor", "b_armor", "o_armor"] select ((["GUER", "WEST", "EAST"] find (str _side)) max 0)
+    if (getNumber (configFile >> "CfgVehicles" >> typeOf _vehicle >> "transportSoldier") > 0) then {
+        ["n_mech_inf", "b_mech_inf", "o_mech_inf"] select ((["GUER", "WEST", "EAST"] find str _side) max 0)
+    } else {
+        ["n_armor", "b_armor", "o_armor"] select ((["GUER", "WEST", "EAST"] find str _side) max 0)
+    };
 };

 if (_vehicle isKindOf "Ship") exitWith {
-    ["n_naval", "b_naval", "o_naval"] select ((["GUER", "WEST", "EAST"] find (str _side)) max 0)
+    ["n_naval", "b_naval", "o_naval"] select ((["GUER", "WEST", "EAST"] find str _side) max 0)
 };

 // generic marker
-["n_unknown", "b_unknown", "o_unknown"] select ((["GUER", "WEST", "EAST"] find (str _side)) max 0)
+["n_unknown", "b_unknown", "o_unknown"] select ((["GUER", "WEST", "EAST"] find str _side) max 0)
--- a/addons/common/functions/fnc_getReflectorsWithSelections.sqf
+++ b/addons/common/functions/fnc_getReflectorsWithSelections.sqf
@ -6,16 +6,19 @@
 * They behave like having an armor value of 0.
 *
 * Arguments:
- * 0: A vehicle, not the classname (Object)
+ * 0: Vehicle <OBJECT>
 *
 * Return Value:
- * The light names and selections (Array)
+ * 0: Light Hitpoints <ARRAY>
+ * 1: Selections <ARRAY>
+ *
+ * Public: Yes
 */
 #include "script_component.hpp"

-private ["_config", "_hitpoints", "_selections", "_i"];
+params ["_vehicle"];

-PARAMS_1(_vehicle);
+private ["_config", "_hitpoints", "_selections"];

 _config = configFile >> "CfgVehicles" >> typeOf _vehicle;