ACE3/addons/overheating/functions/fnc_updateAmmoTemperature.sqf

107 lines
4.0 KiB
Plaintext
Raw Normal View History

Overheating - Add cook off and rate of fire features and additional customization settings (#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>
2021-10-14 15:47:52 +00:00
#include "script_component.hpp"
/*
* Author: drofseh
* Update temperature of the round in the chamber and determine if a cookoff should occur.
*
* Arguments:
* 0: Unit <OBJECT>
* 1: Weapon <STRING>
* 2: Barrel Temperature <STRING>
*
* Return Value:
* Current ammunition temperature <NUMBER>
*
* Example:
* [player, currentWeapon player, 600] call ace_overheating_fnc_updateAmmoTemperature
*
* Public: No
*/
params ["_unit", "_weapon", "_barrelTemperature"];
TRACE_3("params",_unit,_weapon,_barrelTemperature);
private _closedBolt = getNumber (configFile >> "CfgWeapons" >> _weapon >> QGVAR(closedBolt));
private _canUnjam = [_unit] call FUNC(canUnjam);
// Skip if no ammo in chamber
if (
_unit ammo _weapon < 1
// closed bolt, and jammed and type not failure to fire
|| {_closedBolt == 1 && {_canUnjam} && {!(_unit getVariable [format [QGVAR(%1_jamType), _weapon], "None"] in ["Fire","Dud"])}}
// open bolt, and not jammed, or jammed and type not failure to fire
|| {_closedBolt == 0 && {!_canUnjam || {_canUnjam && {!(_unit getVariable [format [QGVAR(%1_jamType), _weapon], "None"] in ["Fire","Dud"])}}}}
) exitWith {
_unit setVariable [format [QGVAR(%1_ammoTemp), _weapon], 0];
0
};
private _ammoTempVarName = format [QGVAR(%1_ammoTemp), _weapon];
private _ammoTemperature = _unit getVariable [_ammoTempVarName, 0];
// heat or cool the ammo
if (_ammoTemperature < _barrelTemperature) then {
// this is functional and feels ok, but someone please do better heat transfer math here, my head hurts.
private _temperatureDifference = _barrelTemperature - _ammoTemperature;
_ammoTemperature = _ammoTemperature + (1 max ((_temperatureDifference / 2.75) - 100));
} else {
_ammoTemperature = _barrelTemperature;
};
// check for cook off
if (_ammoTemperature > (GUNPOWDER_IGNITION_TEMP * GVAR(cookoffCoef))) then {
// a weapon with a failure to fire or dud type jam will be unjammed from cooking off
// this is first so that the fired event from the cookoff can also cause a jam
private _jamType = _unit getVariable [format [QGVAR(%1_jamType), _weapon], "None"];
if (_canUnjam && {_jamType in ["Fire","Dud"]}) then {
[_unit, currentMuzzle _unit, true] call FUNC(clearJam);
// clearJam will remove a dud round, but so will the forced fire, so give back the lost round and shoot it
if (_jamType isEqualTo "Dud") then {
private _ammo = _unit ammo _weapon;
_unit setAmmo [_weapon, _ammo + 1];
};
};
// get valid mode and muzzle for the main weapon, we don't want the cookoff to come from an underbarrel launcher
([_weapon] call FUNC(getWeaponData)) params ["", "", "", "_modes", "_muzzle", "_reloadTime"];
// get an appropriate firemode and muzzle, cache the current muzzle
// trying to match firemodes and switching back to the cached muzzle will hide the change from the player and prevent unexpected mode/muzzle changes (going from full auto to semi auto, or from underbarrel GL to rifle for example)
private _muzzleCache = currentMuzzle _unit;
private _mode = currentWeaponMode _unit;
if !(_mode in _modes) then {
_mode = _modes select 0;
};
// delay cookoff to ensure any previous animation from a fired event is finished
[
{
params ["_unit", "_muzzleCache", "_mode", "_muzzle"];
// fire the cookoff
_unit forceWeaponFire [_muzzle, _mode];
// switch back to the cached muzzle if required
if (_muzzle != _muzzleCache) then {
_unit selectWeapon _muzzleCache;
};
[
[localize LSTRING(WeaponCookedOff)],
true // allows the hint to be overwritten by another hint, such as a jam or another cookoff
] call CBA_fnc_notify;
},
[_unit, _muzzleCache, _mode, _muzzle],
_reloadTime
] call CBA_fnc_waitAndExecute;
// if the cookoff happened then the next round should start at 0
_ammoTemperature = 0;
};
_unit setVariable [_ammoTempVarName, _ammoTemperature];
_ammoTemperature