Header Examples

This commit is contained in:
PabstMirror 2015-02-06 17:03:56 -06:00
parent 98564fae68
commit c117e9bf16
24 changed files with 42 additions and 36 deletions

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -10,7 +10,7 @@
* The return value <BOOL> * The return value <BOOL>
* *
* Example: * Example:
* TODO * [bob1, bob2] call ACE_captives_fnc_handlePlayerChange
* *
* Public: No * Public: No
*/ */
@ -18,7 +18,7 @@
PARAMS_2(_newUnit,_oldUnit); 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; showHUD false;
} else { } else {
showHUD true; showHUD true;

View File

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

View File

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

View File

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

View File

@ -10,7 +10,7 @@
* Nothing * Nothing
* *
* Example: * Example:
* TODO * [Pierre, true] call ACE_captives_fnc_surrender;
* *
* Public: No * Public: No
*/ */
@ -19,12 +19,18 @@
PARAMS_2(_unit,_state); PARAMS_2(_unit,_state);
if (_state) then { 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 setVariable [QGVAR(isSurrendering), true, true];
[_unit, QGVAR(Surrendered), true] call EFUNC(common,setCaptivityStatus); [_unit, QGVAR(Surrendered), true] call EFUNC(common,setCaptivityStatus);
[_unit, "ACE_AmovPercMstpSsurWnonDnon", 1] call EFUNC(common,doAnimation); [_unit, "ACE_AmovPercMstpSsurWnonDnon", 1] call EFUNC(common,doAnimation);
if (_unit == ACE_player) then {
showHUD false;
};
private "_surrenderFnc"; private "_surrenderFnc";
_surrenderFnc = { _surrenderFnc = {
EXPLODE_1_PVT((_this select 0),_unit); EXPLODE_1_PVT((_this select 0),_unit);

View File

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

View File

@ -9,7 +9,7 @@
* Nothing * Nothing
* *
* Example: * Example:
* TODO * [bob] call ACE_captives_fnc_vehicleCaptiveMoveOut;
* *
* Public: No * Public: No
*/ */