Add Zeus and 3DEN comments (#785)

Author: Timi007

AUTHORS.txt

@@ -50,6 +50,7 @@ PlayerBot
 Ryan180602
 shukari
 SilentSpike
+Timi007
 Toinane
 Tuupertunut
 veteran29

README.md

@@ -49,6 +49,7 @@ Special thanks to the [ACE3 Team](https://ace3.acemod.org/team) for their open s
 - Settings to control Zeus camera properties such as speed and available vision modes.
 - Zeus camera flashlight for easier editing at night.
 - New waypoint types such as paradrop available through Zeus.
+- Ability to place comments and see comments created in 3DEN. 
 
 ## Contributing
 

addons/comments/$PBOPREFIX$

@@ -0,0 +1 @@
+x\zen\addons\comments

addons/comments/Cfg3DEN.hpp

@@ -0,0 +1,61 @@
+class Cfg3DEN {
+    class Attributes {
+        class Default;
+        class GVAR(hiddenAttribute): Default {
+            onLoad = QUOTE((ctrlParentControlsGroup ctrlParentControlsGroup (_this select 0)) ctrlShow false);
+        };
+    };
+
+    class Mission {
+        class Scenario {
+            class AttributeCategories {
+                class ADDON {
+                    displayName = STR_DISPLAY_NAME;
+                    collapsed = 1;
+
+                    class Attributes {
+                        class GVAR(3DENComments) {
+                            displayName = STR_DISPLAY_NAME;
+                            property = QGVAR(3DENComments);
+                            control = QGVAR(hiddenAttribute);
+                            tooltip = "";
+                            defaultValue = "[]";
+                            expression = "";
+                            wikiType = "[[Array]]";
+                        };
+                    };
+                };
+            };
+        };
+    };
+
+    class EventHandlers {
+        class ADDON {
+            // Arguments are for debugging
+            onMissionSave = QUOTE(['onMissionSave'] call FUNC(save3DENComments));
+            onMissionAutosave = QUOTE(['onMissionAutosave'] call FUNC(save3DENComments));
+            onBeforeMissionPreview = QUOTE(['onBeforeMissionPreview'] call FUNC(save3DENComments));
+        };
+    };
+
+    class Comment {
+        class AttributeCategories {
+            class ADDON {
+                displayName = ECSTRING(main,DisplayName);
+                collapsed = 0;
+
+                class Attributes {
+                    class GVAR(showComment) {
+                        displayName = CSTRING(ShowCommentInZeus);
+                        tooltip = CSTRING(ShowCommentInZeus_Description);
+                        property = QGVAR(showComment);
+                        control = "CheckboxState";
+                        defaultValue = "true";
+                        expression = "";
+                        wikiType = "[[Bool]]";
+                    };
+                };
+            };
+        };
+    };
+};

addons/comments/CfgContext.hpp

@@ -0,0 +1,9 @@
+class EGVAR(context_menu,actions) {
+    class GVAR(createComment) {
+        displayName = STR_CREATE_COMMENT;
+        icon = COMMENT_ICON;
+        condition = QGVAR(enabled);
+        statement = QUOTE([_position] call FUNC(openDialog));
+        priority = 35;
+    };
+};

addons/comments/CfgEventHandlers.hpp

@@ -0,0 +1,17 @@
+class Extended_PreStart_EventHandlers {
+    class ADDON {
+        init = QUOTE(call COMPILE_SCRIPT(XEH_preStart));
+    };
+};
+
+class Extended_PreInit_EventHandlers {
+    class ADDON {
+        init = QUOTE(call COMPILE_SCRIPT(XEH_preInit));
+    };
+};
+
+class Extended_PostInit_EventHandlers {
+    class ADDON {
+        init = QUOTE(call COMPILE_SCRIPT(XEH_postInit));
+    };
+};

addons/comments/XEH_PREP.hpp

@@ -0,0 +1,23 @@
+PREP(addDrawEventHandler);
+PREP(createComment);
+PREP(createIcon);
+PREP(deleteComment);
+PREP(deleteIcon);
+PREP(drawComments);
+PREP(is3DENComment);
+PREP(moveComment);
+PREP(onCommentCreated);
+PREP(onCommentDeleted);
+PREP(onCommentUpdated);
+PREP(onDraw);
+PREP(onDraw3D);
+PREP(onKeyDown);
+PREP(onMouseButtonDown);
+PREP(onMouseButtonUp);
+PREP(onMouseDblClick);
+PREP(onMouseMoving);
+PREP(onUnload);
+PREP(openDialog);
+PREP(save3DENComments);
+PREP(updateComment);
+PREP(updateIcon);

addons/comments/XEH_postInit.sqf

@@ -0,0 +1,19 @@
+#include "script_component.hpp"
+
+if (isServer) then {
+    [QGVAR(createComment), LINKFUNC(createComment)] call CBA_fnc_addEventHandler;
+    [QGVAR(deleteComment), LINKFUNC(deleteComment)] call CBA_fnc_addEventHandler;
+    [QGVAR(updateComment), LINKFUNC(updateComment)] call CBA_fnc_addEventHandler;
+};
+
+if (hasInterface) then {
+    GVAR(comments) = createHashMapFromArray getMissionConfigValue [QGVAR(3DENComments), []];
+    TRACE_1("Loaded 3DEN Comments from mission",GVAR(comments));
+
+    [QGVAR(commentCreated), LINKFUNC(onCommentCreated)] call CBA_fnc_addEventHandler;
+    [QGVAR(commentDeleted), LINKFUNC(onCommentDeleted)] call CBA_fnc_addEventHandler;
+    [QGVAR(commentUpdated), LINKFUNC(onCommentUpdated)] call CBA_fnc_addEventHandler;
+
+    ["zen_curatorDisplayLoaded", LINKFUNC(addDrawEventHandler)] call CBA_fnc_addEventHandler;
+    ["zen_curatorDisplayUnloaded", LINKFUNC(onUnload)] call CBA_fnc_addEventHandler;
+};

addons/comments/XEH_preInit.sqf

@@ -0,0 +1,27 @@
+#include "script_component.hpp"
+
+ADDON = false;
+
+PREP_RECOMPILE_START;
+#include "XEH_PREP.hpp"
+PREP_RECOMPILE_END;
+
+if (isServer) then {
+    // Unique ID for creating comments
+    GVAR(nextID) = 0;
+};
+
+if (hasInterface) then {
+    // Map of all comments
+    // Keys are comment IDs and values are the data
+    GVAR(comments) = createHashMap;
+    GVAR(icons) = createHashMap;
+
+    GVAR(draw3DAdded) = false;
+
+    GVAR(movingComment) = [];
+};
+
+#include "initSettings.inc.sqf"
+
+ADDON = true;

addons/comments/XEH_preStart.sqf

@@ -0,0 +1,3 @@
+#include "script_component.hpp"
+
+#include "XEH_PREP.hpp"