Cleanup / Headers

addons/maptools/CfgMarkers.hpp

@@ -1,26 +0,0 @@
-// MARKERS
-class CfgMarkers {
-    class ACE_MapToolFixed {
-        name = "MapToolFixed";
-        icon = PATHTOF(data\mapToolFixed.paa);
-        scope = 0;
-        color[] = {1,1,1,1};
-        size = 32;
-    };
-
-    class ACE_MapToolRotatingNormal {
-        name = "MapToolRotating";
-        icon = PATHTOF(data\mapToolRotatingNormal.paa);
-        scope = 0;
-        color[] = {1,1,1,1};
-        size = 32;
-    };
-
-    class ACE_MapToolRotatingSmall {
-        name = "MapToolRotating";
-        icon = PATHTOF(data\mapToolRotatingSmall.paa);
-        scope = 0;
-        color[] = {1,1,1,1};
-        size = 32;
-    };
-};

addons/maptools/config.cpp

@@ -32,7 +32,6 @@ class RscEdit;
 
 #include "MapGpsUI.hpp"
 #include "CfgEventHandlers.hpp"
-#include "CfgMarkers.hpp"
 #include "CfgVehicles.hpp"
 #include "CfgWeapons.hpp"
 

addons/maptools/functions/fnc_addLineMarker.sqf

@@ -1,18 +1,18 @@
 /*
  * Author: esteldunedain
- *
  * Add the line marker
  *
- * Argument:
- * 0: Marker Name (string)
- * 1: Marker start pos (array)
- * 2: Marker end pos (array)
- * 3: Color index (Number)
+ * Arguments:
+ * 0: Marker Name <STRING>
+ * 1: Marker start pos <ARRAY>
+ * 2: Marker end pos <ARRAY>
+ * 3: Color index <NUMBER>
  *
  * Return value:
- * Return
+ * None
+ *
+ * Public: No
  */
-
 #include "script_component.hpp"
 
 _name     = _this select 0;

addons/maptools/functions/fnc_calculateMapScale.sqf

@@ -1,15 +1,15 @@
 /*
  * Author: esteldunedain
- *
  * Returns the equivalent of 100m in screen coordinates
  *
- * Argument:
+ * Arguments:
  * None
  *
  * Return value:
- * Return
+ * No
+ *
+ * Public: No
  */
-
 #include "script_component.hpp"
 
 _pos          = ((finddisplay 12) displayctrl 51) ctrlMapScreenToWorld [0.5, 0.5];

addons/maptools/functions/fnc_canDraw.sqf

@@ -1,5 +1,15 @@
-// by esteldunedain
-
+/*
+ * Author: esteldunedain
+ * canDraw
+ *
+ * Arguments:
+ * None
+ *
+ * Return value:
+ * <BOOL>
+ *
+ * Public: No
+ */
 #include "script_component.hpp"
 
 (missionNameSpace getVariable [QGVAR(drawing_syncMarkers), true] && {GVAR(EveryoneCanDrawOnBriefing)}) ||

addons/maptools/functions/fnc_canUseMapGPS.sqf

@@ -1,5 +1,15 @@
-// by esteldunedain
-
+/*
+ * Author: esteldunedain
+ * canUseMapGPS
+ *
+ * Arguments:
+ * None
+ *
+ * Return value:
+ * <BOOL>
+ *
+ * Public: No
+ */
 #include "script_component.hpp"
 
 visibleMap &&

addons/maptools/functions/fnc_canUseMapTools.sqf

@@ -1,5 +1,15 @@
-// by esteldunedain
-
+/*
+ * Author: esteldunedain
+ * canUseMapTools
+ *
+ * Arguments:
+ * None
+ *
+ * Return value:
+ * <BOOL>
+ *
+ * Public: No
+ */
 #include "script_component.hpp"
 
 visibleMap &&

addons/maptools/functions/fnc_cancelDrawing.sqf

@@ -1,15 +1,15 @@
 /*
  * Author: esteldunedain
- *
  * Cancel the drawing of the current line marker
  *
- * Argument:
+ * Arguments:
  * None
  *
  * Return value:
- * Nothing
+ * None
+ *
+ * Public: No
  */
-
 #include "script_component.hpp"
 
 GVAR(drawing_isDrawing) = false;

addons/maptools/functions/fnc_copyMapReceiveMarkers.sqf

@@ -1,15 +1,15 @@
 /*
  * Author: esteldunedain
- *
  * Copy recieved markers to map
  *
- * Argument:
- * 0: Array of markers to copy (Array)
+ * Arguments:
+ * 0: Array of markers to copy <ARRAY>
  *
  * Return value:
- * Return
+ * None
+ *
+ * Public: No
  */
-
 #include "script_component.hpp"
 
 PARAMS_1(_lineMarkers);

addons/maptools/functions/fnc_copyMapStart.sqf

@@ -1,11 +1,10 @@
 /*
  * Author: esteldunedain
- *
  * Send request to remote player
  *
- * Argument:
- * 0: Player (Unit)
- * 0: Target player (Unit)
+ * Arguments:
+ * 0: Player <OBJECT>
+ * 0: Target player <OBJECT>
  *
  * Code Chain:
  * START:       copyMapStart: triggers event drawing_requestMarkers on remote

addons/maptools/functions/fnc_handleKeyDown.sqf

@@ -1,9 +1,8 @@
 /*
  * Author: esteldunedain
- *
  * Handle key down on map.
  *
- * Argument:
+ * Arguments:
  * 0: Display (display)
  * 1: Key code (number)
  * 2: Shift Key (boolean)

addons/maptools/functions/fnc_isInsideMapTool.sqf

@@ -1,16 +1,14 @@
 /*
  * Author: esteldunedain
- *
  * Return true if the position is inside the map marker (to allow dragging).
  *
- * Argument:
- * 0: x Position (in meters)
- * 1: y Position (in meters)
+ * Arguments:
+ * 0: x Position (in meters) <NUMBER>
+ * 1: y Position (in meters) <NUMBER>
  *
  * Return value:
  * Boolean
  */
-
 #include "script_component.hpp"
 
 #define TEXTURE_WIDTH_IN_M           6205
@@ -19,7 +17,6 @@
 #define DIST_LEFT_TO_CENTER_PERC     0.30
 
 
-
 if (GVAR(mapTool_Shown) == 0) exitWith {false};
 _textureWidth = [TEXTURE_WIDTH_IN_M, TEXTURE_WIDTH_IN_M / 2] select (GVAR(mapTool_Shown) - 1);
 

addons/maptools/functions/fnc_openMapGps.sqf

@@ -1,15 +1,15 @@
 /*
  * Author: esteldunedain
-*
  * Opens or closes the gps on the map screen, showing coordinates
  *
-* Argument:
-* 0: Open GPS? (Boolean)
+ * Arguments:
+ * 0: Open GPS? <BOOL>
  *
  * Return value:
  * Nothing
+ *
+ * Public: No
  */
-
 #include "script_component.hpp"
 
 _shouldOpenGps = _this select 0;
@@ -22,4 +22,3 @@ if (_shouldOpenGps && {"ItemGPS" in assignedItems ACE_player} && {!_isOpen}) the
 } else {
     ("RscACE_MapGps" call BIS_fnc_rscLayer) cutText ["","PLAIN"];
 };
-

addons/maptools/functions/fnc_openMapGpsUpdate.sqf

@@ -11,8 +11,8 @@ disableSerialization;
 
 _mapGpsDisplay = uiNamespace getVariable [QGVAR(ui_mapGpsDisplay), displayNull];
 _ctrl = _mapGpsDisplay displayCtrl 913590;
-_ctrl ctrlSetText str(round(getDir player));  //set Heading
+_ctrl ctrlSetText str(round(getDir ACE_player));  //set Heading
 _ctrl = _mapGpsDisplay displayCtrl 913591;
-_ctrl ctrlSetText str(round((getPosASL player) select 2)); //set Altitude
+_ctrl ctrlSetText str(round((getPosASL ACE_player) select 2)); //set Altitude
 _ctrl = _mapGpsDisplay displayCtrl 913592;
-_ctrl ctrlSetText mapGridPosition player; //set grid cords
+_ctrl ctrlSetText mapGridPosition ACE_player; //set grid cords

addons/maptools/functions/fnc_removeLineMarker.sqf

@@ -1,10 +1,9 @@
 /*
  * Author: esteldunedain
- *
  * Remove the line marker
  *
- * Argument:
- * 0: Marker Name (string)
+ * Arguments:
+ * 0: Marker Name <STRING>
  *
  * Return value:
  * Return

addons/maptools/functions/fnc_updateLineMarker.sqf

@@ -1,18 +1,16 @@
 /*
  * Author: esteldunedain
- *
  * Updates the line marker position and scale
  *
- * Argument:
- * 0: Marker Name (string)
- * 1: Marker start pos (array)
- * 2: Marker end pos (array)
- * 3: Color index (Number)
+ * Arguments:
+ * 0: Marker Name <STRING>
+ * 1: Marker start pos <ARRAY>
+ * 2: Marker end pos <ARRAY>
+ * 3: Color index <NUMBER>
  *
  * Return value:
- * Return
+ * None
  */
-
 #include "script_component.hpp"
 
 _name     = _this select 0;

addons/maptools/functions/fnc_updateMapToolMarkers.sqf

@@ -7,8 +7,9 @@
  *
  * Return value:
  * Nothing
+ *
+ * Public: No
  */
-
 #include "script_component.hpp"
 
 #define TEXTURE_WIDTH_IN_M    6205

addons/maptools/script_component.hpp

@@ -10,8 +10,3 @@
 #endif
 
 #include "\z\ace\Addons\main\script_macros.hpp"
-
-
-#define MARKERNAME_MAPTOOL_FIXED "ACE_MapToolFixed"
-#define MARKERNAME_MAPTOOL_ROTATINGNORMAL "ACE_MapToolRotatingNormal"
-#define MARKERNAME_MAPTOOL_ROTATINGSMALL "ACE_MapToolRotatingSmall"