Header Examples

addons/captives/functions/fnc_canApplyHandcuffs.sqf

@@ -10,7 +10,7 @@
  * The return value <BOOL>
  *
  * Example:
- * -
+ * [player, bob] call ACE_captives_fnc_canApplyHandcuffs
  *
  * Public: No
  */

addons/captives/functions/fnc_canEscortCaptive.sqf

@@ -4,13 +4,13 @@
  *
  * Arguments:
  * 0: caller (player) <OBJECT>
- * 1: target <OBJECT><OPTIONAL>
+ * 1: target <OBJECT>
  *
  * Return Value:
  * The return value <BOOL>
  *
  * Example:
- * -
+ * [player, bob] call ACE_captives_fnc_canEscortCaptive
  *
  * Public: No
  */

addons/captives/functions/fnc_canFriskPerson.sqf

@@ -10,7 +10,7 @@
  * The return value <BOOL>
  *
  * Example:
- * -
+ * [player, bob] call ACE_captives_fnc_canFriskPerson
  *
  * Public: No
  */

addons/captives/functions/fnc_canLoadCaptive.sqf

@@ -11,7 +11,7 @@
  * The return value <BOOL>
  *
  * Example:
- * -
+ * [player, bob] call ACE_captives_fnc_canLoadCaptive
  *
  * Public: No
  */

addons/captives/functions/fnc_canRemoveHandcuffs.sqf

@@ -10,7 +10,7 @@
  * The return value <BOOL>
  *
  * Example:
- * -
+ * [player, bob] call ACE_captives_fnc_canRemoveHandcuffs
  *
  * Public: No
  */

addons/captives/functions/fnc_canStopEscorting.sqf

@@ -10,7 +10,7 @@
  * The return value <BOOL>
  *
  * Example:
- * -
+ * [player, bob] call ACE_captives_fnc_canStopEscorting
  *
  * Public: No
  */
@@ -21,7 +21,6 @@ DEFAULT_PARAM(1,_target,objNull);
 
 private ["_isAttached"];
 
-
 if (isNull _target) then {
     _target = _unit getVariable [QGVAR(escortedUnit), objNull];
 };

addons/captives/functions/fnc_canSurrender.sqf

@@ -10,7 +10,7 @@
  * The return value <BOOL>
  *
  * Example:
- * [player, true] call ACE_captives_fnc_canSurrender;
+ * [Jean, true] call ACE_captives_fnc_canSurrender;
  *
  * Public: No
  */

addons/captives/functions/fnc_canUnloadCaptive.sqf

@@ -11,7 +11,7 @@
  * The return value <BOOL>
  *
  * Example:
- * -
+ * [player, bob, car1] call ACE_captives_fnc_canUnloadCaptive;
  *
  * Public: No
  */

addons/captives/functions/fnc_doApplyHandcuffs.sqf

@@ -10,7 +10,7 @@
  * The return value <BOOL>
  *
  * Example:
- * -
+ * [player, bob] call ACE_captives_fnc_doApplyHandcuffs;
  *
  * Public: No
  */

addons/captives/functions/fnc_doEscortCaptive.sqf

@@ -11,7 +11,7 @@
  * The return value <BOOL>
  *
  * Example:
- * -
+ * [player, bob, true] call ACE_captives_fnc_doEscorteCaptive;
  *
  * Public: No
  */

addons/captives/functions/fnc_doFriskPerson.sqf

@@ -10,7 +10,7 @@
  * Nothing
  *
  * Example:
- * TODO
+ * [player, bob] call ACE_captives_fnc_doFristPerson;
  *
  * Public: No
  */

addons/captives/functions/fnc_doLoadCaptive.sqf

@@ -11,7 +11,7 @@
  * Nothing
  *
  * Example:
- * TODO
+ * [bob, tom, car] call ACE_captives_fnc_doLoadCaptive
  *
  * Public: No
  */

addons/captives/functions/fnc_doRemoveHandcuffs.sqf

@@ -1,16 +1,15 @@
 /*
  * Author: PabstMirror
- * Release a captive
+ * Remove handcuffs from a target
  *
  * Arguments:
- * 0: caller (player) <OBJECT>
- * 1: target <OBJECT>
+ * 0: target <OBJECT>
  *
  * Return Value:
  * The return value <BOOL>
  *
  * Example:
- * -
+ * [bob, false] call ACE_captives_fnc_doRemoveHandcuffs
  *
  * Public: No
  */

addons/captives/functions/fnc_doUnloadCaptive.sqf

@@ -10,7 +10,7 @@
  * Nothing
  *
  * Example:
- * TODO
+ * [bob, car] call ACE_captives_fnc_doUnloadCaptive
  *
  * Public: No
  */

addons/captives/functions/fnc_handleGetIn.sqf

@@ -11,7 +11,7 @@
  * The return value <BOOL>
  *
  * Example:
- * -
+ * [car2, x, player] call ACE_captives_fnc_handleGetIn
  *
  * Public: No
  */

addons/captives/functions/fnc_handleGetOut.sqf

@@ -11,7 +11,7 @@
  * The return value <BOOL>
  *
  * Example:
- * -
+ * [car2, x, player] call ACE_captives_fnc_handleGetOut
  *
  * Public: No
  */
@@ -30,4 +30,4 @@ if ((local _unit) && {_unit getVariable [QGVAR(isHandcuffed), false]}) then {
     };
 
     [_unit, "ACE_AmovPercMstpScapWnonDnon", 2] call EFUNC(common,doAnimation);
-};
+};

addons/captives/functions/fnc_handleKilled.sqf

@@ -9,7 +9,7 @@
  * None
  *
  * Example:
- * -
+ * [bob1] call ACE_captives_fnc_handleKilled
  *
  * Public: No
  */
@@ -24,3 +24,7 @@ if (_oldUnit getVariable [QGVAR(isHandcuffed), false]) then {
 if (_oldUnit getVariable [QGVAR(isEscorting), false]) then {
     _oldUnit setVariable [QGVAR(isEscorting), false, true];
 };
+
+if (_oldUnit getVariable [QGVAR(isSurrendering), false]) then {
+    _oldUnit setVariable [QGVAR(isSurrendering), false, true];
+};

addons/captives/functions/fnc_handlePlayerChanged.sqf

@@ -10,7 +10,7 @@
  * The return value <BOOL>
  *
  * Example:
- * TODO
+ * [bob1, bob2] call ACE_captives_fnc_handlePlayerChange
  *
  * Public: No
  */
@@ -18,7 +18,7 @@
 
 PARAMS_2(_newUnit,_oldUnit);
 
-if (_newUnit getVariable [QGVAR(isHandcuffed), false]) then {
+if ((_newUnit getVariable [QGVAR(isHandcuffed), false]) || {_unit getVariable [QGVAR(isSurrendering), false]}) then {
     showHUD false;
 } else {
     showHUD true;

addons/captives/functions/fnc_handleUnitInitPost.sqf

@@ -9,7 +9,7 @@
  * The return value <BOOL>
  *
  * Example:
- * TODO
+ * [bob] call ACE_captives_fnc_handleUnitInitPost
  *
  * Public: No
  */

addons/captives/functions/fnc_handleWokeUp.sqf

@@ -9,7 +9,7 @@
  * The return value <BOOL>
  *
  * Example:
- * TODO
+ * [bob] call ACE_captives_fnc_handleWokeUp
  *
  * Public: No
  */

addons/captives/functions/fnc_setHandcuffed.sqf

@@ -10,7 +10,7 @@
  * Nothing
  *
  * Example:
- * TODO
+ * [bob, true] call ACE_captives_fnc_setHandcuffed;
  *
  * Public: No
  */

addons/captives/functions/fnc_surrender.sqf

@@ -10,7 +10,7 @@
  * Nothing
  *
  * Example:
- * TODO
+ * [Pierre, true] call ACE_captives_fnc_surrender;
  *
  * Public: No
  */
@@ -19,12 +19,18 @@
 PARAMS_2(_unit,_state);
 
 if (_state) then {
-    if (_unit getVariable [QGVAR(isSurrendering), false]) exitWith {};
+    if (_unit getVariable [QGVAR(isSurrendering), false]) exitWith {
+        ERROR("Already Surrendering");
+    };
 
     _unit setVariable [QGVAR(isSurrendering), true, true];
     [_unit, QGVAR(Surrendered), true] call EFUNC(common,setCaptivityStatus);
     [_unit, "ACE_AmovPercMstpSsurWnonDnon", 1] call EFUNC(common,doAnimation);
 
+    if (_unit == ACE_player) then {
+        showHUD false;
+    };
+
     private "_surrenderFnc";
     _surrenderFnc = {
         EXPLODE_1_PVT((_this select 0),_unit);
@@ -49,7 +55,7 @@ if (_state) then {
     };
 
     [_unit, QGVAR(Surrendered), false] call EFUNC(common,setCaptivityStatus);
-    
+
     if (_unit == ACE_player) then {
         //only enable if not handcuffed
         if (!(_unit getVariable [QGVAR(isHandcuffed), false])) then {

addons/captives/functions/fnc_vehicleCaptiveMoveIn.sqf

@@ -10,7 +10,7 @@
  * Nothing
  *
  * Example:
- * TODO
+ * [bob, car1] call ACE_captives_fnc_vehicleCaptiveMoveIn;
  *
  * Public: No
  */
@@ -24,5 +24,3 @@ _target moveInCargo _vehicle;
 _target assignAsCargo _vehicle;
 _cargoIndex = _vehicle getCargoIndex _target;
 _target setVariable [QGVAR(CargoIndex), _cargoIndex, true];
-
-TRACE_3("moveinEH",_target,_vehicle,_cargoIndex);

addons/captives/functions/fnc_vehicleCaptiveMoveOut.sqf

@@ -9,7 +9,7 @@
  * Nothing
  *
  * Example:
- * TODO
+ * [bob] call ACE_captives_fnc_vehicleCaptiveMoveOut;
  *
  * Public: No
  */
@@ -21,4 +21,4 @@ _unit setVariable [QGVAR(CargoIndex), -1, true];
 
 moveOut _unit;
 [_unit, "ACE_AmovPercMstpScapWnonDnon", 2] call EFUNC(common,doAnimation);
-unassignVehicle _unit;
+unassignVehicle _unit;