From 2440e4fa69327c4069f8d8413f08554a77423735 Mon Sep 17 00:00:00 2001 From: Garth L-H de Wet Date: Mon, 2 Feb 2015 10:35:17 +0200 Subject: [PATCH] Fixed incorrect indenting with headers in explosives. --- addons/explosives/XEH_postInit.sqf | 30 ++++++------- addons/explosives/XEH_preInit.sqf | 30 ++++++------- .../explosives/functions/fnc_addClacker.sqf | 36 +++++++-------- addons/explosives/functions/fnc_canDefuse.sqf | 30 ++++++------- .../explosives/functions/fnc_canDetonate.sqf | 30 ++++++------- .../functions/fnc_defuseExplosive.sqf | 32 +++++++------- .../functions/fnc_detonateExplosive.sqf | 40 ++++++++--------- .../functions/fnc_getDetonators.sqf | 30 ++++++------- .../functions/fnc_getPlacedExplosives.sqf | 34 +++++++------- .../functions/fnc_handleScrollWheel.sqf | 30 ++++++------- .../functions/fnc_hasExplosives.sqf | 30 ++++++------- .../functions/fnc_hasPlacedExplosives.sqf | 30 ++++++------- addons/explosives/functions/fnc_module.sqf | 30 ++++++------- .../functions/fnc_openDetonateUI.sqf | 32 +++++++------- .../explosives/functions/fnc_openPlaceUI.sqf | 30 ++++++------- .../functions/fnc_openTimerSetUI.sqf | 30 ++++++------- .../functions/fnc_openTransmitterUI.sqf | 30 ++++++------- .../functions/fnc_openTriggerSelectionUI.sqf | 30 ++++++------- .../functions/fnc_placeExplosive.sqf | 44 +++++++++---------- .../functions/fnc_place_Approve.sqf | 32 +++++++------- .../explosives/functions/fnc_place_Cancel.sqf | 30 ++++++------- .../functions/fnc_selectTrigger.sqf | 32 +++++++------- .../explosives/functions/fnc_setPosition.sqf | 34 +++++++------- .../functions/fnc_setupExplosive.sqf | 36 +++++++-------- .../explosives/functions/fnc_startDefuse.sqf | 32 +++++++------- .../explosives/functions/fnc_startTimer.sqf | 32 +++++++------- .../explosives/functions/fnc_triggerType.sqf | 30 ++++++------- 27 files changed, 406 insertions(+), 460 deletions(-) diff --git a/addons/explosives/XEH_postInit.sqf b/addons/explosives/XEH_postInit.sqf index 69a5643aad..2ede878a37 100644 --- a/addons/explosives/XEH_postInit.sqf +++ b/addons/explosives/XEH_postInit.sqf @@ -1,20 +1,18 @@ /* -* XEH_postInit.sqf -* -* Author: Garth 'L-H' de Wet -* Initialises the player object for the explosive system. -* -* Arguments: -* None -* -* Return Value: -* None -* -* Example: -* None -* -* Public: No -*/ + * Author: Garth 'L-H' de Wet + * Initialises the player object for the explosive system. + * + * Arguments: + * None + * + * Return Value: + * None + * + * Example: + * None + * + * Public: No + */ #include "script_component.hpp" if !(hasInterface) exitWith {}; GVAR(PlacedCount) = 0; diff --git a/addons/explosives/XEH_preInit.sqf b/addons/explosives/XEH_preInit.sqf index 9b2db0a5b6..801ded6615 100644 --- a/addons/explosives/XEH_preInit.sqf +++ b/addons/explosives/XEH_preInit.sqf @@ -1,20 +1,18 @@ /* -* XEH_preInit.sqf -* -* Author: Garth 'L-H' de Wet -* Initialises the explosives system -* -* Arguments: -* None -* -* Return Value: -* None -* -* Example: -* None -* -* Public: No -*/ + * Author: Garth 'L-H' de Wet + * Initialises the explosives system + * + * Arguments: + * None + * + * Return Value: + * None + * + * Example: + * None + * + * Public: No + */ #include "script_component.hpp" ADDON = false; diff --git a/addons/explosives/functions/fnc_addClacker.sqf b/addons/explosives/functions/fnc_addClacker.sqf index 40ba6f58ae..4746dc66f5 100644 --- a/addons/explosives/functions/fnc_addClacker.sqf +++ b/addons/explosives/functions/fnc_addClacker.sqf @@ -1,23 +1,21 @@ /* -* fnc_addClacker.sqf -* -* Author: Garth 'L-H' de Wet -* Adds an explosive as a clacker item to the passed unit if the unit has the required item. -* -* Arguments: -* 0: Unit -* 1: Explosive -* 2: Magazine classname -* 3: Extra variables -* -* Return Value: -* None -* -* Example: -* [player, _explosive, "SatchelCharge_Remote_Mag", [ConfigFile >> "CfgACE_Triggers" >> "Command"]] call ACE_Explosives_fnc_addClacker; -* -* Public: Yes -*/ + * Author: Garth 'L-H' de Wet + * Adds an explosive as a clacker item to the passed unit if the unit has the required item. + * + * Arguments: + * 0: Unit + * 1: Explosive + * 2: Magazine classname + * 3: Extra variables + * + * Return Value: + * None + * + * Example: + * [player, _explosive, "SatchelCharge_Remote_Mag", [ConfigFile >> "CfgACE_Triggers" >> "Command"]] call ACE_Explosives_fnc_addClacker; + * + * Public: Yes + */ #include "script_component.hpp" private ["_unit", "_explosive", "_clacker", "_config", "_magazineClass", "_requiredItems", "_hasRequired"]; _unit = _this select 0; diff --git a/addons/explosives/functions/fnc_canDefuse.sqf b/addons/explosives/functions/fnc_canDefuse.sqf index 7c302e6e7a..566363c2ad 100644 --- a/addons/explosives/functions/fnc_canDefuse.sqf +++ b/addons/explosives/functions/fnc_canDefuse.sqf @@ -1,20 +1,18 @@ /* -* fnc_canDefuse.sqf -* -* Author: Garth 'L-H' de Wet -* Whether a unit can perform the defuse action -* -* Arguments: -* 0: Unit -* -* Return Value: -* Able to defuse -* -* Example: -* if ([player] call ACE_Explosives_fnc_canDefuse) then {hint "Can Defuse";}; -* -* Public: Yes -*/ + * Author: Garth 'L-H' de Wet + * Whether a unit can perform the defuse action + * + * Arguments: + * 0: Unit + * + * Return Value: + * Able to defuse + * + * Example: + * if ([player] call ACE_Explosives_fnc_canDefuse) then {hint "Can Defuse";}; + * + * Public: Yes + */ #include "script_component.hpp" private "_unit"; _unit = _this select 0; diff --git a/addons/explosives/functions/fnc_canDetonate.sqf b/addons/explosives/functions/fnc_canDetonate.sqf index 7d81425c46..0b96f66f27 100644 --- a/addons/explosives/functions/fnc_canDetonate.sqf +++ b/addons/explosives/functions/fnc_canDetonate.sqf @@ -1,20 +1,18 @@ /* -* fnc_canDetonate.sqf -* -* Author: Garth 'L-H' de Wet -* Whether the unit is able to detonate explosives -* -* Arguments: -* 0: Unit -* -* Return Value: -* Able to detonate -* -* Example: -* if ([player] call ACE_Explosives_fnc_canDetonate) then { hint "Can Detonate"; }; -* -* Public: Yes -*/ + * Author: Garth 'L-H' de Wet + * Whether the unit is able to detonate explosives + * + * Arguments: + * 0: Unit + * + * Return Value: + * Able to detonate + * + * Example: + * if ([player] call ACE_Explosives_fnc_canDetonate) then { hint "Can Detonate"; }; + * + * Public: Yes + */ #include "script_component.hpp" private "_unit"; _unit = _this select 0; diff --git a/addons/explosives/functions/fnc_defuseExplosive.sqf b/addons/explosives/functions/fnc_defuseExplosive.sqf index 09444009c0..5836c9e210 100644 --- a/addons/explosives/functions/fnc_defuseExplosive.sqf +++ b/addons/explosives/functions/fnc_defuseExplosive.sqf @@ -1,21 +1,19 @@ /* -* fnc_defuseExplosive.sqf -* -* Author: Garth 'L-H' de Wet -* Causes the unit to defuse the passed explosive. -* -* Arguments: -* 0: Unit -* 1: Explosive -* -* Return Value: -* None -* -* Example: -* [player, ACE_Interaction_Target] call ACE_Explosives_fnc_defuseExplosive; -* -* Public: Yes -*/ + * Author: Garth 'L-H' de Wet + * Causes the unit to defuse the passed explosive. + * + * Arguments: + * 0: Unit + * 1: Explosive + * + * Return Value: + * None + * + * Example: + * [player, ACE_Interaction_Target] call ACE_Explosives_fnc_defuseExplosive; + * + * Public: Yes + */ #include "script_component.hpp" private ["_unit", "_explosive"]; _unit = _this select 0; diff --git a/addons/explosives/functions/fnc_detonateExplosive.sqf b/addons/explosives/functions/fnc_detonateExplosive.sqf index 5d0d71c800..f28ad14b62 100644 --- a/addons/explosives/functions/fnc_detonateExplosive.sqf +++ b/addons/explosives/functions/fnc_detonateExplosive.sqf @@ -1,25 +1,23 @@ /* -* fnc_detonateExplosive.sqf -* -* Author: Garth 'L-H' de Wet -* Causes the unit to defuse the passed explosive. -* -* Arguments: -* 0: Unit -* 1: Max range (-1 to ignore) -* 2: Explosive -* 0: Explosive -* 1: Fuse time -* -* Return Value: -* None -* -* Example: -* [player, 100, [Explosive, 1]] call ACE_Explosives_fnc_detonateExplosive; // has to be within range -* [player, -1, [Explosive, 1]] call ACE_Explosives_fnc_detonateExplosive; // range ignored. -* -* Public: Yes -*/ + * Author: Garth 'L-H' de Wet + * Causes the unit to defuse the passed explosive. + * + * Arguments: + * 0: Unit + * 1: Max range (-1 to ignore) + * 2: Explosive + * 0: Explosive + * 1: Fuse time + * + * Return Value: + * None + * + * Example: + * [player, 100, [Explosive, 1]] call ACE_Explosives_fnc_detonateExplosive; // has to be within range + * [player, -1, [Explosive, 1]] call ACE_Explosives_fnc_detonateExplosive; // range ignored. + * + * Public: Yes + */ #include "script_component.hpp" private ["_item","_result", "_ignoreRange", "_unit", "_range"]; _unit = _this select 0; diff --git a/addons/explosives/functions/fnc_getDetonators.sqf b/addons/explosives/functions/fnc_getDetonators.sqf index b5146e8249..83e0087acc 100644 --- a/addons/explosives/functions/fnc_getDetonators.sqf +++ b/addons/explosives/functions/fnc_getDetonators.sqf @@ -1,20 +1,18 @@ /* -* fnc_getDetonators.sqf -* -* Author: Garth 'L-H' de Wet -* Returns all the detonators of the unit -* -* Arguments: -* 0: Unit -* -* Return Value: -* Configs of all detonators -* -* Example: -* _detonators = [player] call ACE_Explosives_fnc_getDetonators; -* -* Public: Yes -*/ + * Author: Garth 'L-H' de Wet + * Returns all the detonators of the unit + * + * Arguments: + * 0: Unit + * + * Return Value: + * Configs of all detonators + * + * Example: + * _detonators = [player] call ACE_Explosives_fnc_getDetonators; + * + * Public: Yes + */ #include "script_component.hpp" private ["_unit", "_items", "_result", "_config"]; _unit = _this select 0; diff --git a/addons/explosives/functions/fnc_getPlacedExplosives.sqf b/addons/explosives/functions/fnc_getPlacedExplosives.sqf index df449ac6af..4ebcdb8f0b 100644 --- a/addons/explosives/functions/fnc_getPlacedExplosives.sqf +++ b/addons/explosives/functions/fnc_getPlacedExplosives.sqf @@ -1,22 +1,20 @@ /* -* fnc_getPlacedExplosives.sqf -* -* Author: Garth 'L-H' de Wet -* Gets all placed explosives by unit, optionally filtered by specific trigger type. -* -* Arguments: -* 0: Unit -* 1: Trigger classname - filter (optional) -* -* Return Value: -* Explosives -* -* Example: -* _allExplosives = [player] call ACE_Explosives_fnc_getPlacedExplosives; -* _deadmanExplosives = [player, "DeadManSwitch"] call ACE_Explosives_fnc_getPlacedExplosives; -* -* Public: Yes -*/ + * Author: Garth 'L-H' de Wet + * Gets all placed explosives by unit, optionally filtered by specific trigger type. + * + * Arguments: + * 0: Unit + * 1: Trigger classname - filter (optional) + * + * Return Value: + * Explosives + * + * Example: + * _allExplosives = [player] call ACE_Explosives_fnc_getPlacedExplosives; + * _deadmanExplosives = [player, "DeadManSwitch"] call ACE_Explosives_fnc_getPlacedExplosives; + * + * Public: Yes + */ #include "script_component.hpp" private ["_unit", "_clackerList", "_adjustedList", "_list", "_filter"]; _unit = _this select 0; diff --git a/addons/explosives/functions/fnc_handleScrollWheel.sqf b/addons/explosives/functions/fnc_handleScrollWheel.sqf index b7de62c7a0..8c842b8a05 100644 --- a/addons/explosives/functions/fnc_handleScrollWheel.sqf +++ b/addons/explosives/functions/fnc_handleScrollWheel.sqf @@ -1,20 +1,18 @@ /* -* fnc_handleScrollWheel.sqf -* -* Author: Garth 'L-H' de Wet -* Handles rotating of Explosives -* -* Arguments: -* Amount scrolled -* -* Return Value: -* Handled -* -* Example: -* 1.2 call ACE_Explosives_fnc_HandleScrollWheel; -* -* Public: No -*/ + * Author: Garth 'L-H' de Wet + * Handles rotating of Explosives + * + * Arguments: + * Amount scrolled + * + * Return Value: + * Handled + * + * Example: + * 1.2 call ACE_Explosives_fnc_HandleScrollWheel; + * + * Public: No + */ #include "script_component.hpp" private ["_obj"]; if (isNull(GVAR(Setup)) || {ACE_Modifier == 0} || !GVAR(pfeh_running)) exitWith {false}; diff --git a/addons/explosives/functions/fnc_hasExplosives.sqf b/addons/explosives/functions/fnc_hasExplosives.sqf index cbcb3905c8..ef1deef28a 100644 --- a/addons/explosives/functions/fnc_hasExplosives.sqf +++ b/addons/explosives/functions/fnc_hasExplosives.sqf @@ -1,20 +1,18 @@ /* -* fnc_hasExplosives.sqf -* -* Author: Garth 'L-H' de Wet -* Whether the passed unit has any explosives on them. -* -* Arguments: -* 0: Unit -* -* Return Value: -* The unit has explosives -* -* Example: -* _hasExplosives = [player] call ACE_Explosives_fnc_hasExplosives; -* -* Public: Yes -*/ + * Author: Garth 'L-H' de Wet + * Whether the passed unit has any explosives on them. + * + * Arguments: + * 0: Unit + * + * Return Value: + * The unit has explosives + * + * Example: + * _hasExplosives = [player] call ACE_Explosives_fnc_hasExplosives; + * + * Public: Yes + */ #include "script_component.hpp" private ["_unit", "_result", "_magazines"]; _result = false; diff --git a/addons/explosives/functions/fnc_hasPlacedExplosives.sqf b/addons/explosives/functions/fnc_hasPlacedExplosives.sqf index dd25795296..4a6ccc9de8 100644 --- a/addons/explosives/functions/fnc_hasPlacedExplosives.sqf +++ b/addons/explosives/functions/fnc_hasPlacedExplosives.sqf @@ -1,19 +1,17 @@ /* -* fnc_hasPlacedExplosives.sqf -* -* Author: Garth 'L-H' de Wet -* Whether the passed unit has placed any explosives or has a clacker that was used when explosives were placed. -* -* Arguments: -* 0: Unit -* -* Return Value: -* Configs of all detonators -* -* Example: -* _hasPlacedExplosives = [player] call ACE_Explosives_fnc_hasPlacedExplosives; -* -* Public: Yes -*/ + * Author: Garth 'L-H' de Wet + * Whether the passed unit has placed any explosives or has a clacker that was used when explosives were placed. + * + * Arguments: + * 0: Unit + * + * Return Value: + * Configs of all detonators + * + * Example: + * _hasPlacedExplosives = [player] call ACE_Explosives_fnc_hasPlacedExplosives; + * + * Public: Yes + */ #include "script_component.hpp" (count (_this call FUNC(getPlacedExplosives)) > 0) diff --git a/addons/explosives/functions/fnc_module.sqf b/addons/explosives/functions/fnc_module.sqf index 77762dc08b..1e1e9d3e62 100644 --- a/addons/explosives/functions/fnc_module.sqf +++ b/addons/explosives/functions/fnc_module.sqf @@ -1,20 +1,18 @@ /* -* fnc_module.sqf -* -* Author: Garth 'L-H' de Wet -* Initialises the explosives module -* -* Arguments: -* Module things. -* -* Return Value: -* None -* -* Example: -* Called By BIS. -* -* Public: No -*/ + * Author: Garth 'L-H' de Wet + * Initialises the explosives module + * + * Arguments: + * Module things. + * + * Return Value: + * None + * + * Example: + * Called By BIS. + * + * Public: No + */ #include "script_component.hpp" if !(isServer) exitWith {}; _logic = _this select 0; diff --git a/addons/explosives/functions/fnc_openDetonateUI.sqf b/addons/explosives/functions/fnc_openDetonateUI.sqf index 4e8b854a79..a14865bc20 100644 --- a/addons/explosives/functions/fnc_openDetonateUI.sqf +++ b/addons/explosives/functions/fnc_openDetonateUI.sqf @@ -1,21 +1,19 @@ /* -* fnc_openDetonateUI.sqf -* -* Author: Garth 'L-H' de Wet -* Opens the UI for explosive detonation selection -* -* Arguments: -* 0: Unit -* 1: Trigger classname -* -* Return Value: -* None -* -* Example: -* [player, "ACE_M26_Clacker"] call ACE_Explosives_fnc_openDetonateUI; -* -* Public: No -*/ + * Author: Garth 'L-H' de Wet + * Opens the UI for explosive detonation selection + * + * Arguments: + * 0: Unit + * 1: Trigger classname + * + * Return Value: + * None + * + * Example: + * [player, "ACE_M26_Clacker"] call ACE_Explosives_fnc_openDetonateUI; + * + * Public: No + */ #include "script_component.hpp" private ["_unit","_result", "_item"]; call EFUNC(interaction,hideMenu); diff --git a/addons/explosives/functions/fnc_openPlaceUI.sqf b/addons/explosives/functions/fnc_openPlaceUI.sqf index 791fe359d9..1bb78248d2 100644 --- a/addons/explosives/functions/fnc_openPlaceUI.sqf +++ b/addons/explosives/functions/fnc_openPlaceUI.sqf @@ -1,20 +1,18 @@ /* -* fnc_openPlaceUI.sqf -* -* Author: Garth 'L-H' de Wet -* Opens the UI for explosive placement selection -* -* Arguments: -* 0: Unit -* -* Return Value: -* None -* -* Example: -* [player] call ACE_Explosives_fnc_openPlaceUI; -* -* Public: No -*/ + * Author: Garth 'L-H' de Wet + * Opens the UI for explosive placement selection + * + * Arguments: + * 0: Unit + * + * Return Value: + * None + * + * Example: + * [player] call ACE_Explosives_fnc_openPlaceUI; + * + * Public: No + */ #include "script_component.hpp" private ["_unit","_mags", "_item", "_index", "_actions"]; _unit = _this select 0; diff --git a/addons/explosives/functions/fnc_openTimerSetUI.sqf b/addons/explosives/functions/fnc_openTimerSetUI.sqf index c2969b5497..d7f6ef30d8 100644 --- a/addons/explosives/functions/fnc_openTimerSetUI.sqf +++ b/addons/explosives/functions/fnc_openTimerSetUI.sqf @@ -1,20 +1,18 @@ /* -* fnc_openTimerSetUI.sqf -* -* Author: Garth 'L-H' de Wet -* Opens the UI for timer setting of an explosive -* -* Arguments: -* 0: Magazine -* -* Return Value: -* None -* -* Example: -* ["SatchelCharge_Remote_Mag"] call ACE_Explosives_fnc_openTimerSetUI; -* -* Public: No -*/ + * Author: Garth 'L-H' de Wet + * Opens the UI for timer setting of an explosive + * + * Arguments: + * 0: Magazine + * + * Return Value: + * None + * + * Example: + * ["SatchelCharge_Remote_Mag"] call ACE_Explosives_fnc_openTimerSetUI; + * + * Public: No + */ #include "script_component.hpp" private ["_mag"]; _mag = _this select 0; diff --git a/addons/explosives/functions/fnc_openTransmitterUI.sqf b/addons/explosives/functions/fnc_openTransmitterUI.sqf index ffef790d7c..b87673c214 100644 --- a/addons/explosives/functions/fnc_openTransmitterUI.sqf +++ b/addons/explosives/functions/fnc_openTransmitterUI.sqf @@ -1,20 +1,18 @@ /* -* fnc_openTransmitterUI.sqf -* -* Author: Garth 'L-H' de Wet -* Opens the UI for selecting the transmitter -* -* Arguments: -* 0: Unit -* -* Return Value: -* Nothing -* -* Example: -* [player] call ACE_Explosives_fnc_openTransmitterUI; -* -* Public: No -*/ + * Author: Garth 'L-H' de Wet + * Opens the UI for selecting the transmitter + * + * Arguments: + * 0: Unit + * + * Return Value: + * Nothing + * + * Example: + * [player] call ACE_Explosives_fnc_openTransmitterUI; + * + * Public: No + */ #include "script_component.hpp" private ["_items", "_unit", "_count", "_actions", "_config"]; _unit = _this select 0; diff --git a/addons/explosives/functions/fnc_openTriggerSelectionUI.sqf b/addons/explosives/functions/fnc_openTriggerSelectionUI.sqf index 3c3d07bb7f..011bda9bee 100644 --- a/addons/explosives/functions/fnc_openTriggerSelectionUI.sqf +++ b/addons/explosives/functions/fnc_openTriggerSelectionUI.sqf @@ -1,20 +1,18 @@ /* -* fnc_openTriggerSelectionUI.sqf -* -* Author: Garth 'L-H' de Wet -* Opens the UI for explosive trigger selection -* -* Arguments: -* 0: Explosive Magazine -* -* Return Value: -* None -* -* Example: -* [lbData [8866, lbCurSel 8866]] call ACE_Explosives_fnc_openTriggerSelectionUI; -* -* Public: No -*/ + * Author: Garth 'L-H' de Wet + * Opens the UI for explosive trigger selection + * + * Arguments: + * 0: Explosive Magazine + * + * Return Value: + * None + * + * Example: + * [lbData [8866, lbCurSel 8866]] call ACE_Explosives_fnc_openTriggerSelectionUI; + * + * Public: No + */ #include "script_component.hpp" private ["_magazine", "_hasRequiredItems","_triggerTypes", "_actions", "_detonators", "_required", "_magTriggers"]; _magazine = _this select 0; diff --git a/addons/explosives/functions/fnc_placeExplosive.sqf b/addons/explosives/functions/fnc_placeExplosive.sqf index dc6fbc7aec..1e1ac44bdf 100644 --- a/addons/explosives/functions/fnc_placeExplosive.sqf +++ b/addons/explosives/functions/fnc_placeExplosive.sqf @@ -1,27 +1,25 @@ /* -* fnc_placeExplosive.sqf -* -* Author: Garth 'L-H' de Wet -* Places an explosive at the requested position -* -* Arguments: -* 0: Unit -* 1: Position to place explosive -* 2: Rotation -* 3: Magazine class -* 4: Config of trigger -* 5: Variables required for the trigger type -* 6: Should direction be set -* -* Return Value: -* Placed explosive -* -* Example: -* _explosive = [player, player modelToWorld [0,0.5, 0.1], 134, -* "SatchelCharge_Remote_Mag", "Command", []] call ACE_Explosives_fnc_placeExplosive; -* -* Public: Yes -*/ + * Author: Garth 'L-H' de Wet + * Places an explosive at the requested position + * + * Arguments: + * 0: Unit + * 1: Position to place explosive + * 2: Rotation + * 3: Magazine class + * 4: Config of trigger + * 5: Variables required for the trigger type + * 6: Should direction be set + * + * Return Value: + * Placed explosive + * + * Example: + * _explosive = [player, player modelToWorld [0,0.5, 0.1], 134, + * "SatchelCharge_Remote_Mag", "Command", []] call ACE_Explosives_fnc_placeExplosive; + * + * Public: Yes + */ #include "script_component.hpp" private ["_pos", "_dir", "_magazineClass", "_ammo", "_triggerSpecificVars", "_unit", "_triggerConfig", "_explosive"]; _unit = _this select 0; diff --git a/addons/explosives/functions/fnc_place_Approve.sqf b/addons/explosives/functions/fnc_place_Approve.sqf index f771414f0b..97528cb8f6 100644 --- a/addons/explosives/functions/fnc_place_Approve.sqf +++ b/addons/explosives/functions/fnc_place_Approve.sqf @@ -1,21 +1,19 @@ /* -* fnc_place_Approve.sqf -* -* Author: Garth 'L-H' de Wet -* Approves placement of the explosive, releases the placement object for it -* to settle in a location suitable for the explosive to be created. -* -* Arguments: -* None -* -* Return Value: -* None -* -* Example: -* call ACE_Explosives_fnc_place_Approve; -* -* Public: No -*/ + * Author: Garth 'L-H' de Wet + * Approves placement of the explosive, releases the placement object for it + * to settle in a location suitable for the explosive to be created. + * + * Arguments: + * None + * + * Return Value: + * None + * + * Example: + * call ACE_Explosives_fnc_place_Approve; + * + * Public: No + */ #include "script_component.hpp" if (GVAR(pfeh_running)) then { [QGVAR(Placement),"OnEachFrame"] call CALLSTACK(BIS_fnc_removeStackedEventHandler); diff --git a/addons/explosives/functions/fnc_place_Cancel.sqf b/addons/explosives/functions/fnc_place_Cancel.sqf index 943af6c17b..c149d35584 100644 --- a/addons/explosives/functions/fnc_place_Cancel.sqf +++ b/addons/explosives/functions/fnc_place_Cancel.sqf @@ -1,20 +1,18 @@ /* -* fnc_place_Cancel.sqf -* -* Author: Garth 'L-H' de Wet -* Cancels placement of the explosive -* -* Arguments: -* None -* -* Return Value: -* None -* -* Example: -* call ACE_Explosives_fnc_place_Cancel; -* -* Public: Yes -*/ + * Author: Garth 'L-H' de Wet + * Cancels placement of the explosive + * + * Arguments: + * None + * + * Return Value: + * None + * + * Example: + * call ACE_Explosives_fnc_place_Cancel; + * + * Public: Yes + */ #include "script_component.hpp" if (GVAR(pfeh_running)) then { [QGVAR(Placement),"OnEachFrame"] call CALLSTACK(BIS_fnc_removeStackedEventHandler); diff --git a/addons/explosives/functions/fnc_selectTrigger.sqf b/addons/explosives/functions/fnc_selectTrigger.sqf index dcc2163191..8c51fd2c9c 100644 --- a/addons/explosives/functions/fnc_selectTrigger.sqf +++ b/addons/explosives/functions/fnc_selectTrigger.sqf @@ -1,21 +1,19 @@ /* -* fnc_selectTrigger.sqf -* -* Author: Garth 'L-H' de Wet -* Selects a trigger for an explosive. -* -* Arguments: -* 0: Magazine -* 1: Trigger mode -* -* Return Value: -* None -* -* Example: -* ["SatchelCharge_Remote_Mag","Timer"] call ACE_Explosives_fnc_selectTrigger; -* -* Public: No -*/ + * Author: Garth 'L-H' de Wet + * Selects a trigger for an explosive. + * + * Arguments: + * 0: Magazine + * 1: Trigger mode + * + * Return Value: + * None + * + * Example: + * ["SatchelCharge_Remote_Mag","Timer"] call ACE_Explosives_fnc_selectTrigger; + * + * Public: No + */ #include "script_component.hpp" private ["_magazine","_trigger"]; closeDialog 0; diff --git a/addons/explosives/functions/fnc_setPosition.sqf b/addons/explosives/functions/fnc_setPosition.sqf index 2295066c15..2f61c522aa 100644 --- a/addons/explosives/functions/fnc_setPosition.sqf +++ b/addons/explosives/functions/fnc_setPosition.sqf @@ -1,22 +1,20 @@ /* -* fnc_setPosition.sqf -* -* Author: Garth 'L-H' de Wet -* Sets the Dir and pitch of passed object -* -* Arguments: -* 0: Explosive -* 1: Direction -* 2: Pitch -* -* Return Value: -* None -* -* Example: -* [_explosive, 150, 90] call ACE_Explosives_fnc_SetPos; -* -* Public: Yes -*/ + * Author: Garth 'L-H' de Wet + * Sets the Dir and pitch of passed object + * + * Arguments: + * 0: Explosive + * 1: Direction + * 2: Pitch + * + * Return Value: + * None + * + * Example: + * [_explosive, 150, 90] call ACE_Explosives_fnc_SetPos; + * + * Public: Yes + */ #include "script_component.hpp" private "_ex"; _ex = _this select 0; diff --git a/addons/explosives/functions/fnc_setupExplosive.sqf b/addons/explosives/functions/fnc_setupExplosive.sqf index 04f1cc80a3..7f80ba7e63 100644 --- a/addons/explosives/functions/fnc_setupExplosive.sqf +++ b/addons/explosives/functions/fnc_setupExplosive.sqf @@ -1,23 +1,21 @@ /* -* fnc_setupExplosive.sqf -* -* Author: Garth 'L-H' de Wet -* Starts the setup process for the passed explosive. Player only. -* -* Arguments: -* 0: Unit -* 1: Classname of explosive to place. (CfgMagazine class) -* 2: Trigger Config -* 3: Timer (optional) -* -* Return Value: -* None -* -* Example: -* [player, "SatchelCharge_Remote_Mag", "Command"] call ACE_Explosives_fnc_SetupExplosive; -* -* Public: Yes -*/ + * Author: Garth 'L-H' de Wet + * Starts the setup process for the passed explosive. Player only. + * + * Arguments: + * 0: Unit + * 1: Classname of explosive to place. (CfgMagazine class) + * 2: Trigger Config + * 3: Timer (optional) + * + * Return Value: + * None + * + * Example: + * [player, "SatchelCharge_Remote_Mag", "Command"] call ACE_Explosives_fnc_SetupExplosive; + * + * Public: Yes + */ #include "script_component.hpp" private ["_unit", "_class", "_config", "_timer"]; _unit = _this select 0; diff --git a/addons/explosives/functions/fnc_startDefuse.sqf b/addons/explosives/functions/fnc_startDefuse.sqf index 47c43605a2..35e5e682df 100644 --- a/addons/explosives/functions/fnc_startDefuse.sqf +++ b/addons/explosives/functions/fnc_startDefuse.sqf @@ -1,21 +1,19 @@ /* -* fnc_startDefuse.sqf -* -* Author: Garth 'L-H' de Wet -* Starts defusing an explosive -* -* Arguments: -* 0: Unit -* 1: Target explosive -* -* Return Value: -* Nothing -* -* Example: -* [player, ACE_Interaction_Target] call ACE_Explosives_fnc_StartDefuse; -* -* Public: Yes -*/ + * Author: Garth 'L-H' de Wet + * Starts defusing an explosive + * + * Arguments: + * 0: Unit + * 1: Target explosive + * + * Return Value: + * Nothing + * + * Example: + * [player, ACE_Interaction_Target] call ACE_Explosives_fnc_StartDefuse; + * + * Public: Yes + */ #include "script_component.hpp" private ["_unit","_target"]; _unit = _this select 0; diff --git a/addons/explosives/functions/fnc_startTimer.sqf b/addons/explosives/functions/fnc_startTimer.sqf index 6317e0589e..f4b0876866 100644 --- a/addons/explosives/functions/fnc_startTimer.sqf +++ b/addons/explosives/functions/fnc_startTimer.sqf @@ -1,21 +1,19 @@ /* -* fnc_startTimer.sqf -* -* Author: Garth 'L-H' de Wet -* Starts a timer for an explosive. -* -* Arguments: -* 0: Explosive -* 1: Time till detonate -* -* Return Value: -* None -* -* Example: -* [_explosive, 10] call ACE_Explosives_fnc_startTimer; -* -* Public: Yes -*/ + * Author: Garth 'L-H' de Wet + * Starts a timer for an explosive. + * + * Arguments: + * 0: Explosive + * 1: Time till detonate + * + * Return Value: + * None + * + * Example: + * [_explosive, 10] call ACE_Explosives_fnc_startTimer; + * + * Public: Yes + */ #include "script_component.hpp" EXPLODE_2_PVT(_this,_explosive,_delay); diff --git a/addons/explosives/functions/fnc_triggerType.sqf b/addons/explosives/functions/fnc_triggerType.sqf index 96d1e96faf..4dba9a8d8e 100644 --- a/addons/explosives/functions/fnc_triggerType.sqf +++ b/addons/explosives/functions/fnc_triggerType.sqf @@ -1,20 +1,18 @@ /* -* fnc_triggerType.sqf -* -* Author: Garth 'L-H' de Wet -* Gets the types of triggers associated with the explosive -* -* Arguments: -* 0: Explosive magazine -* -* Return Value: -* Supported triggers as CfgACE_Triggers config entries -* -* Example: -* _supports = ["SatchelCharge_Remote_Mag"] call ACE_Explosives_fnc_TriggerType -* -* Public: Yes -*/ + * Author: Garth 'L-H' de Wet + * Gets the types of triggers associated with the explosive + * + * Arguments: + * 0: Explosive magazine + * + * Return Value: + * Supported triggers as CfgACE_Triggers config entries + * + * Example: + * _supports = ["SatchelCharge_Remote_Mag"] call ACE_Explosives_fnc_TriggerType + * + * Public: Yes + */ #include "script_component.hpp" private "_result"; _result = [];