Add fire mode option to Suppressive Fire module (#677)

mharis001 · Kexanone · web-flow · commit f48293748ccf · 2022-08-29T17:18:09.000-04:00
* Add fire mode option to Suppressive Fire module

* Add German translations

Co-authored-by: Kex &lt;kexanone@gmail.com&gt;
diff --git a/addons/ai/functions/fnc_suppressiveFire.sqf b/addons/ai/functions/fnc_suppressiveFire.sqf
@@ -9,7 +9,16 @@
  * 1: Target <OBJECT|ARRAY>
  *   - Position must be in ATL format.
  * 2: Duration <NUMBER> (default: 20)
- * 3: Stance <STRING> (default: "AUTO")
+ * 3: Fire Mode <NUMBER> (default: 4)
+ *   - 0: Single shots (slow).
+ *   - 1: Single shots (fast).
+ *   - 2: Three round bursts (slow).
+ *   - 3: Three round bursts (fast).
+ *   - 4: Fully automatic (with pauses).
+ *   - 5: Fully automatic (uninterrupted).
+ *   - May not apply to weapons limited by long ammo reloading times.
+ * 4: Stance <STRING> (default: "AUTO")
+ *   - Must be one of the modes used by the setUnitPos command.
  *
  * Return Value:
  * None
@@ -27,6 +36,7 @@ params [
     ["_unit", objNull, [objNull, grpNull]],
     ["_target", [0, 0, 0], [[], objNull], 3],
     ["_duration", 20, [0]],
+    ["_fireMode", 4, [0]],
     ["_stance", "AUTO", [""]]
 ];
 
@@ -36,7 +46,7 @@ if (!local _unit) exitWith {
 
 if (_unit isEqualType grpNull) exitWith {
     {
-        [_x, _target, _duration, _stance] call FUNC(suppressiveFire);
+        [_x, _target, _duration, _fireMode, _stance] call FUNC(suppressiveFire);
     } forEach units _unit;
 };
 
@@ -101,6 +111,16 @@ _unit lookAt _target;
 _unit doWatch _target;
 _unit doTarget _target;
 
+// Get the rounds per burst and time between bursts based on the given fire mode
+[
+    [1, [2, 3, 4]],
+    [1, [1, 1.5, 2]],
+    [3, [2, 3, 4]],
+    [3, [1, 1.5, 2]],
+    [10, [1.25, 1.5, 1.75]],
+    [10, [0, 0, 0]]
+] select (0 max _fireMode min 5) params ["_roundsPerBurst", "_burstDelay"];
+
 // Force the unit to fire their weapon for the specified duration. Works better than using the doSuppressiveFire
 // command which does not make units realiably fire at the target, especially at longer distances. Small initial
 // delay to give units time to aim at the target. We ignore reloading and give units infinite ammo to create a
@@ -109,7 +129,21 @@ private _endTime = CBA_missionTime + _duration + TARGETING_DELAY;
 
 [{
     [{
-        params ["_unit", "_target", "_isTempTarget", "_abilities", "_skills", "_behaviour", "_combatMode", "_unitPos", "_shotTime", "_endTime"];
+        params [
+            "_unit",
+            "_target",
+            "_isTempTarget",
+            "_abilities",
+            "_skills",
+            "_behaviour",
+            "_combatMode",
+            "_unitPos",
+            "_roundsPerBurst",
+            "_burstDelay",
+            "_currentBurstRounds",
+            "_shotTime",
+            "_endTime"
+        ];
 
         if (
             !alive _unit
@@ -144,63 +178,79 @@ private _endTime = CBA_missionTime + _duration + TARGETING_DELAY;
 
         if (CBA_missionTime >= _shotTime) then {
             private _vehicle = vehicle _unit;
+            private _turretPath = _vehicle unitTurret _unit;
 
-            if (_vehicle == _unit) exitWith {
-                weaponState _unit params ["_weapon", "_muzzle", "_fireMode"];
-
-                _unit setAmmo [_weapon, 1e6];
-                _unit forceWeaponFire [_muzzle, _fireMode];
-                _this set [8, CBA_missionTime + 0.1];
-            };
-
-            if (_unit call EFUNC(common,isUnitFFV)) exitWith {
-                // Using UseMagazine action since forceWeaponFire command does not work for FFV units
-                // UseMagazine action doesn't seem to work with currently loaded magazine (currentMagazineDetail)
-                // Therefore, this relies on the unit having an extra magazine in their inventory
-                // but should be fine in most situations
-                private _weapon = currentWeapon _unit;
-                private _compatibleMagazines = _weapon call CBA_fnc_compatibleMagazines;
-                private _index = magazines _unit findIf {_x in _compatibleMagazines};
-                if (_index == -1) exitWith {};
-
-                private _magazine = magazinesDetail _unit select _index;
-                _magazine call EFUNC(common,parseMagazineDetail) params ["_id", "_owner"];
-
-                _unit setAmmo [_weapon, 1e6];
-                CBA_logic action ["UseMagazine", _unit, _unit, _owner, _id];
-                _this set [8, CBA_missionTime + 0.1];
-            };
+            switch (true) do {
+                // On foot
+                case (_vehicle == _unit): {
+                    weaponState _unit params ["_weapon", "_muzzle", "_fireMode"];
 
-            private _turretPath = _vehicle unitTurret _unit;
-            private _muzzle = weaponState [_vehicle, _turretPath] select 1;
-            _unit setAmmo [_muzzle, 1e6];
+                    _unit setAmmo [_weapon, 1e6];
+                    _unit forceWeaponFire [_muzzle, _fireMode];
+                };
 
-            // Get the reload time for the current weapon state
-            weaponState [_vehicle, _turretPath] params ["_weapon", "_muzzle", "_fireMode", "_magazine", "_ammo"];
+                // FFV
+                case (_unit call EFUNC(common,isUnitFFV)): {
+                    // Using UseMagazine action since forceWeaponFire command does not work for FFV units
+                    // UseMagazine action doesn't seem to work with currently loaded magazine (currentMagazineDetail)
+                    // Therefore, this relies on the unit having an extra magazine in their inventory
+                    // but should be fine in most situations
+                    private _weapon = currentWeapon _unit;
+                    private _compatibleMagazines = _weapon call CBA_fnc_compatibleMagazines;
+                    private _index = magazines _unit findAny _compatibleMagazines;
+                    if (_index == -1) exitWith {};
+
+                    private _magazine = magazinesDetail _unit select _index;
+                    _magazine call EFUNC(common,parseMagazineDetail) params ["_id", "_owner"];
+
+                    _unit setAmmo [_weapon, 1e6];
+                    CBA_logic action ["UseMagazine", _unit, _unit, _owner, _id];
+                };
 
-            private _config = configFile >> "CfgWeapons" >> _weapon;
+                // Vehicle gunner
+                default {
+                    private _muzzle = weaponState [_vehicle, _turretPath] select 1;
+                    _unit setAmmo [_muzzle, 1e6];
 
-            if (_muzzle != _weapon) then {
-                _config = _config >> _muzzle;
+                    private _magazine = _vehicle currentMagazineDetailTurret _turretPath;
+                    _magazine call EFUNC(common,parseMagazineDetail) params ["_id", "_owner"];
+                    _vehicle action ["UseMagazine", _vehicle, _unit, _owner, _id];
+                };
             };
 
-            if (_muzzle != _fireMode) then {
-                _config = _config >> _fireMode;
-            };
+            // Set time until the next shot based on the weapon's ammo reloading time and whether the current burst is finished
+            private _reloadTime = [_vehicle, _turretPath] call EFUNC(common,getWeaponReloadTime);
+            _currentBurstRounds = _currentBurstRounds + 1;
 
-            private _reloadTime = getNumber (_config >> "reloadTime");
+            if (_currentBurstRounds >= _roundsPerBurst) then {
+                _currentBurstRounds = 0;
 
-            // Find the correct magazine id and owner and force the weapon to fire
-            {
-                _x params ["_xMagazine", "_xTurretPath", "_xAmmo", "_id", "_owner"];
+                // Calculate the delay until the next burst
+                // Use ammo reloading time if it is longer to prevent firing before the weapon is ready
+                private _nextBurstDelay = random _burstDelay max _reloadTime;
+                _shotTime = CBA_missionTime + _nextBurstDelay;
+            } else {
+                _shotTime = CBA_missionTime + _reloadTime;
+            };
 
-                if (_xTurretPath isEqualTo _turretPath && {_xMagazine == _magazine && {_xAmmo == _ammo && {_xAmmo != 0}}}) exitWith {
-                    _vehicle action ["UseMagazine", _vehicle, _unit, _owner, _id];
-                    _this set [8, CBA_missionTime + _reloadTime];
-                };
-            } forEach magazinesAllTurrets _vehicle;
+            _this set [10, _currentBurstRounds];
+            _this set [11, _shotTime];
         };
 
         false // Continue
     }, {}, _this] call CBA_fnc_waitUntilAndExecute;
-}, [_unit, _target, _isTempTarget, _abilities, _skills, _behaviour, _combatMode, _unitPos, 0, _endTime], TARGETING_DELAY] call CBA_fnc_waitAndExecute;
+}, [
+    _unit,
+    _target,
+    _isTempTarget,
+    _abilities,
+    _skills,
+    _behaviour,
+    _combatMode,
+    _unitPos,
+    _roundsPerBurst,
+    _burstDelay,
+    0, // _currentBurstRounds
+    0, // _shotTime
+    _endTime
+], TARGETING_DELAY] call CBA_fnc_waitAndExecute;
diff --git a/addons/common/functions/fnc_fireVLS.sqf b/addons/common/functions/fnc_fireVLS.sqf
@@ -36,7 +36,7 @@ if (_position isEqualType "") then {
 };
 
 private _muzzle = (_unit weaponsTurret GUNNER_TURRET) param [0, ""];
-private _reloadTime = [_unit, _muzzle, GUNNER_TURRET] call FUNC(getWeaponReloadTime);
+private _reloadTime = [_unit, GUNNER_TURRET, _muzzle] call FUNC(getWeaponReloadTime);
 
 // Load magazine even if it is the right one in order to ignore a possible reload occurring at the same time
 [_unit, GUNNER_TURRET, _muzzle, _magazine] call FUNC(loadMagazineInstantly);
diff --git a/addons/common/functions/fnc_getWeaponReloadTime.sqf b/addons/common/functions/fnc_getWeaponReloadTime.sqf
@@ -1,49 +1,48 @@
 #include "script_component.hpp"
 /*
  * Author: Kex
- * Returns the ammo reloading time of the given weapon.
+ * Returns the ammo reloading time of the given weapon or muzzle.
  *
  * Arguments:
  * 0: Unit or Vehicle <OBJECT>
- * 1: Muzzle <STRING>
- * 2: Turret Path <ARRAY>
+ * 1: Turret Path <ARRAY> (default: [0])
+ *   - Only used if the given entity is a vehicle.
+ * 2: Weapon or Muzzle <STRING> (default: "")
+ *   - Use "" for current weapon.
  *
  * Return Value:
  * Reload Time <NUMBER>
  *
  * Example:
- * [_unit, "arifle_MX_ACO_pointer_F"] call zen_common_fnc_getWeaponReloadTime
+ * [_unit, "arifle_MX_F"] call zen_common_fnc_getWeaponReloadTime
  *
  * Public: No
  */
 
-params [["_entity", objNull, [objNull]], ["_muzzle", "", [""]], ["_turretPath", [], [[]]]];
+params [
+    ["_entity", objNull, [objNull]],
+    ["_turretPath", [0], [[]]],
+    ["_weaponOrMuzzle", "", [""]]
+];
 
-// Get the weapon mode
-private "_state";
-
-if (_entity isKindOf "CAManBase") then {
-    // Need to set the desired muzzle in order to get the correct fire mode
-    private _currentMuzzle = weaponState _entity select 1;
-    _entity selectWeapon _muzzle;
-    _state = weaponState _entity;
-
-    // Restore the original muzzle
-    _entity selectWeapon _currentMuzzle;
+// Get given weapon or muzzle's current state
+private _state = if (_entity isKindOf "CAManBase") then {
+    _entity weaponState _weaponOrMuzzle
 } else {
-    _state = weaponState [_entity, _turretPath, _muzzle];
+    weaponState [_entity, _turretPath, _weaponOrMuzzle]
 };
 
-_state params ["_weapon", "", "_mode"];
+_state params ["_weapon", "_muzzle", "_fireMode"];
 
+// Get ammo reloading time
 private _config = configFile >> "CfgWeapons" >> _weapon;
 
 if (_muzzle != _weapon) then {
     _config = _config >> _muzzle;
 };
 
-if (_mode != "this") then {
-    _config = _config >> _mode;
+if (_muzzle != _fireMode) then {
+    _config = _config >> _fireMode;
 };
 
 getNumber (_config >> "reloadTime")
diff --git a/addons/main/script_mod.hpp b/addons/main/script_mod.hpp
@@ -10,7 +10,7 @@
 #define VERSION_AR  MAJOR,MINOR,PATCHLVL,BUILD
 
 // MINIMAL required version for the Mod. Components can specify others..
-#define REQUIRED_VERSION 2.08
+#define REQUIRED_VERSION 2.10
 #define REQUIRED_CBA_VERSION {3,15,5}
 
 #ifdef COMPONENT_BEAUTIFIED
diff --git a/addons/modules/functions/fnc_moduleSuppressiveFire.sqf b/addons/modules/functions/fnc_moduleSuppressiveFire.sqf
@@ -42,6 +42,22 @@ if !(side group _unit in [west, east, independent, civilian]) exitWith {
         [ELSTRING(common,Duration_Units), LSTRING(SuppressiveFire_Duration_Tooltip)],
         [10, 180, 20, 0]
     ],
+    [
+        "COMBO",
+        LSTRING(SuppressiveFire_FireMode_SingleShotSlow),
+        [
+            [],
+            [
+                LSTRING(SuppressiveFire_FireMode_SingleShotsSlow),
+                LSTRING(SuppressiveFire_FireMode_SingleShotsFast),
+                LSTRING(SuppressiveFire_FireMode_ThreeRoundBurstsSlow),
+                LSTRING(SuppressiveFire_FireMode_ThreeRoundBurstsFast),
+                LSTRING(SuppressiveFire_FireMode_FullyAutomaticWithPauses),
+                LSTRING(SuppressiveFire_FireMode_FullyAutomaticUninterrupted)
+            ],
+            4
+        ]
+    ],
     [
         "COMBO",
         ["STR_A3_RscAttributeUnitPos_Title", LSTRING(SuppressiveFire_Stance_Tooltip)],
@@ -66,23 +82,23 @@ if !(side group _unit in [west, east, independent, civilian]) exitWith {
     ]
 ], {
     params ["_values", "_unit"];
-    _values params ["_duration", "_stance", "_entireGroup"];
+    _values params ["_duration", "_fireMode", "_stance", "_entireGroup"];
 
     private _units = if (_entireGroup) then {units _unit} else {[_unit]};
     _units = _units apply {vehicle _x};
     _units = _units arrayIntersect _units;
 
     [_units, {
         params ["_successful", "_units", "_position", "_args"];
-        _args params ["_duration", "_stance"];
+        _args params ["_duration", "_fireMode", "_stance"];
 
         if (_successful) then {
             curatorMouseOver params ["_type", "_entity"];
 
             private _target = [ASLtoATL _position, _entity] select (_type == "OBJECT");
             {
-                [_x, _target, _duration, _stance] call EFUNC(ai,suppressiveFire);
+                [_x, _target, _duration, _fireMode, _stance] call EFUNC(ai,suppressiveFire);
             } forEach _units;
         };
-    }, [_duration, _stance], ELSTRING(ai,SuppressiveFire)] call EFUNC(common,selectPosition);
+    }, [_duration, _fireMode, _stance], ELSTRING(ai,SuppressiveFire)] call EFUNC(common,selectPosition);
 }, {}, _unit] call EFUNC(dialog,create);
diff --git a/addons/modules/stringtable.xml b/addons/modules/stringtable.xml
@@ -3237,6 +3237,34 @@
             <German>Kontrolliert die Zeit in Sekunden, in der die Einheit unterdrückt.</German>
             <Italian>Controlla la quantità di tempo, in secondi, per la quale le unità sopprimeranno.</Italian>
         </Key>
+        <Key ID="STR_ZEN_Modules_SuppressiveFire_FireMode">
+            <English>Fire Mode</English>
+            <German>Feuermodus</German>
+        </Key>
+        <Key ID="STR_ZEN_Modules_SuppressiveFire_FireMode_SingleShotsSlow">
+            <English>Single Shots (Slow)</English>
+            <German>Einzelfeuer (Langsam)</German>
+        </Key>
+        <Key ID="STR_ZEN_Modules_SuppressiveFire_FireMode_SingleShotsFast">
+            <English>Single Shots (Fast)</English>
+            <German>Einzelfeuer (Schnell)</German>
+        </Key>
+        <Key ID="STR_ZEN_Modules_SuppressiveFire_FireMode_ThreeRoundBurstsSlow">
+            <English>Three Round Bursts (Slow)</English>
+            <German>Feuerstoß (Langsam)</German>
+        </Key>
+        <Key ID="STR_ZEN_Modules_SuppressiveFire_FireMode_ThreeRoundBurstsFast">
+            <English>Three Round Bursts (Fast)</English>
+            <German>Feuerstoß (Schnell)</German>
+        </Key>
+        <Key ID="STR_ZEN_Modules_SuppressiveFire_FireMode_FullyAutomaticWithPauses">
+            <English>Fully Automatic (With Pauses)</English>
+            <German>Dauerfeuer (Mit Pausen)</German>
+        </Key>
+        <Key ID="STR_ZEN_Modules_SuppressiveFire_FireMode_FullyAutomaticUninterrupted">
+            <English>Fully Automatic (Uninterrupted)</English>
+            <German>Dauerfeuer (Ununterbrochen)</German>
+        </Key>
         <Key ID="STR_ZEN_Modules_SuppressiveFire_Stance_Tooltip">
             <English>Controls the stance units on foot will employ while suppressing.</English>
             <Japanese>ユニットは指定された体勢で、制圧射撃を行います。</Japanese>
