Merge pull request #108 from gruppe-adler/help

add Gruppe Adler help to diary

addons/adminMessages/README.md

@@ -1,5 +1,5 @@
 ### adminMessages
-Adds message box to escape menu. Allows players to send message to all admins and curators. Can be used to ask for tech support without ruining immersion by using global chat.
+This adds a message box to the escape menu. Allows players to send message to all admins and curators. You can use this to ask for tech support without ruining immersion by using global chat.
 
 #### Maintainer(s)
 * McDiod

addons/adminMessages/XEH_preClientInit.sqf

@@ -0,0 +1,6 @@
+#include "script_component.hpp"
+
+private _title = "Admin Messages";
+private _helpText = "This adds a message box to the escape menu. Allows players to send message to all admins and curators. You can use this to ask for tech support without ruining immersion by using global chat.";
+
+[_title,_helpText] call EFUNC(ui,addHelpRecord);

addons/adminMessages/cfgEventHandlers.hpp

@@ -3,3 +3,9 @@ class Extended_PostInit_EventHandlers {
         serverInit = QUOTE(call COMPILE_FILE(XEH_postInit));
     };
 };
+
+class Extended_PreInit_EventHandlers {
+    class ADDON {
+        clientInit = QUOTE(call COMPILE_FILE(XEH_preClientInit));
+    };
+};

addons/alk/XEH_preClientInit.sqf

@@ -0,0 +1,6 @@
+#include "script_component.hpp"
+
+private _title = "Arm Leg Kit";
+private _helpText = "The Arm Leg Kit is an item which allows medic to fix broken limbs. If your aim is unsteady or you cannot run anymore, ask for an ALK.";
+
+[_title,_helpText] call EFUNC(ui,addHelpRecord);

addons/alk/cfgEventHandlers.hpp

@@ -0,0 +1,5 @@
+class Extended_PreInit_EventHandlers {
+    class ADDON {
+        clientInit = QUOTE(call COMPILE_FILE(XEH_preClientInit));
+    };
+};

addons/alk/config.cpp

@@ -15,6 +15,7 @@ class CfgPatches
 	};
 };
 
+#include "cfgEventHandlers.hpp"
 #include "ACE_Treatments.hpp"
 #include "CfgFunctions.hpp"
 #include "CfgVehicles.hpp"

addons/ams/XEH_preClientInit.sqf

@@ -0,0 +1,6 @@
+#include "script_component.hpp"
+
+private _title = "Advanced Medical";
+private _helpText = "Gruppe Adler Mod brings some changes to ACE's advanced medical system. The most prominent are:<br/><br/>- increased IV transfusion rate<br/>- chance for CPR to revive patient, even if in critical condition";
+
+[_title,_helpText] call EFUNC(ui,addHelpRecord);

addons/ams/cfgEventHandlers.hpp

@@ -3,3 +3,9 @@ class Extended_PostInit_EventHandlers {
         init = "['wil_ace_cpr_fnc_treatmentAdvanced_CPRLocal', wil_ace_cpr_fnc_treatmentAdvanced_CPRLocal] call CBA_fnc_addEventHandler;";
     };
 };
+
+class Extended_PreInit_EventHandlers {
+    class ADDON {
+        clientInit = QUOTE(call COMPILE_FILE(XEH_preClientInit));
+    };
+};

addons/cinematicSpec/XEH_preClientInit.sqf

@@ -0,0 +1,21 @@
+#include "\a3\editor_f\Data\Scripts\dikCodes.h"
+#include "script_component.hpp"
+
+SCRIPT(XEH_preInit);
+
+[
+    "Gruppe Adler",
+    QGVAR(toggle),
+    "Enter Cinematic Spectator",
+    "",
+    ""
+] call CBA_fnc_addKeybind;
+
+GVAR(registered) = false;
+GVAR(warned) = false;
+
+
+private _title = "Cinematic Spec";
+private _helpText = "Cinematic Spectator mode brings the old school BI spectator cam with inertia enabled back to life. This does not have a default keybind, so if you want to use it, check Controls >> Configure Addons >> Gruppe Adler. Once you are in spectator, use your assigned key to switch between the default spectator mode and Cinematic Spec.";
+
+[_title,_helpText] call EFUNC(ui,addHelpRecord);

addons/cinematicSpec/cfgEventHandlers.hpp

@@ -0,0 +1,5 @@
+class Extended_PreInit_EventHandlers {
+    class ADDON {
+        clientInit = QUOTE(call COMPILE_FILE(XEH_preClientInit));
+    };
+};

addons/cinematicSpec/config.cpp

@@ -14,6 +14,7 @@ class CfgPatches {
 	};
 };
 
+#include "cfgEventHandlers.hpp"
 #include "cfgFunctions.hpp"
 
 class ACE_spectator_display {
@@ -22,9 +23,3 @@ class ACE_spectator_display {
 class ACE_spectator_interface {
 	onKeyDown = "_this call GRAD_cinematicSpec_fnc_chainHandlers";
 };
-
-class Extended_PreInit_EventHandlers {
-    class ADDON {
-        clientInit = QUOTE(call COMPILE_FILE(XEH_preInit));
-    };
-};

addons/screenshotMode/README.md

@@ -1,5 +1,5 @@
 ### screenshotMode
-Adds a keybind to hide all UI elements for prettier screenshots. Has no default binding. Check *Controls* >> *Configure Addons* >> *Gruppe Adler*.
+Adds a keybind to hide all UI elements for prettier screenshots. This does not have a default keybind, so if you want to use it, check *Controls* >> *Configure Addons* >> *Gruppe Adler*.
 
 <img src="http://i.imgur.com/TYuHyP8.png" width="512" />
 

addons/screenshotMode/XEH_preClientInit.sqf

@@ -0,0 +1,6 @@
+#include "script_component.hpp"
+
+private _title = "Screenshot Mode";
+private _helpText = "Adds a keybind to hide all UI elements for prettier screenshots. This does not have a default keybind, so if you want to use it, check Controls >> Configure Addons >> Gruppe Adler.";
+
+[_title,_helpText] call EFUNC(ui,addHelpRecord);

addons/screenshotMode/cfgEventHandlers.hpp

@@ -1,3 +1,9 @@
 class Extended_PostInit_EventHandlers {
 	GRAD_screenshotMode="[] call GRAD_screenshotMode_fnc_postInit;";
 };
+
+class Extended_PreInit_EventHandlers {
+    class ADDON {
+        clientInit = QUOTE(call COMPILE_FILE(XEH_preClientInit));
+    };
+};

addons/ui/XEH_postClientInit.sqf

@@ -0,0 +1,19 @@
+#include "script_component.hpp"
+
+if (!hasInterface) exitWith {};
+
+player createDiarySubject [QGVAR(helpSubject),"Gruppe Adler"];
+
+private _helpRecords = missionNamespace getVariable [QGVAR(helpRecords),[]];
+{
+    _x params ["_title","_text"];
+
+    player createDiaryRecord [QGVAR(helpSubject),[
+        _title,
+        format ["<img width='32' height='32' image='\x\grad\addons\ui\dialog\logo_128.paa'/><font size='32' color='#D18D1F' face='RobotoCondensedLight'> %1</font><br/><br/>%2",_title,_text]
+    ]];
+
+} forEach _helpRecords;
+
+_helpRecords resize 0;
+GVAR(helpRecords) = nil;

addons/ui/cfgEventhandlers.hpp

@@ -0,0 +1,5 @@
+class Extended_PostInit_EventHandlers {
+    class ADDON {
+        clientInit = QUOTE(call COMPILE_FILE(XEH_postClientInit));
+    };
+};

addons/ui/cfgFunctions.hpp

@@ -8,5 +8,9 @@ class CfgFunctions {
 			class onButtonPortOK {};
 			class onLoadButtonConnect {};
 		};
+        class help {
+			file = QPATHTOF(functions\help);
+            class addHelpRecord {};
+		};
 	};
 };

addons/ui/config.cpp

@@ -18,4 +18,5 @@ class CfgPatches {
 };
 
 #include "cfgFunctions.hpp"
+#include "cfgEventhandlers.hpp"
 #include "dialog\directConnect.hpp"

addons/ui/functions/help/fn_addHelpRecord.sqf

@@ -0,0 +1,9 @@
+#include "script_component.hpp"
+
+params [["_title","ERROR: NO TITLE"],["_text","ERROR: NO TEXT"]];
+
+if (isNil QGVAR(helpRecords)) then {
+    GVAR(helpRecords) = [];
+};
+
+GVAR(helpRecords) pushBack [_title,_text];

addons/ui/functions/help/script_component.hpp

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

addons/zeus/CfgEventHandlers.hpp

@@ -7,6 +7,7 @@ class Extended_PreStart_EventHandlers {
 class Extended_PreInit_EventHandlers {
     class ADDON {
         init = QUOTE(call COMPILE_FILE(XEH_preInit));
+        clientInit = QUOTE(call COMPILE_FILE(XEH_preClientInit));
     };
 };
 

addons/zeus/XEH_preClientInit.sqf

@@ -0,0 +1,31 @@
+#include "script_component.hpp"
+
+private _title = "Zeus";
+private _helpText = "
+Gruppe Adler Mod adds a collection of new Zeus modules:<br/>
+<br/>
+<font face='RobotoCondensedLight'>Add Players to Zeus</font><br/>
+Drop this anywhere to add all players to the Zeus interface.<br/>
+<br/>
+<font face='RobotoCondensedLight'>Blacklist Headless Transfer</font><br/>
+Drop this module on a unit. This will blacklist the unit's group from being automatically transferred to a headless client. In the dialog, you can optionally choose to transfer the ownership to either server or player.<br/>
+<br/>
+<font face='RobotoCondensedLight'>Monitoring</font><br/>
+Drop this module anywhere. A settings window will pop up allowing you to toggle monitoring of different parameters, including player FPS, medical status, AI status and some more.<br/>
+<br/>
+<font face='RobotoCondensedLight'>Move Respawn Position</font><br/>
+Drop this module anywhere, then select a side to move that side's respawn position to the module. Keep in mind that the respawn position is also where JIP players spawn.<br/>
+<br/>
+<font face='RobotoCondensedLight'>Reload Loadout</font><br/>
+Drop this on a unit. If the unit has a grad-loadout assigned, it will be reloaded.<br/>
+<br/>
+<font face='RobotoCondensedLight'>Set Faction Loadout</font><br/>
+Drop this anywhere or on a unit. Select a loadout for a faction. Units of the selected faction will now spawn with the selected loadout.<br/>
+<br/>
+<font face='RobotoCondensedLight'>Supply Drop</font><br/>
+Place a container (like an ammo box) somewhere on the map. Fill it to your liking. Drop this module on the container. Select an aircraft from the list that pops up. Select a target position for the drop to land. The selected aircraft will then proceed to paradrop your container at the position.<br/>
+<br/>
+<font face='RobotoCondensedLight'>Toggle BFT</font><br/>
+Drop this anywhere. Toggles Blue Force Tracking.<br/>";
+
+[_title,_helpText] call EFUNC(ui,addHelpRecord);