Generic cycle attack profile key for missile guidance (#4787)

* Generic cycle attack profile key for missile guidance

* Add hint for weapons without huds

* Fix Korean strings

* Cleanup

addons/javelin/XEH_PREP.hpp

@@ -1,5 +1,4 @@
 
-PREP(cycleFireMode);
 PREP(getTarget);
 PREP(mapHelperDraw);
 PREP(onOpticDraw);

addons/javelin/functions/fnc_cycleFireMode.sqf

@@ -1,30 +0,0 @@
-/*
- * Author: jaynus
- * Cycles fire mode (top/dir)
- *
- * Arguments:
- * None
- *
- * Return Value:
- * None
- *
- * Example:
- * [] call ace_javelin_fnc_cycleFireMode
- *
- * Public: No
- */
-// #define DEBUG_MODE_FULL
-#include "script_component.hpp"
-
-TRACE_1("cycle fire mode", _this);
-
-private _currentShooter = if (ACE_player call CBA_fnc_canUseWeapon) then {ACE_player} else {vehicle ACE_player};
-private _currentFireMode = _currentShooter getVariable ["ace_missileguidance_attackProfile", "JAV_TOP"];
-
-if (_currentFireMode == "JAV_DIR") then {
-    _currentFireMode = "JAV_TOP";
-} else {
-    _currentFireMode = "JAV_DIR";
-};
-_currentShooter setVariable ["ace_missileguidance_attackProfile", _currentFireMode, false];
-TRACE_2("set",_currentFireMode,_currentShooter);

addons/javelin/initKeybinds.sqf

@@ -18,11 +18,3 @@
     false
 },
 [15, [false, false, false]], false] call CBA_fnc_addKeybind;  //Tab Key
-
-["ACE3 Weapons", QGVAR(cycleFireMode), localize LSTRING(CycleFireMode),
-{ false },
-{
-    [ACE_player] call FUNC(cycleFireMode);
-    false
-},
-[15, [false, true, false]], false] call CBA_fnc_addKeybind;  //Ctrl+Tab Key

addons/javelin/stringtable.xml

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <Project name="ACE">
     <Package name="Javelin">
         <Key ID="STR_ACE_Javelin_LockTarget">
@@ -15,19 +15,5 @@
             <Japanese>目標を捕捉 (押しっぱ)</Japanese>
             <Korean>표적 획득 (누르기)</Korean>
         </Key>
-        <Key ID="STR_ACE_Javelin_CycleFireMode">
-            <English>Cycle Fire Mode</English>
-            <German>Wechsle Feuermodus</German>
-            <Russian>Переключение режимов огня</Russian>
-            <Czech>Přepínání režimů palby</Czech>
-            <Polish>Przełącz tryb ognia</Polish>
-            <French>Cycle mode de tir</French>
-            <Hungarian>Tüzelési mód váltása</Hungarian>
-            <Italian>Alterna le modalità di fuoco</Italian>
-            <Spanish>Cambiar modo de disparo</Spanish>
-            <Portuguese>Alterar Modo de Disparo</Portuguese>
-            <Japanese>発射モード切り替え</Japanese>
-            <Korean>발사 방식 순환</Korean>
-        </Key>
     </Package>
 </Project>

addons/missileguidance/XEH_PREP.hpp

@@ -1,3 +1,5 @@
+LOG("prep");
+PREP(cycleAttackProfileKeyDown);
 
 PREP(changeMissileDirection);
 

addons/missileguidance/XEH_post_init.sqf

@@ -1,3 +1,13 @@
 #include "script_component.hpp"
 
 [QGVAR(handoff), {_this call FUNC(handleHandoff)}] call CBA_fnc_addEventHandler;
+
+["ACE3 Weapons", QGVAR(cycleFireMode), localize LSTRING(CycleFireMode),
+{
+    [] call FUNC(cycleAttackProfileKeyDown);
+    false
+},
+{
+    false
+},
+[15, [false, true, false]], false] call CBA_fnc_addKeybind;  //Ctrl+Tab Key

addons/missileguidance/functions/fnc_cycleAttackProfileKeyDown.sqf

@@ -0,0 +1,67 @@
+/*
+ * Author: PabstMirror
+ * Cycles fire mode for any missileGuidance enabled ammo that has multiple attack profiles
+ *
+ * Arguments:
+ * None
+ *
+ * Return Value:
+ * None
+ *
+ * Example:
+ * [] call ace_missileguidance_fnc_cycleAttackProfileKeyDown
+ *
+ * Public: No
+ */
+// #define DEBUG_MODE_FULL
+#include "script_component.hpp"
+
+TRACE_1("cycle fire mode",_this);
+
+if (!alive ACE_player) exitWith {};
+if (!([ACE_player, objNull, ["isNotInside"]] call EFUNC(common,canInteractWith))) exitWith {};
+
+
+private ["_currentShooter", "_currentMagazine"];
+if (((vehicle ACE_player) == ACE_player) || {ACE_player call CBA_fnc_canUseWeapon}) then {
+    _currentShooter = ACE_player;
+    _currentMagazine = currentMagazine ACE_player;
+} else {
+    _currentShooter = vehicle ACE_player;
+    _currentMagazine = _currentShooter currentMagazineTurret (ACE_player call CBA_fnc_turretPath);
+};
+if (_currentMagazine == "") exitWith {TRACE_1("no magazine",_currentMagazine)};
+
+private _ammo = getText (configFile >> "CfgMagazines" >> _currentMagazine >> "ammo");
+
+TRACE_3("",_currentShooter,_currentMagazine,_ammo);
+
+// Bail if guidance is disabled for this ammo
+if ((getNumber (configFile >> "CfgAmmo" >> _ammo >> QUOTE(ADDON) >> "enabled")) != 1) exitWith {TRACE_1("not enabled",_ammo)};
+
+// Verify ammo has explicity added guidance config (ignore inheritances)
+private _configs = configProperties [(configFile >> "CfgAmmo" >> _ammo), QUOTE(configName _x == QUOTE(QUOTE(ADDON))), false];
+if ((count _configs) < 1) exitWith {TRACE_2("not explicity enabled",_ammo,_configs)};
+
+private _attackProfiles = getArray (configFile >> "CfgAmmo" >> _ammo >> QUOTE(ADDON) >> "attackProfiles");
+if ((count _attackProfiles) <= 1) exitWith {TRACE_1("no choices for attack profile",_attackProfiles)};
+
+private _currentFireMode = _currentShooter getVariable [QGVAR(attackProfile), "#undefined"];
+
+// Just like onFired, this is case sensitive!
+private _index = _attackProfiles find _currentFireMode;
+if (_index == -1) then {
+    _index = _attackProfiles find (getText (configFile >> "CfgAmmo" >> _ammo >> QUOTE(ADDON) >> "defaultAttackProfile"));
+};
+_index = (_index + 1) % (count _attackProfiles);
+private _nextFireMode = _attackProfiles select _index;
+TRACE_4("",_currentFireMode,_nextFireMode,_index,_attackProfiles);
+
+_currentShooter setVariable [QGVAR(attackProfile), _nextFireMode, false];
+
+playSound "ACE_Sound_Click";
+
+if ((getNumber (configFile >> "CfgAmmo" >> _ammo >> QUOTE(ADDON) >> "showHintOnCycle")) == 1) then {
+    private _localizedName = getText (configFile >> QGVAR(AttackProfiles) >> _nextFireMode >> "name");
+    [_localizedName] call EFUNC(common,displayTextStructured);
+};

addons/missileguidance/stringtable.xml

@@ -154,5 +154,19 @@
             <Italian>Giocatore ed IA</Italian>
             <Japanese>プレイヤーと AI</Japanese>
         </Key>
+        <Key ID="STR_ACE_MissileGuidance_CycleFireMode">
+            <English>Cycle Fire Mode</English>
+            <German>Wechsle Feuermodus</German>
+            <Russian>Переключение режимов огня</Russian>
+            <Czech>Přepínání režimů palby</Czech>
+            <Polish>Przełącz tryb ognia</Polish>
+            <French>Cycle mode de tir</French>
+            <Hungarian>Tüzelési mód váltása</Hungarian>
+            <Italian>Alterna le modalità di fuoco</Italian>
+            <Spanish>Cambiar modo de disparo</Spanish>
+            <Portuguese>Alterar Modo de Disparo</Portuguese>
+            <Japanese>発射モード切り替え</Japanese>
+            <Korean>발사 방식 순환</Korean>
+        </Key>
     </Package>
 </Project>