Scripted 2D optics component

addons/2doptics/CfgEventHandlers.hpp

@@ -9,3 +9,9 @@ class Extended_PreInit_EventHandlers {
         init = QUOTE(call COMPILE_FILE(XEH_preInit));
     };
 };
+
+class Extended_DisplayLoad_EventHandlers {
+    class RscDisplayInterrupt {
+        ADDON = QUOTE(_this call (uiNamespace getVariable 'FUNC(initDisplayInterrupt)'));
+    };
+};

addons/2doptics/RscInGameUI.hpp

@@ -13,6 +13,7 @@ class RscInGameUI {
         onLoad = QUOTE(call FUNC(loadScriptedOptic));
         controls[] = {"CA_FOVMode","ScopeBlack","Reticle","BodyNight","BodyDay","TrippleHeadLeft","TrippleHeadRight","CA_Zeroing","Magnification"};
 
+        // Idea by Taosenai. This control can be used to determine whether the scope or the kolimator is used.
         class CA_FOVMode: RscOpticsValue {
             idc = 154;
             w = 0;
@@ -44,8 +45,8 @@ class RscInGameUI {
             h = POS_H(2);
         };
 
-        // These are just black side panels to cover the areas that the optics p3d doesn't cover
-        // It will ONLY effect tripple head users as (safeZoneX == safeZoneXAbs) for everyone else
+        // These are just black side panels to cover the areas that the optics p3d doesn't cover.
+        // It will ONLY effect tripple head users, as (safeZoneX == safeZoneXAbs) for everyone else.
         class TrippleHeadLeft: RscText {
             idc = IDC_BLACK_LEFT;
             x = "safeZoneXAbs";
@@ -90,7 +91,7 @@ class RscInGameUI {
             };
         };
 
-        class EnableAutoZoom: RscText { // idea by Taosenai. Apparently this can be used via isNil check to determine wheter the scope or the kolimator is used
+        class EnableAutoZoom: RscText {
             idc = IDC_ENABLE_ZOOM;
             w = 0;
             h = 0;

addons/2doptics/XEH_PREP.sqf

@@ -3,9 +3,8 @@ PREP(updateOpticInfo);
 PREP(restartCamera);
 PREP(loadScriptedOptic);
 PREP(animateScriptedOptic);
-PREP(animateOpticRecoil);
+PREP(animateScriptedOpticRecoil);
 PREP(changePIPOpticClass);
 PREP(changeCarryHandleOpticClass);
-
 PREP(setOpticMagnification);
 PREP(setOpticMagnificationHelper);

addons/2doptics/XEH_preInit.sqf

@@ -10,11 +10,14 @@ ADDON = false;
 
 #include "XEH_PREP.sqf"
 
+QGVAR(pauseOpticLayer) cutText ["", "PLAIN"];
+
 GVAR(camera) = objNull;
 [QGVAR(camera), {!isNull GVAR(camera)}] call CBA_fnc_registerFeatureCamera;
 
 // scripted optic data cache
 GVAR(currentOptic) = "";
+GVAR(IsUsingOptic) = false;
 GVAR(ReticleAdjust) = [1,1,nil,1,1];
 GVAR(HideRedDotMagnification) = 1e+11;
 GVAR(FadeReticleInterval) = [0,0,nil,0,0];
@@ -35,19 +38,20 @@ GVAR(OpticBodyTextureNight) = "";
 }] call CBA_fnc_addPlayerEventHandler;
 
 // Switch to pip class.
-["cameraView", {
-    params ["_unit", "_view"];
-    if (_view isEqualTo "GUNNER") then {
+[QGVAR(UsingOptic), {
+    params ["_display", "_isUsingOptic"];
+    if (_isUsingOptic) then {
+        private _unit = call CBA_fnc_currentUnit;
         _unit call FUNC(changePIPOpticClass);
     };
-}] call CBA_fnc_addPlayerEventHandler;
+}] call CBA_fnc_addEventHandler;
 
 ["featureCamera", {
     params ["_unit", "_camera"];
     [_unit, _camera isEqualTo ""] call FUNC(restartCamera);
 }] call CBA_fnc_addPlayerEventHandler;
 
-["CAManBase", "Fired", FUNC(animateOpticRecoil)] call CBA_fnc_addClassEventHandler;
+["CAManBase", "Fired", FUNC(animateScriptedOpticRecoil)] call CBA_fnc_addClassEventHandler;
 
 // Handle Arsenal: Switch back to normal classes.
 GVAR(inArsenal) = false;

addons/2doptics/XEH_preStart.sqf

@@ -1,6 +1,10 @@
 #include "script_component.hpp"
 
 if (!hasInterface) exitWith {};
+
+// Do not move this below these checks, or this missing function can be exploited.
+PREP(initDisplayInterrupt);
+
 if (configProperties [configFile >> "CBA_PIPItems"] isEqualTo []) exitWith {};
 if (configProperties [configFile >> "CBA_CarryHandleTypes"] isEqualTo []) exitWith {};
 

addons/2doptics/fnc_animateScriptedOptic.sqf

@@ -46,6 +46,11 @@ _ctrlBlackRight ctrlShow _isUsingOptic;
 //_ctrlZeroing ctrlShow _isUsingOptic;
 _ctrlMagnification ctrlShow _isUsingOptic;
 
+if !(_isUsingOptic isEqualTo GVAR(IsUsingOptic)) then {
+    GVAR(IsUsingOptic) = _isUsingOptic;
+    [QGVAR(UsingOptic), [_display, _isUsingOptic]] call CBA_fnc_localEvent;
+};
+
 if !(_isUsingOptic) exitWith {};
 
 GVAR(camera) setPosASL AGLToASL positionCameraToWorld [0,0,0.4];

addons/2doptics/fnc_animateOpticRecoil.sqf → addons/2doptics/fnc_animateScriptedOpticRecoil.sqf

@@ -1,6 +1,6 @@
 #include "script_component.hpp"
 /* ----------------------------------------------------------------------------
-Internal Function: cba_2doptics_fnc_animateOpticRecoil
+Internal Function: cba_2doptics_fnc_animateScriptedOpticRecoil
 
 Description:
     Animates the 2D optic when firing.
@@ -14,7 +14,7 @@ Returns:
 
 Examples:
     (begin example)
-        [player, currentWeapon player] call cba_2doptics_fnc_animateOpticRecoil;
+        [player, currentWeapon player] call cba_2doptics_fnc_animateScriptedOpticRecoil;
     (end)
 
 Author:
@@ -26,7 +26,6 @@ if (_unit != call CBA_fnc_currentUnit) exitWith {};
 
 // Check if compatible scope is used.
 private _display = uiNamespace getVariable [QGVAR(ScriptedOpticDisplay), displayNull];
-
 if (isNull _display) exitWith {};
 
 private _ctrlReticle = _display displayCtrl IDC_RETICLE;

addons/2doptics/fnc_initDisplayInterrupt.sqf

@@ -0,0 +1,58 @@
+#include "script_component.hpp"
+
+// Check if compatible scope is used.
+private _display = uiNamespace getVariable [QGVAR(ScriptedOpticDisplay), displayNull];
+if (isNull _display) exitWith {};
+
+if (!GVAR(IsUsingOptic)) exitWith {};
+
+// Draw reticle and scope body, because they are otherwise hidden when the pause menu is shown.
+QGVAR(pauseOpticLayer) cutRsc ["RscTitleDisplayEmpty", "PLAIN", 0, false];
+private _display = uiNamespace getVariable "RscTitleDisplayEmpty";
+
+private _vignette = _display displayCtrl 1202;
+_vignette ctrlShow false;
+
+private _ctrlReticle = _display ctrlCreate ["RscPicture", IDC_RETICLE];
+
+private _reticleSize = GVAR(OpticReticleDetailTextures)#0#2;
+private _reticlePosition = [
+    POS_X(_reticleSize),
+    POS_Y(_reticleSize),
+    POS_W(_reticleSize),
+    POS_H(_reticleSize)
+];
+
+_ctrlReticle ctrlSetText (GVAR(OpticReticleDetailTextures)#0#1);
+_ctrlReticle ctrlSetPosition _reticlePosition;
+_ctrlReticle ctrlCommit 0;
+
+private _ctrlBody = _display ctrlCreate ["RscPicture", IDC_BODY];
+
+private _bodyPosition = [
+    POS_X(GVAR(OpticBodyTextureSize)),
+    POS_Y(GVAR(OpticBodyTextureSize)),
+    POS_W(GVAR(OpticBodyTextureSize)),
+    POS_H(GVAR(OpticBodyTextureSize))
+];
+
+_ctrlBody ctrlSetText GVAR(OpticBodyTexture);
+_ctrlBody ctrlSetPosition _bodyPosition;
+_ctrlBody ctrlCommit 0;
+
+// Automatically hide when pause menu is closed.
+private _script = _display ctrlCreate ["RscMapControl", -1];
+
+_script ctrlSetPosition [0,0,0,0];
+_script ctrlCommit 0;
+
+_script ctrlAddEventHandler ["Draw", {
+    params ["_script"];
+    private _counter = ctrlParent _script getVariable "commy_fpsCounter";
+
+    if (isNull (uiNamespace getVariable ["RscDisplayInterrupt", displayNull])) then {
+        {
+            QGVAR(pauseOpticLayer) cutText ["", "PLAIN"];
+        } call CBA_fnc_execNextFrame;
+    };
+}];

addons/2doptics/fnc_loadScriptedOptic.sqf

@@ -20,11 +20,8 @@ Author:
     commy2
 ---------------------------------------------------------------------------- */
 
-if (isNil QGVAR(OpticReticleDetailTextures) || {GVAR(OpticReticleDetailTextures) isEqualTo []}) then {
-    WARNING("No scripted reticle info found.");
-    private _unit = call CBA_fnc_currentUnit;
-    _unit call FUNC(updateOpticInfo);
-};
+private _unit = call CBA_fnc_currentUnit;
+_unit call FUNC(updateOpticInfo);
 
 params ["_display"];
 
@@ -80,4 +77,6 @@ _ctrlBodyNight ctrlCommit 0;
     _thisArgs call FUNC(animateScriptedOptic);
 }, _display] call CBA_fnc_addBISEventHandler;
 
+//INFO("Scripted optic weapon info display loaded.");
+
 nil

addons/2doptics/fnc_updateOpticInfo.sqf

@@ -69,6 +69,6 @@ if (GVAR(OpticBodyTextureNight) isEqualTo "") then {
     GVAR(OpticBodyTextureNight) = GVAR(OpticBodyTexture);
 };
 
-INFO_1("Updated optic info %1.",_optic);
+//INFO_1("Updated optic info %1.",_optic);
 
 nil

addons/2doptics/script_component.hpp

@@ -21,15 +21,15 @@
 #define AMBIENT_BRIGHTNESS (sunOrMoon * sunOrMoon * (1 - overcast * 0.25) + moonIntensity / 5 * (1 - overcast) min 1) // idea by Falke
 
 // control ids
-#define IDC_RETICLE 1000
-#define IDC_BODY 1001
-#define IDC_BODY_NIGHT 1002
-#define IDC_RETICLE_SAFEZONE 1010
-#define IDC_BLACK_SCOPE 1020
-#define IDC_BLACK_LEFT 1021
-#define IDC_BLACK_RIGHT 1022
-#define IDC_RED_DOT 1030
-#define IDC_MAGNIFICATION 1040
+#define IDC_RETICLE 4000
+#define IDC_BODY 4001
+#define IDC_BODY_NIGHT 4002
+#define IDC_RETICLE_SAFEZONE 4010
+#define IDC_BLACK_SCOPE 4020
+#define IDC_BLACK_LEFT 4021
+#define IDC_BLACK_RIGHT 4022
+#define IDC_RED_DOT 4030
+#define IDC_MAGNIFICATION 4040
 #define IDC_ENABLE_ZOOM 9999
 
 // control positions