Func Headers

addons/logistics_wirecutter/functions/fnc_canCutFence.sqf

@@ -1,3 +1,17 @@
+/* fnc_canCutFence.sqf
+*
+* Author: PabstMirror
+*
+* Condition check if player is able to cut a fence.
+* Checks for "ACE_wirecutter" item and if there is a nearby fence.
+*
+* Argument:
+* 0: OBJECT - Unit to check condition for (player)
+*
+* Return value:
+* BOOL
+*/
+
 #include "script_component.hpp"
 PARAMS_1(_unit);
 

addons/logistics_wirecutter/functions/fnc_getNearestFence.sqf

@@ -1,3 +1,15 @@
+/* fnc_getNearestFence.sqf
+*
+* Author: PabstMirror
+*
+* Gets nearest fence within 5 meters to the unit.
+*
+* Argument:
+* 0: OBJECT - Unit to search for fence objects arround
+*
+* Return value:
+* OBJECT - Nearest object that is a fence, objNull if none found.
+*/
 #include "script_component.hpp"
 
 private "_nearestFence";

addons/logistics_wirecutter/functions/fnc_isFence.sqf

@@ -1,3 +1,16 @@
+/* fnc_isFence.sqf
+*
+* Author: PabstMirror
+*
+* Checks if object is a fence.  Should work on any fence type, even (typeof == "").
+* Call is fairly expensive because of all of the string checking.
+*
+* Argument:
+* 0: OBJECT - Ojbect to test
+*
+* Return value:
+* BOOL
+*/
 #include "script_component.hpp"
 
 //find is case sensitive, so keep everything lowercase
@@ -7,7 +20,6 @@
 #define FENCE_AIA_TYPENAMES []
 #define FENCE_AIA_P3DS ["wall_indfnc_3.p3d", "wall_indfnc_9.p3d", "wall_indfnc_corner.p3d", "pletivo_wired.p3d", "wall_fen1_5.p3d"]
 
-
 private ["_typeOf", "_returnValue"];
 PARAMS_1(_object);