diff --git a/addons/explosives/XEH_postInit.sqf b/addons/explosives/XEH_postInit.sqf index fa775511ed..69a5643aad 100644 --- a/addons/explosives/XEH_postInit.sqf +++ b/addons/explosives/XEH_postInit.sqf @@ -1,20 +1,19 @@ /* - Name: XEH_postInit.sqf - - Author(s): - Garth de Wet (LH) - - Description: - Initialises explosive behaviour. - - Parameters: - None - - Returns: - None - - Example: - None +* 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 */ #include "script_component.hpp" if !(hasInterface) exitWith {}; diff --git a/addons/explosives/XEH_preInit.sqf b/addons/explosives/XEH_preInit.sqf index c55fb79a72..9b2db0a5b6 100644 --- a/addons/explosives/XEH_preInit.sqf +++ b/addons/explosives/XEH_preInit.sqf @@ -1,20 +1,19 @@ /* -Name: XEH_preInit.sqf - -Author(s): -Garth de Wet (LH) - -Description: -Prepares the functions - -Parameters: -None - -Returns: -None - -Example: -None +* XEH_preInit.sqf +* +* Author: Garth 'L-H' de Wet +* Initialises the explosives system +* +* Arguments: +* None +* +* Return Value: +* None +* +* Example: +* None +* +* Public: No */ #include "script_component.hpp" diff --git a/addons/explosives/functions/fnc_addClacker.sqf b/addons/explosives/functions/fnc_addClacker.sqf index c1f7b51c46..40ba6f58ae 100644 --- a/addons/explosives/functions/fnc_addClacker.sqf +++ b/addons/explosives/functions/fnc_addClacker.sqf @@ -1,23 +1,22 @@ /* - Name: ACE_Explosives_fnc_addClacker - - Author(s): - Garth de Wet (LH) - - Description: - Adds an explosive as a clacker item to the passed unit if the unit has a ACE_Clacker item. - - Parameters: - 0: OBJECT - unit - 1: OBJECT - Explosive - 2: STRING - Magazine - 3: ARRAY - Extra vars - - Returns: - Nothing - - Example: - [_unit, _explosive, "SatchelCharge_Remote_Mag", [ConfigFile >> "CfgACE_Triggers" >> "Command"]] call ACE_Explosives_fnc_AddClacker; +* 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 */ #include "script_component.hpp" private ["_unit", "_explosive", "_clacker", "_config", "_magazineClass", "_requiredItems", "_hasRequired"]; diff --git a/addons/explosives/functions/fnc_canDefuse.sqf b/addons/explosives/functions/fnc_canDefuse.sqf index c1bc4484cb..7c302e6e7a 100644 --- a/addons/explosives/functions/fnc_canDefuse.sqf +++ b/addons/explosives/functions/fnc_canDefuse.sqf @@ -1,19 +1,19 @@ /* - Name: ACE_Explosives_fnc_canDefuse - - Author: Garth de Wet (LH) - - Description: - Checks if a unit can defuse an explosive - - Parameters: - 0: OBJECT - unit - - Returns: - Nothing - - Example: - [player] call ACE_Explosives_fnc_CanDefuse; +* 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 */ #include "script_component.hpp" private "_unit"; @@ -24,7 +24,7 @@ _isSpecialist = [_unit] call EFUNC(Common,isEOD); if (GVAR(RequireSpecialist) && {!_isSpecialist}) exitWith {false}; _timeBombCore = nearestObject [_unit, "TimeBombCore"]; -_mineBase = nearestObject [_unit, "MineBase"]; +_mineBase = nearestObject [_unit, "MineBase"]; _distCore = _unit distance _timeBombCore; _distBase = _unit distance _mineBase; diff --git a/addons/explosives/functions/fnc_canDetonate.sqf b/addons/explosives/functions/fnc_canDetonate.sqf index 672dc4ca1a..7d81425c46 100644 --- a/addons/explosives/functions/fnc_canDetonate.sqf +++ b/addons/explosives/functions/fnc_canDetonate.sqf @@ -1,19 +1,19 @@ /* -Name: ACE_Explosives_fnc_canDetonate - -Author: Garth de Wet (LH) - -Description: -Checks if a unit can detonate an explosive - -Parameters: -0: OBJECT - unit - -Returns: -BOOLEAN - if the unit has explosives and detonators. - -Example: -[player] call ACE_Explosives_fnc_canDetonate; +* 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 */ #include "script_component.hpp" private "_unit"; diff --git a/addons/explosives/functions/fnc_defuseExplosive.sqf b/addons/explosives/functions/fnc_defuseExplosive.sqf index 243e6b44e0..09444009c0 100644 --- a/addons/explosives/functions/fnc_defuseExplosive.sqf +++ b/addons/explosives/functions/fnc_defuseExplosive.sqf @@ -1,20 +1,20 @@ /* - Name: ACE_Explosives_fnc_defuseExplosive - - Author: Garth de Wet (LH) - - Description: - Defuses an Explosive - - Parameters: - 0: OBJECT - unit - 1: OBJECT - Explosive - - Returns: - Nothing - - Example: - [player, ACE_Interaction_Target] call ACE_Explosives_fnc_defuseExplosive; +* 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 */ #include "script_component.hpp" private ["_unit", "_explosive"]; diff --git a/addons/explosives/functions/fnc_detonateExplosive.sqf b/addons/explosives/functions/fnc_detonateExplosive.sqf index 9443be6bc1..5d0d71c800 100644 --- a/addons/explosives/functions/fnc_detonateExplosive.sqf +++ b/addons/explosives/functions/fnc_detonateExplosive.sqf @@ -1,25 +1,24 @@ /* - Name: ACE_Explosives_fnc_detonateExplosive - - Author(s): - Garth de Wet (LH) - - Description: - Detonates a remote Explosive. - - Parameters: - 0: OBJECT - Unit detonating explosive - 1: NUMBER - Max range (-1 to ignore) - 2: ARRAY - Explosive - 0: OBJECT - Explosive - 1: NUMBER - Fuse Time - - Returns: - Nothing - - Example: - // Clacker - [player, 100, [Explosive, 1]] call ACE_Explosives_fnc_detonateExplosive; +* 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 */ #include "script_component.hpp" private ["_item","_result", "_ignoreRange", "_unit", "_range"]; @@ -44,8 +43,11 @@ if (getNumber (ConfigFile >> "CfgAmmo" >> typeof (_item select 0) >> "TriggerWhe _exp setPosASL _pos; }; }; -_item spawn { - sleep (_this select 1); - (_this select 0) setDamage 1; -}; +[{ + _explosive = _this; + if (!isNull _explosive) then { + _explosive setDamage 1; + }; +}, _item select 0, _item select 1, 0] call EFUNC(common,waitAndExecute); + _result diff --git a/addons/explosives/functions/fnc_getDetonators.sqf b/addons/explosives/functions/fnc_getDetonators.sqf index 77549c0e3b..b5146e8249 100644 --- a/addons/explosives/functions/fnc_getDetonators.sqf +++ b/addons/explosives/functions/fnc_getDetonators.sqf @@ -1,20 +1,19 @@ /* - Name: ACE_Explosives_fnc_getDetonators - - Author(s): - Garth de Wet (LH) - - Description: - Gets all the detonators of a specific unit - - Parameters: - 0: OBJECT - Unit to get detonators of - - Returns: - ARRAY - Configs of all detonators. - - Example: - _detonators = [player] call ACE_Explosives_fnc_getDetonators; +* 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 */ #include "script_component.hpp" private ["_unit", "_items", "_result", "_config"]; diff --git a/addons/explosives/functions/fnc_getPlacedExplosives.sqf b/addons/explosives/functions/fnc_getPlacedExplosives.sqf index 0343b76521..df449ac6af 100644 --- a/addons/explosives/functions/fnc_getPlacedExplosives.sqf +++ b/addons/explosives/functions/fnc_getPlacedExplosives.sqf @@ -1,21 +1,21 @@ /* - Name: ACE_Explosives_fnc_getPlacedExplosives - - Author: Garth de Wet (LH) - - Description: - Gets all placed explosives, whether Clacker based or not. - - Parameters: - 0: OBJECT - unit - 1: STRING - (OPTIONAL) Trigger classname for filter. - - Returns: - Array: Explosives. - - Example: - _allExplosives = [player] call ACE_Explosives_fnc_getPlacedExplosives; - _deadmanExplosives = [player, "DeadManSwitch"] call ACE_Explosives_fnc_getPlacedExplosives; +* 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 */ #include "script_component.hpp" private ["_unit", "_clackerList", "_adjustedList", "_list", "_filter"]; diff --git a/addons/explosives/functions/fnc_handleScrollWheel.sqf b/addons/explosives/functions/fnc_handleScrollWheel.sqf index ddc64010eb..b7de62c7a0 100644 --- a/addons/explosives/functions/fnc_handleScrollWheel.sqf +++ b/addons/explosives/functions/fnc_handleScrollWheel.sqf @@ -1,20 +1,19 @@ /* - Name: ACE_Explosives_fnc_HandleScrollWheel - - Author(s): - L-H - - Description: - Handles rotating of Explosives - - Parameters: - Number: Scroll amount - - Returns: - Boolean: Handled or not. - - Example: - 1.2 call ACE_Explosives_fnc_HandleScrollWheel; +* 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 */ #include "script_component.hpp" private ["_obj"]; diff --git a/addons/explosives/functions/fnc_hasExplosives.sqf b/addons/explosives/functions/fnc_hasExplosives.sqf index 79596b1b1e..cbcb3905c8 100644 --- a/addons/explosives/functions/fnc_hasExplosives.sqf +++ b/addons/explosives/functions/fnc_hasExplosives.sqf @@ -1,19 +1,19 @@ /* - Name: ACE_Explosives_fnc_hasExplosives - - Author: Garth de Wet (LH) - - Description: - Whether the passed unit has any explosives on them. - - Parameters: - 0: OBJECT - unit - - Returns: - BOOLEAN - True if the unit has explosives. - - Example: - _hasExplosives = [player] call ACE_Explosives_fnc_hasExplosives; +* 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 */ #include "script_component.hpp" private ["_unit", "_result", "_magazines"]; diff --git a/addons/explosives/functions/fnc_hasPlacedExplosives.sqf b/addons/explosives/functions/fnc_hasPlacedExplosives.sqf index ad6f29a02e..dd25795296 100644 --- a/addons/explosives/functions/fnc_hasPlacedExplosives.sqf +++ b/addons/explosives/functions/fnc_hasPlacedExplosives.sqf @@ -1,19 +1,19 @@ /* - Name: ACE_Explosives_fnc_hasPlacedExplosives - - Author: Garth de Wet (LH) - - Description: - Whether the passed unit has placed any explosives or has a clacker that was used when explosives were placed. - - Parameters: - 0: OBJECT - unit - - Returns: - BOOLEAN - True if the unit has explosives. - - Example: - _hasPLacedExplosives = [player] call ACE_Explosives_fnc_hasPlacedExplosives; +* 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 */ #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 415b537266..77762dc08b 100644 --- a/addons/explosives/functions/fnc_module.sqf +++ b/addons/explosives/functions/fnc_module.sqf @@ -1,19 +1,19 @@ /* - Name: ACE_Explosives_fnc_module - - Author: Garth de Wet (LH) - - Description: - Initialises the explosives module - - Parameters: - Things - - Returns: - Nothing - - Example: - +* 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 */ #include "script_component.hpp" if !(isServer) exitWith {}; diff --git a/addons/explosives/functions/fnc_openDetonateUI.sqf b/addons/explosives/functions/fnc_openDetonateUI.sqf index 84a874f677..4e8b854a79 100644 --- a/addons/explosives/functions/fnc_openDetonateUI.sqf +++ b/addons/explosives/functions/fnc_openDetonateUI.sqf @@ -1,20 +1,20 @@ /* - Name: ACE_Explosives_fnc_openDetonateUI - - Author: Garth de Wet (LH) - - Description: - Opens the UI for explosive detonation selection - - Parameters: - 0: OBJECT - unit - 0: STRING - Classname of detonator - - Returns: - Nothing - - Example: - [player, "ACE_M26_Clacker"] call ACE_Explosives_fnc_openDetonateUI; +* 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 */ #include "script_component.hpp" private ["_unit","_result", "_item"]; diff --git a/addons/explosives/functions/fnc_openPlaceUI.sqf b/addons/explosives/functions/fnc_openPlaceUI.sqf index af34f40236..791fe359d9 100644 --- a/addons/explosives/functions/fnc_openPlaceUI.sqf +++ b/addons/explosives/functions/fnc_openPlaceUI.sqf @@ -1,19 +1,19 @@ /* - Name: ACE_Explosives_fnc_openPlaceUI - - Author: Garth de Wet (LH) - - Description: - Opens the UI for explosive placement selection - - Parameters: - 0: OBJECT - unit - - Returns: - Nothing - - Example: - [player] call ACE_Explosives_fnc_openPlaceUI; +* 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 */ #include "script_component.hpp" private ["_unit","_mags", "_item", "_index", "_actions"]; diff --git a/addons/explosives/functions/fnc_openTimerSetUI.sqf b/addons/explosives/functions/fnc_openTimerSetUI.sqf index e686fc7539..c2969b5497 100644 --- a/addons/explosives/functions/fnc_openTimerSetUI.sqf +++ b/addons/explosives/functions/fnc_openTimerSetUI.sqf @@ -1,19 +1,19 @@ /* - Name: ACE_Explosives_fnc_openTimerSetUI - - Author: Garth de Wet (LH) - - Description: - Opens the UI for timer setting of an explosive - - Parameters: - 0: String - Magazine - - Returns: - Nothing - - Example: - [player] call ACE_Explosives_fnc_openTimerSetUI; +* 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 */ #include "script_component.hpp" private ["_mag"]; diff --git a/addons/explosives/functions/fnc_openTransmitterUI.sqf b/addons/explosives/functions/fnc_openTransmitterUI.sqf index 2311b6eea9..ffef790d7c 100644 --- a/addons/explosives/functions/fnc_openTransmitterUI.sqf +++ b/addons/explosives/functions/fnc_openTransmitterUI.sqf @@ -1,19 +1,19 @@ /* - Name: ACE_Explosives_fnc_openTransmitterUI - - Author: Garth de Wet (LH) - - Description: - Opens the UI for selecting the transmitter - - Parameters: - 0: OBJECT - Unit - - Returns: - Nothing - - Example: - [player] call ACE_Explosives_fnc_openTransmitterUI; +* 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 */ #include "script_component.hpp" private ["_items", "_unit", "_count", "_actions", "_config"]; diff --git a/addons/explosives/functions/fnc_openTriggerSelectionUI.sqf b/addons/explosives/functions/fnc_openTriggerSelectionUI.sqf index d51b0dc7f4..3c3d07bb7f 100644 --- a/addons/explosives/functions/fnc_openTriggerSelectionUI.sqf +++ b/addons/explosives/functions/fnc_openTriggerSelectionUI.sqf @@ -1,19 +1,19 @@ /* - Name: ACE_Explosives_fnc_openTriggerSelectionUI - - Author: Garth de Wet (LH) - - Description: - Opens the UI for explosive trigger selection - - Parameters: - 0: String - explosive magazine - - Returns: - Nothing - - Example: - [lbData [8866, lbCurSel 8866]] call ACE_Explosives_fnc_openTriggerSelectionUI; +* 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 */ #include "script_component.hpp" private ["_magazine", "_hasRequiredItems","_triggerTypes", "_actions", "_detonators", "_required", "_magTriggers"]; diff --git a/addons/explosives/functions/fnc_placeExplosive.sqf b/addons/explosives/functions/fnc_placeExplosive.sqf index f2198c6d0a..dc6fbc7aec 100644 --- a/addons/explosives/functions/fnc_placeExplosive.sqf +++ b/addons/explosives/functions/fnc_placeExplosive.sqf @@ -1,25 +1,26 @@ /* - Name: ACE_Explosives_fnc_PlaceExplosive - - Author(s): - Garth de Wet (LH) - - Description: - Places an explosive at the requested position - - Parameters: - 0: OBJECT - unit - 1: POSITION - Position to place explosive - 2: NUMBER - Rotation - 3: STRING - Magazine class - 4: Config - Config of trigger - 5: ARRAY - variables required for the trigger type - - Returns: - OBJECT: Placed explosive - - Example: - _explosive = [player, player modelToWorld [0,0.5, 0.1], 134, "SatchelCharge_Remote_Mag", "Command", []] call ACE_Explosives_fnc_PlaceExplosive; +* 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 */ #include "script_component.hpp" private ["_pos", "_dir", "_magazineClass", "_ammo", "_triggerSpecificVars", "_unit", "_triggerConfig", "_explosive"]; diff --git a/addons/explosives/functions/fnc_place_Approve.sqf b/addons/explosives/functions/fnc_place_Approve.sqf index c906aa777d..f771414f0b 100644 --- a/addons/explosives/functions/fnc_place_Approve.sqf +++ b/addons/explosives/functions/fnc_place_Approve.sqf @@ -1,20 +1,20 @@ /* - Name: ACE_Explosives_fnc_Place_Approve - - Author(s): - Garth de Wet (LH) - - Description: - Approves placement of the explosive, releases the placement object for it to settle in a location suitable for the explosive to be created. - - Parameters: - Nothing - - Returns: - Nothing - - Example: - call ACE_Explosives_fnc_Place_Approve; +* 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 */ #include "script_component.hpp" if (GVAR(pfeh_running)) then { diff --git a/addons/explosives/functions/fnc_place_Cancel.sqf b/addons/explosives/functions/fnc_place_Cancel.sqf index 3f56e35ff6..943af6c17b 100644 --- a/addons/explosives/functions/fnc_place_Cancel.sqf +++ b/addons/explosives/functions/fnc_place_Cancel.sqf @@ -1,20 +1,19 @@ /* - Name: ACE_Explosives_fnc_Place_Cancel - - Author(s): - Garth de Wet (LH) - - Description: - Cancels placement of the explosive - - Parameters: - Nothing - - Returns: - Nothing - - Example: - call ACE_Explosives_fnc_Place_Cancel; +* 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 */ #include "script_component.hpp" if (GVAR(pfeh_running)) then { diff --git a/addons/explosives/functions/fnc_selectTrigger.sqf b/addons/explosives/functions/fnc_selectTrigger.sqf index 0700fb5ad3..dcc2163191 100644 --- a/addons/explosives/functions/fnc_selectTrigger.sqf +++ b/addons/explosives/functions/fnc_selectTrigger.sqf @@ -1,20 +1,20 @@ /* - Name: ACE_Explosives_fnc_selectTrigger - - Author: Garth de Wet (LH) - - Description: - Selects a trigger for an explosive. - - Parameters: - 0: String - Magazine - 1: String - trigger index in ACE_triggers of magazine class - - Returns: - Nothing - - Example: - ["SatchelCharge_Remote_Mag","Timer"] call ACE_Explosives_fnc_selectTrigger; +* 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 */ #include "script_component.hpp" private ["_magazine","_trigger"]; diff --git a/addons/explosives/functions/fnc_setPosition.sqf b/addons/explosives/functions/fnc_setPosition.sqf index b195bf0562..2295066c15 100644 --- a/addons/explosives/functions/fnc_setPosition.sqf +++ b/addons/explosives/functions/fnc_setPosition.sqf @@ -1,26 +1,25 @@ /* - Name: ACE_Explosives_fnc_SetPos - - Author(s): - Garth de Wet (LH) - - Description: - Sets the Dir and pitch - - Parameters: - 0: OBJECT - Object - 1: NUMBER - Direction - 2: NUMBER - Pitch - - Returns: - Nothing - - Example: - [_explosive, 150, 90] call ACE_Explosives_fnc_SetPos; +* 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 */ #include "script_component.hpp" private "_ex"; -_ex=_this select 0; +_ex = _this select 0; _ex setDir (_this select 1); if ((_this select 2) != 0) then { [_ex, _this select 2, 0] call CALLSTACK(BIS_fnc_setPitchBank); diff --git a/addons/explosives/functions/fnc_setupExplosive.sqf b/addons/explosives/functions/fnc_setupExplosive.sqf index 8221109838..04f1cc80a3 100644 --- a/addons/explosives/functions/fnc_setupExplosive.sqf +++ b/addons/explosives/functions/fnc_setupExplosive.sqf @@ -1,23 +1,22 @@ /* - Name: ACE_Explosives_fnc_SetupExplosive - - Author(s): - Garth de Wet (LH) - - Description: - Starts the setup process for the passed explosive. - - Parameters: - 0: OBJECT - Unit placing explosive. - 1: STRING - Classname of explosive to place. (CfgMagazine class) - 2: Config - Trigger Config - 3: NUMBER - (optional) timer - - Returns: - Nothing - - Example: - [player, "SatchelCharge_Remote_Mag", "Command"] call ACE_Explosives_fnc_SetupExplosive; +* 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 */ #include "script_component.hpp" private ["_unit", "_class", "_config", "_timer"]; diff --git a/addons/explosives/functions/fnc_startDefuse.sqf b/addons/explosives/functions/fnc_startDefuse.sqf index 7213da531c..47c43605a2 100644 --- a/addons/explosives/functions/fnc_startDefuse.sqf +++ b/addons/explosives/functions/fnc_startDefuse.sqf @@ -1,20 +1,20 @@ /* - Name: ACE_Explosives_fnc_StartDefuse - - Author: Garth de Wet (LH) - - Description: - Starts defusing an explosive - - Parameters: - 0: OBJECT - Unit to defuse explosive - 1: OBJECT - Target explosive - - Returns: - Nothing - - Example: - [player, ACE_Interaction_Target] call ACE_Explosives_fnc_StartDefuse; +* 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 */ #include "script_component.hpp" private ["_unit","_target"]; diff --git a/addons/explosives/functions/fnc_startTimer.sqf b/addons/explosives/functions/fnc_startTimer.sqf index e5c8bdee75..6317e0589e 100644 --- a/addons/explosives/functions/fnc_startTimer.sqf +++ b/addons/explosives/functions/fnc_startTimer.sqf @@ -1,19 +1,20 @@ /* - Author(s): - Garth de Wet (LH) - - Description: - Starts a timer for an explosive. - - Parameters: - 0: OBJECT - Explosive - 1: NUMBER - time till detonation - - Returns: - Nothing - - Example: - [_explosive, 10] call ACE_Explosives_fnc_startTimer; +* 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 */ #include "script_component.hpp" @@ -24,4 +25,4 @@ EXPLODE_2_PVT(_this,_explosive,_delay); if (!isNull _explosive) then { [_explosive, -1, [_explosive, 0], true] call FUNC(detonateExplosive); }; -}, _explosive, _delay, 0] call EFUNC(common,waitAndExecute); \ No newline at end of file +}, _explosive, _delay, 0] call EFUNC(common,waitAndExecute); diff --git a/addons/explosives/functions/fnc_triggerType.sqf b/addons/explosives/functions/fnc_triggerType.sqf index dead725a7a..96d1e96faf 100644 --- a/addons/explosives/functions/fnc_triggerType.sqf +++ b/addons/explosives/functions/fnc_triggerType.sqf @@ -1,20 +1,19 @@ /* - Name: ACE_Explosives_fnc_TriggerType - - Author(s): - Garth de Wet (LH) - - Description: - Gets the types of triggers associated with the explosive - - Parameters: - 0: String - Explosive magazine - - Returns: - ARRAY - - Example: - _supports = ["SatchelCharge_Remote_Mag"] call ACE_Explosives_fnc_TriggerType; +* 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 */ #include "script_component.hpp" private "_result";