Overheating - Add cook off and rate of fire features and additional c…

…ustomization settings (acemod#8064) * Add jamming coef to change or disable jamming. * change max to 5 * add setting for overheating effects distance, unjaming on barrel swap, increase rate of fire with heat - add setting for overheating effects distance - add unjaming on barrel swap, with setting - add increase rate of fire with heat, with setting - fix some formatting * little tweaks * add overheating cookoff feature - add overheating cookoff feature - add documentation - bugfixes/improvements * Update ace3-config-entries.md * Update overheating-framework.md * Update addons/overheating/XEH_postInit.sqf Co-authored-by: jonpas <jonpas33@gmail.com> * Update addons/overheating/XEH_postInit.sqf Co-authored-by: jonpas <jonpas33@gmail.com> * Update addons/overheating/functions/fnc_firedEH.sqf Co-authored-by: jonpas <jonpas33@gmail.com> * Update addons/overheating/stringtable.xml Co-authored-by: jonpas <jonpas33@gmail.com> * Update docs/wiki/feature/overheating.md Co-authored-by: jonpas <jonpas33@gmail.com> * Update addons/overheating/stringtable.xml Co-authored-by: jonpas <jonpas33@gmail.com> * Update addons/overheating/functions/fnc_jamWeapon.sqf Co-authored-by: jonpas <jonpas33@gmail.com> * Update addons/overheating/functions/fnc_jamWeapon.sqf Co-authored-by: jonpas <jonpas33@gmail.com> * remove extra underwater cooling, make cookoffCoef enable cookoff - add coef setting for heat generation per shot - merge cookoff setting into cookoff coef setting - remove check for water that increased cooling - change max rof increase from heat to 10% - change ammo heating to a less linear formula - change cookoffCoef to effect inginition tempurature instead of heat amount - delay cookoff shot until any firing animation is done - update strings based on feedback * Update stringtable.xml * add cookoff notification * improvements from play testing - move ammo heat loop into seperate function with a tighter loop - factor rain into cooling calculation - handle cooling while swimming - merge cookoff take event handler into fnc_handleTakeEH - fix case where cookoff could potentially come from underbarrel weapon muzzle - only add TakeEH if required by enabled settings - improve cookoff muzzle/mode handling * fix missing semi that I swear I already fixed before pushing * Update overheating-framework.md * Update fnc_updateAmmoTemperature.sqf * include wind speed in cooling calculation * cool with X - add ace interactions to allow cooling with water sources when Ace X is loaded - add documentation for cooling - move getting barrel mass to a function * documentation formatting * Add config array for weapon jam types, as not all weapon can get all types IRL. * remove variable that's not required * add some compat entries for RHS * fix merge conflict * fix a happy little accident * move to CBA settings, minor styling. * Update error message in fnc_jamWeapon.sqf Co-authored-by: jonpas <jonpas33@gmail.com> * Apply suggestions from code review Co-authored-by: TyroneMF <TyroneMF@hotmail.com> Co-authored-by: jonpas <jonpas33@gmail.com> Co-authored-by: TyroneMF <TyroneMF@hotmail.com>
AndreasBrostrom · Dec 3, 2021 · 316d121 · 316d121
1 parent ce7abff
commit 316d121
Show file tree

Hide file tree

Showing 35 changed files with 958 additions and 105 deletions.
diff --git a/addons/overheating/ACE_Settings.hpp b/addons/overheating/ACE_Settings.hpp
@@ -2,6 +2,9 @@ class ACE_Settings {
     class GVAR(enabled) {
         movedToSQF = 1;
     };
+    class GVAR(heatCoef) {
+        movedToSQF = 1;
+    };
     class GVAR(showParticleEffects) {
         movedToSQF = 1;
     };
@@ -11,13 +14,28 @@ class ACE_Settings {
     class GVAR(overheatingDispersion) {
         movedToSQF = 1;
     };
+    class GVAR(particleEffectsAndDispersionDistance) {
+        movedToSQF = 1;
+    };
+    class GVAR(overheatingRateOfFire) {
+        movedToSQF = 1;
+    };
     class GVAR(displayTextOnJam) {
         movedToSQF = 1;
     };
-    class GVAR(unJamOnreload) {
+    class GVAR(jamChanceCoef) {
+        movedToSQF = 1;
+    };
+    class GVAR(unJamOnReload) {
+        movedToSQF = 1;
+    };
+    class GVAR(unJamOnSwapBarrel) {
         movedToSQF = 1;
     };
     class GVAR(unJamFailChance) {
         movedToSQF = 1;
     };
+    class GVAR(cookoffCoef) {
+        movedToSQF = 1;
+    };
 };
diff --git a/addons/overheating/CfgSounds.hpp b/addons/overheating/CfgSounds.hpp
@@ -23,4 +23,26 @@ class CfgSounds {
         sound[]={QPATHTOF(sounds\fixing_pistol.wav),1,1};
         titles[]={};
     };
+    /* // to be added when licence compatible audio can be found or recorded
+    class GVAR(pouring_long) {
+        name= QGVAR(pouring_long);
+        sound[]={QPATHTOF(sounds\pouring_long.ogg),5,1};
+        titles[]={};
+    };
+    class GVAR(pouring_short) {
+        name= QGVAR(pouring_short);
+        sound[]={QPATHTOF(sounds\pouring_short.ogg),5,1};
+        titles[]={};
+    };
+    class GVAR(sizzling_long) {
+        name= QGVAR(sizzling_long);
+        sound[]={QPATHTOF(sounds\sizzling_long.ogg),5,1};
+        titles[]={};
+    };
+    class GVAR(sizzling_short) {
+        name= QGVAR(sizzling_short);
+        sound[]={QPATHTOF(sounds\sizzling_short.ogg),5,1};
+        titles[]={};
+    };
+    */
 };
diff --git a/addons/overheating/CfgVehicles.hpp b/addons/overheating/CfgVehicles.hpp
@@ -36,6 +36,15 @@ class CfgVehicles {
                     showDisabled = 0;
                     icon = QUOTE(PATHTOF(UI\temp_ca.paa));
                 };
+                class GVAR(CoolWeaponWithItem) {
+                    displayName = CSTRING(CoolWeaponWithItem);
+                    condition = QUOTE(GVAR(enabled) && {isClass(configfile >> 'CfgPatches' >> 'acex_field_rations')});
+                    exceptions[] = {"isNotInside", "isNotSwimming", "isNotSitting"};
+                    statement = "true";
+                    showDisabled = 0;
+                    insertChildren = QUOTE(_player call FUNC(getConsumableChildren));
+                    icon = QPATHTOF(UI\pour_water_ca.paa);
+                };
             };
         };
 
@@ -55,6 +64,15 @@ class CfgVehicles {
                     statement = QUOTE( [ARR_3(_player, _target, currentWeapon _target)] call FUNC(checkTemperature); );
                     icon = QUOTE(PATHTOF(UI\temp_ca.paa));
                 };
+                class GVAR(CoolWeaponWithItem) {
+                    displayName = CSTRING(CoolWeaponWithItem);
+                    condition = QUOTE(GVAR(enabled) && {isClass(configfile >> 'CfgPatches' >> 'acex_field_rations')});
+                    exceptions[] = {"isNotInside", "isNotSwimming", "isNotSitting"};
+                    statement = "true";
+                    showDisabled = 0;
+                    insertChildren = QUOTE(_player call FUNC(getConsumableChildren));
+                    icon = QPATHTOF(UI\pour_water_ca.paa);
+                };
             };
         };
     };

diff --git a/addons/overheating/CfgWeapons.hpp b/addons/overheating/CfgWeapons.hpp
@@ -1,4 +1,19 @@
 class CfgWeapons {
+    class PistolCore;
+    class Pistol : PistolCore {
+        //Closed Bolt (Closed Bolt will cook off if too hot)
+        //Pistols are nearly universally closed bolt.
+        GVAR(closedBolt) = 1;
+    };
+
+    class Pistol_Base_F : Pistol {};
+    class hgun_Pistol_heavy_02_F : Pistol_Base_F {
+        GVAR(jamTypesAllowed) = ["Fire","Dud"];
+    };
+   class hgun_Pistol_Signal_F : Pistol_Base_F {
+        GVAR(jamTypesAllowed) = ["Fire","Dud"];
+    };
+
     class RifleCore;
     class Rifle: RifleCore {
         //Mean Rounds Between Stoppages (this will be scaled based on the barrel temp)
@@ -9,10 +24,17 @@ class CfgWeapons {
 
         //Slowdown Factor (this will be scaled based on the barrel temp)
         GVAR(slowdownFactor) = 1;
+
+        //Closed Bolt, most weapons are closed bolt
+        GVAR(closedBolt) = 1;
     };
     class Rifle_Base_F;
     class Rifle_Long_Base_F: Rifle_Base_F {
         GVAR(dispersion) = 0.75;
+
+        // Open Bolt, most machine guns are open bolt, which cannot normally cook off, and use this as a parent class
+        // A lot of sniper rifles also use this as a parent class, they will need to be indivisually set to closed bolt, but it's probably not an issue as they are unlikely to overheat
+        GVAR(closedBolt) = 0;
     };
 
     class arifle_MX_Base_F: Rifle_Base_F {
@@ -26,6 +48,36 @@ class CfgWeapons {
         GVAR(allowSwapBarrel) = 1;
         GVAR(dispersion) = 0.75;
     };
+    class DMR_01_base_F : Rifle_Long_Base_F {
+        GVAR(closedBolt) = 1;
+    };
+    class DMR_02_base_F : Rifle_Long_Base_F {
+        GVAR(closedBolt) = 1;
+    };
+    class DMR_03_base_F : Rifle_Long_Base_F {
+        GVAR(closedBolt) = 1;
+    };
+    class DMR_04_base_F : Rifle_Long_Base_F {
+        GVAR(closedBolt) = 1;
+    };
+    class DMR_05_base_F : Rifle_Long_Base_F {
+        GVAR(closedBolt) = 1;
+    };
+    class DMR_06_base_F : Rifle_Long_Base_F {
+        GVAR(closedBolt) = 1;
+    };
+    class DMR_07_base_F : Rifle_Long_Base_F {
+        GVAR(closedBolt) = 1;
+    };
+    class EBR_base_F : Rifle_Long_Base_F {
+        GVAR(closedBolt) = 1;
+    };
+    class GM6_base_F : Rifle_Long_Base_F {
+        GVAR(closedBolt) = 1;
+    };
+    class LRR_base_F : Rifle_Long_Base_F {
+        GVAR(closedBolt) = 1;
+    };
     class MMG_01_base_F: Rifle_Long_Base_F {
         GVAR(allowSwapBarrel) = 1;
     };
@@ -41,6 +93,10 @@ class CfgWeapons {
     class LMG_03_Base_F: Rifle_Long_Base_F {
         GVAR(allowSwapBarrel) = 1;
     };
+    class sgun_HunterShotgun_01_base_F : Rifle_Long_Base_F {
+        GVAR(closedBolt) = 1;
+        GVAR(jamTypesAllowed) = ["Fire","Dud"];
+    };
     class ACE_ItemCore;
     class CBA_MiscItem_ItemInfo;
     class ACE_SpareBarrel_Item: ACE_ItemCore {

diff --git a/addons/overheating/UI/pour_water_ca.paa b/addons/overheating/UI/pour_water_ca.paa
diff --git a/addons/overheating/XEH_PREP.hpp b/addons/overheating/XEH_PREP.hpp
@@ -6,8 +6,12 @@ PREP(canCheckSpareBarrelsTemperatures);
 PREP(checkSpareBarrelsTemperatures);
 PREP(checkTemperature);
 PREP(clearJam);
+PREP(coolWeaponWithItem);
+PREP(coolWeaponWithWaterSource);
 PREP(displayTemperature);
 PREP(firedEH);
+PREP(getBarrelMass);
+PREP(getConsumableChildren);
 PREP(getWeaponData);
 PREP(handleTakeEH);
 PREP(handleRespawn);
@@ -18,6 +22,8 @@ PREP(sendSpareBarrelsTemperaturesHint);
 PREP(swapBarrel);
 PREP(swapBarrelAssistant);
 PREP(swapBarrelCallback);
+PREP(updateAmmoTemperature);
+PREP(updateAmmoTemperatureThread);
 PREP(updateSpareBarrelsTemperaturesThread);
 PREP(updateTemperature);
 PREP(updateTemperatureThread);
diff --git a/addons/overheating/XEH_postInit.sqf b/addons/overheating/XEH_postInit.sqf
@@ -48,22 +48,64 @@ if (hasInterface) then {
     GVAR(cacheAmmoData) = call CBA_fnc_createNamespace;
     GVAR(cacheSilencerData) = call CBA_fnc_createNamespace;
 
-    //Add Take EH (for reload)
-    ["CAManBase", "Take", {_this call FUNC(handleTakeEH);}] call CBA_fnc_addClassEventHandler;
+    //Add Take EH if required
+    if (GVAR(unJamOnReload) || {GVAR(cookoffCoef) > 0}) then {
+        ["CAManBase", "Take", {_this call FUNC(handleTakeEH);}] call CBA_fnc_addClassEventHandler;
+    };
 
     // Register fire event handler
     ["ace_firedPlayer", DFUNC(firedEH)] call CBA_fnc_addEventHandler;
     // Only add eh to non local players if dispersion is enabled
-    if (GVAR(overheatingDispersion)) then {
+    if (GVAR(overheatingDispersion) || {GVAR(showParticleEffectsForEveryone)}) then {
         ["ace_firedPlayerNonLocal", DFUNC(firedEH)] call CBA_fnc_addEventHandler;
     };
 
     // Schedule cool down calculation of player weapons at (infrequent) regular intervals
     [] call FUNC(updateTemperatureThread);
 
+    //Add event handlers and start ammo heating loop for cookoff
+    if (GVAR(cookoffCoef) > 0) then {
+        [] call FUNC(updateAmmoTemperatureThread);
+
+        // Reset ammo temperature on reload, unless the reload is a second muzzle.
+        ["CAManBase", "Reloaded", {
+            params ["_unit", "_weapon", "_muzzle"];
+            if (_muzzle == _weapon) then {
+                _unit setVariable [format [QGVAR(%1_ammoTemp), _weapon], 0];
+            };
+        }] call CBA_fnc_addClassEventHandler;
+    };
+
     // Install event handler to display temp when a barrel was swapped
     [QGVAR(showWeaponTemperature), DFUNC(displayTemperature)] call CBA_fnc_addEventHandler;
     // Install event handler to initiate an assisted barrel swap
     [QGVAR(initiateSwapBarrelAssisted), DFUNC(swapBarrel)] call CBA_fnc_addEventHandler;
 
+    // Add an action to allow hot weapons to be cooled off in AceX Field Rations water sources
+    if (isClass(configfile >> "CfgPatches" >> "acex_field_rations")) then {
+        [
+            {acex_field_rations_enabled || CBA_missionTime > 1},
+            {
+                if (!acex_field_rations_enabled) exitWith {};
+
+                _CoolWeaponWithWaterSourceAction = [
+                    QGVAR(CoolWeaponWithWaterSource),
+                    LLSTRING(CoolWeaponWithWaterSource),
+                    "\z\acex\addons\field_rations\ui\icon_water_tap.paa",
+                    {
+                        private _waterSource = _target getVariable ["acex_field_rations_waterSource", objNull];
+                        [_player, _waterSource] call FUNC(coolWeaponWithWaterSource);
+                    },
+                    {
+                        private _waterSource = _target getVariable ["acex_field_rations_waterSource", objNull];
+                        [_player, _waterSource] call acex_field_rations_fnc_canDrinkFromSource;
+                    }
+                ] call EFUNC(interact_menu,createAction);
+
+                ["acex_field_rations_helper", 0, ["acex_field_rations_waterSource"], _CoolWeaponWithWaterSourceAction] call EFUNC(interact_menu,addActionToClass);
+            },
+            []
+        ] call CBA_fnc_waitUntilAndExecute;
+    };
+
 }] call CBA_fnc_addEventHandler;
diff --git a/addons/overheating/functions/fnc_calculateCooling.sqf b/addons/overheating/functions/fnc_calculateCooling.sqf
@@ -30,6 +30,15 @@ if (_totalTime > 1800) exitWith {0};
 //So Area = 210 * 1.1 * (mass / 7850) = mass * 0.029427 (for steel near that diameter)
 
 private _barrelSurface = _barrelMass * 0.029427;
+private _convectionRate = 25;
+
+//provide additional cooling if swimming or raining or windy
+if (ACE_player call EFUNC(common,isSwimming)) then {
+    _convectionRate = 500;
+} else {
+    // this will give a convection rate between 25 (no wind or rain) and 125 (max rain and >=50 m/s wind)
+    _convectionRate = _convectionRate * ((linearConversion [0,1,rain,1,5,true] + (5 min (vectorMagnitude wind / 10))) / 2);
+};
 
 TRACE_4("cooling",_temperature,_totalTime,_barrelMass,_barrelSurface);
 
@@ -38,13 +47,10 @@ while {true} do {
     private _deltaTime = (_totalTime - _time) min 20;
 
     _temperature = _temperature - (
-    // Convective cooling
-    25 * _barrelSurface * _temperature
-    // Radiative cooling
-    + 0.4 * 5.67e-8 * _barrelSurface *
-    ( (_temperature + 273.15)*(_temperature + 273.15)
-    * (_temperature + 273.15)*(_temperature + 273.15)
-    - 273.15 * 273.15 * 273.15 *273.15 )
+        // Convective cooling
+        _convectionRate * _barrelSurface * _temperature
+        // Radiative cooling
+        + 0.4 * 5.67e-8 * _barrelSurface * ((_temperature + 273.15) ^ 4 - 273.15 ^ 4)
     ) * _deltaTime / (_barrelMass * 466);
 
     if (_temperature < 1) exitWith {0};

diff --git a/addons/overheating/functions/fnc_canCheckSpareBarrelsTemperatures.sqf b/addons/overheating/functions/fnc_canCheckSpareBarrelsTemperatures.sqf
@@ -20,7 +20,7 @@ params ["_player"];
 //Get the classname of the spare barrel for the weapon
 private _weaponBarrelClass = getText (configFile >> 'CfgWeapons' >> currentWeapon _player >> QGVAR(barrelClassname));
 //If the weapon has no defined classname then use the ACE one
-if(_weaponBarrelClass == "") then {
+if (_weaponBarrelClass == "") then {
     _weaponBarrelClass = "ACE_SpareBarrel";
 };
 //Check if the player has the barrel and the weapon can have its barrel swapped

diff --git a/addons/overheating/functions/fnc_canSwapBarrel.sqf b/addons/overheating/functions/fnc_canSwapBarrel.sqf
@@ -18,12 +18,12 @@
 params ["_unit","_weapon"];
 
 //Check if weapon can have its barrel swapped. If not exit out of function
-if( !GVAR(enabled) || {getNumber (configFile >> 'CfgWeapons' >> _weapon >> QGVAR(allowSwapBarrel)) != 1}) exitWith{false};
+if ( !GVAR(enabled) || {getNumber (configFile >> 'CfgWeapons' >> _weapon >> QGVAR(allowSwapBarrel)) != 1}) exitWith{false};
 
 //Get the classname of the spare barrel for the weapon
 private _weaponBarrelClass = getText (configFile >> 'CfgWeapons' >> _weapon >> QGVAR(barrelClassname));
 //If the weapon has no defined classname then use the ACE one
-if(_weaponBarrelClass == "") then {
+if (_weaponBarrelClass == "") then {
     _weaponBarrelClass = "ACE_SpareBarrel";
 };
 //If the player has the spare barrel then it can be swapped

diff --git a/addons/overheating/functions/fnc_checkTemperature.sqf b/addons/overheating/functions/fnc_checkTemperature.sqf
@@ -12,7 +12,7 @@
  * None
  *
  * Example:
- * [player, currentWeapon player] call ace_overheating_fnc_checkTemperature
+ * [player, player, currentWeapon player] call ace_overheating_fnc_checkTemperature
  *
  * Public: No
  */

diff --git a/addons/overheating/functions/fnc_clearJam.sqf b/addons/overheating/functions/fnc_clearJam.sqf
@@ -33,6 +33,7 @@ if (_weapon in _jammedWeapons) then {
         };
 
         [_unit, _clearJamAction, 1] call EFUNC(common,doGesture);
+
         if (_weapon == primaryWeapon _unit) then {
             playSound QGVAR(fixing_rifle);
         } else {
@@ -42,21 +43,33 @@ if (_weapon in _jammedWeapons) then {
         };
     };
 
-    // Check if the jam will be successfull
+    // Check if the jam clearing will be successfull
     if (random 1 > GVAR(unJamFailChance)) then {
         // Success
-        _jammedWeapons = _jammedWeapons - [_weapon];
-        _unit setVariable [QGVAR(jammedWeapons), _jammedWeapons];
-        if (_jammedWeapons isEqualTo []) then {
-            private _id = _unit getVariable [QGVAR(JammingActionID), -1];
-            [_unit, "DefaultAction", _id] call EFUNC(common,removeActionEventHandler);
-            _unit setVariable [QGVAR(JammingActionID), -1];
-        };
-        if (GVAR(DisplayTextOnJam)) then {
-            [{
+
+        [{
+            params ["_unit", "_weapon", "_jammedWeapons"];
+            _jammedWeapons = _jammedWeapons - [_weapon];
+            _unit setVariable [QGVAR(jammedWeapons), _jammedWeapons];
+
+            // If the round is a dud eject the round
+            if (_unit getVariable [format [QGVAR(%1_jamType), _weapon], "None"] isEqualTo "Dud") then {
+                private _ammo = _unit ammo _weapon;
+                _unit setAmmo [_weapon, _ammo - 1];
+            };
+
+            _unit setVariable [format [QGVAR(%1_jamType), _weapon], "None"];
+
+            if (_jammedWeapons isEqualTo []) then {
+                private _id = _unit getVariable [QGVAR(JammingActionID), -1];
+                [_unit, "DefaultAction", _id] call EFUNC(common,removeActionEventHandler);
+                _unit setVariable [QGVAR(JammingActionID), -1];
+            };
+
+            if (GVAR(DisplayTextOnJam)) then {
                 [localize LSTRING(WeaponUnjammed)] call EFUNC(common,displayTextStructured);
-            }, [], _delay] call CBA_fnc_waitAndExecute;
-        };
+            };
+        }, [_unit, _weapon, _jammedWeapons], _delay] call CBA_fnc_waitAndExecute;
     } else {
         // Failure
         if (GVAR(DisplayTextOnJam)) then {