add better custom script support

Reviewed-on: hizumi/MissionTemplate#30
Reviewed-by: hizumi <hizumi@noreply.iceberg-gaming.com>

.gitea/workflows/create-testing-snapshot.yaml

@@ -0,0 +1,71 @@
+name: Generate testing snapshot
+on: 
+  push:
+    branches: [develop]
+
+jobs:
+  Clean:
+    name: Create testing release
+    runs-on: windows
+    steps:
+      - name: Diagnostics
+        run: |
+          echo "repository: ${{ gitea.repository }}"
+          echo "ref:  ${{ gitea.ref }}"
+          echo "ref_name: ${{ gitea.ref_name }}"
+          echo "sha: ${{ gitea.sha }}"
+          echo "api_url: ${{ gitea.api_url }}"
+          echo "workflow: ${{ gitea.workflow }}"
+
+      - name: Checkout framework
+        uses: actions/checkout@v3
+        with:
+          path: MissionFramework
+
+      - name: Clean framework
+        run: |
+          Remove-Item -Recurse MissionFramework\aaFrameworkUtils
+          Remove-Item -Recurse MissionFramework\framework\x
+          Remove-Item -Recurse MissionFramework\.git*
+
+      - name: Backup artifacts from runner
+        uses: actions/upload-artifact@v3
+        with:
+          name: framework-test-snapshot
+          path: MissionFramework
+
+      - name: Create archive
+        run: Compress-Archive MissionFramework framework-test-snapshot.zip
+
+      - name: Delete old testing-release release
+        run: |
+          $headers = @{
+            "accept" = "application/json"
+            "Authorization" = "token ${{secrets.RELEASE_TOKEN}}"
+          }
+          Invoke-WebRequest -Uri "${{ gitea.api_url }}/repos/${{ gitea.repository }}/releases/tags/testing-release" -Method Delete -Headers $headers
+
+      - name: Delete old testing-release tag
+        run: |
+          $headers = @{
+            "accept" = "application/json"
+            "Authorization" = "token ${{secrets.RELEASE_TOKEN}}"
+          }
+          Invoke-WebRequest -Uri "${{ gitea.api_url }}/repos/${{ gitea.repository }}/tags/testing-release" -Method Delete -Headers $headers
+
+      - name: Create new testing-release tag
+        run: |
+          $headers = @{
+            "accept" = "application/json"
+            "Authorization" = "token ${{secrets.RELEASE_TOKEN}}"
+          }
+          Invoke-WebRequest -Uri "${{ gitea.api_url }}/repos/${{ gitea.repository }}/tags" -Method Post -Headers $headers -ContentType "application/json" -Body "{`"message`": `"testing-release`", `"tag_name`": `"testing-release`", `"target`": `"${{ gitea.sha }}`"}"
+
+      - name: Create new testing-release
+        uses: https://gitea.com/actions/gitea-release-action@v1.1.6
+        with:
+          tag_name: 'testing-release'
+          name: 'testing-release'
+          prerelease: true
+          files: |-
+            framework-test-snapshot.zip

custom_scripts.hpp

@@ -0,0 +1,11 @@
+// This file's contents will be included in the mission's CfgFunctions section, and serves to give you a place to define custom functions from files you've placed in /scripts.
+
+class milsim_scripts {
+	class functions {
+		file = "scripts";
+		// Add your custom functions here, like so:
+		// class init {postInit = 1;}; // refers to scripts/fn_init.sqf. postInit=1 means it will be run on each machine when they're done loading the mission.
+		// class customFunction1 {}; // refers to the file scripts/fn_customFunction1.sqf, and is called as milsim_scripts_fnc_customFunction1
+		// class customFunction2 {}; // refers to the file scripts/fn_customFunction2.sqf, and is called as milsim_scripts_fnc_customFunction2
+	};
+};

description.ext

@@ -95,7 +95,10 @@ class Params
 
 
 // CfgFunctions
-#include "framework\CfgFunctions.hpp"
+class CfgFunctions {
+	#include "framework\CfgFunctions.hpp"
+	#include "custom_scripts.hpp"
+};
 
 
 

framework/CfgFunctions.hpp

@@ -1,180 +1,187 @@
 #include "script_mod.hpp"
 
-class CfgFunctions {
+class DOUBLES(PREFIX,init) {
-
+	class functions {
-	class DOUBLES(PREFIX,init) {
+		file = "framework\init\functions";
-		class functions {
+		class initServer { postInit = 1;};
-			file = "framework\init\functions";
+		class initClient { postInit = 1;};
-			class initServer { postInit = 1;};
+		class setDefaults {};
-			class initClient { postInit = 1;};
+		class addAARChatHandler {};
-			class setDefaults { postInit = 1; };
+		class addRespawnChatHandler {};
-			class addAARChatHandler { postInit = 1; };
+		class checkMissionSettings {};
-			class addRespawnChatHandler { postInit = 1; };
+	};
-		};
+};
-	};
+
-	
+class PREFIX {	
-	class PREFIX {	
+	class ambience {
-		class ambience {
+		file = "framework\ambience";
-			file = "framework\ambience";
+		class flakInitVehicle {};
-			class flakInitVehicle {};
+		class flakEH {};
-			class flakEH {};
+	};
-		};
+};
-	};
+
-
+class DOUBLES(PREFIX,client) {
-	class DOUBLES(PREFIX,client) {
+	class functions {
-		class functions {
+		file = "framework\client\functions";
-			file = "framework\client\functions";
+		class initClient {};
-			class bindEmptyGroupGarbageCleanup { postInit = 1; };
+		class addMicroDAGRWaypoints {};
-			class bindEventHandlers { postInit = 1; };
+		class addZenModules {};
-			class bindVehicleActions { postInit = 1; };
+		class bindEventHandlers {};
-			class addZenModules {postInit = 1;};
+		class bindUnconsciousListener {};
-		};
+		class bindVehicleActions {};
-	};
+		class addGetNearMenPFH {};
-
+		class addDraw3DPFH {};
-	class DOUBLES(PREFIX,common) {
+		class registerPFHCode {};
-		class functions {
+		class clearPFHCode {};
-			file = "framework\common\functions";
+	};
-			class addCBASettings { preInit = 1; };
+};
-			class logMissionInfo {};
+
-			class addPlayerInfoToArray {};
+class DOUBLES(PREFIX,common) {
-			class createOrUpdateDiaryRecord {};
+	class functions {
-			class getApprovedAssetsCfg {};
+		file = "framework\common\functions";
-			class getBattalionCfg {};
+		class addCBASettings { preInit = 1; };
-			class getNameOfBase {};
+		class addPlayerInfoToArray {};
-			class getNearestBase {};
+		class checkPlayerInventory {};
-			class log {};
+		class createOrUpdateDiaryRecord {};
-			class checkPlayerInventory {};
+		class draw3DIconStatus {};
-			class logSettingChanged {};
+		class getApprovedAssetsCfg {};
-			class padString {};
+		class getBattalionCfg {};
-			class recurseSubclasses {};
+		class getNameOfBase {};
-		};
+		class getNearestBase {};
-	};
+		class log {};
-
+		class logMissionInfo {};
-	class DOUBLES(PREFIX,fbcb2_assets) {
+		class logSettingChanged {};
-		class functions {
+		class padString {};
-			file = "framework\fbcb2_assets\functions";
+		class recurseSubclasses {};
-			class addCBASettings {preInit=1;};
+	};
-			class initServer {};
+};
-			class initClient {};
+
-			class getCallsignFromClassname {};
+class DOUBLES(PREFIX,fbcb2_assets) {
-			class getCurrentAssetsByBase {};
+	class functions {
-			class getInventory {};
+		file = "framework\fbcb2_assets\functions";
-			class getMagsForWeapon {};
+		class addCBASettings {preInit=1;};
-			class getStartingAndCurrentAssets {};
+		class initServer {};
-			class getStartingAssetsByBase {};
+		class initClient {};
-			class getVehicleData {};
+		class getCallsignFromClassname {};
-			class getWeaponry {};
+		class getCurrentAssetsByBase {};
-			class hintAllApprovedAssets {};
+		class getInventory {};
-			class isAssetInRangeOfBase {};
+		class getMagsForWeapon {};
-			class removeAssetDiaryRecords {};
+		class getStartingAndCurrentAssets {};
-			class removeMarkersOnMap {};
+		class getStartingAssetsByBase {};
-			class showMarkersOnMap {};
+		class getVehicleData {};
-			class updateAssetDiary {};
+		class getWeaponry {};
-			class updateAssetsByBase {};
+		class hintAllApprovedAssets {};
-		};
+		class isAssetInRangeOfBase {};
-	};
+		class removeAssetDiaryRecords {};
-
+		class removeMarkersOnMap {};
-	class DOUBLES(PREFIX,fbcb2_main) {
+		class showMarkersOnMap {};
-		class functions {
+		class updateAssetDiary {};
-			file = "framework\fbcb2_main\functions";
+		class updateAssetsByBase {};
-			class initClient {};
+	};
-			class addEnvironmentRecord {};
+};
-			class addFrequenciesRecord {};
+
-			class addSignalColorsRecord {};
+class DOUBLES(PREFIX,fbcb2_main) {
-		};
+	class functions {
-		class util {
+		file = "framework\fbcb2_main\functions";
-			file = "framework\fbcb2_main\util";
+		class initClient {};
-			class formatRadioElementForDiary {};
+		class addEnvironmentRecord {};
-			class generateElementFrequencyRecordText {};
+		class addFrequenciesRecord {};
-		};
+		class addSignalColorsRecord {};
-	};
+	};
-
+	class util {
-	class DOUBLES(PREFIX,mapcopy) {
+		file = "framework\fbcb2_main\util";
-		class functions {
+		class formatRadioElementForDiary {};
-			file = "framework\mapcopy\functions";
+		class generateElementFrequencyRecordText {};
-			class addCBASettings {preInit=1;};
+	};
-			class initClient {};
+};
-			class getMapMarkers {};
+
-			class loadMapMarkers {};
+class DOUBLES(PREFIX,mapcopy) {
-			class mapMarkerToString {};
+	class functions {
-			class stringToMapMarker {};
+		file = "framework\mapcopy\functions";
-		};
+		class addCBASettings {preInit=1;};
-	};
+		class initClient {};
-
+		class getMapMarkers {};
-	class DOUBLES(PREFIX,performance) {
+		class loadMapMarkers {};
-		class functions {
+		class mapMarkerToString {};
-			file = "framework\performance\functions";
+		class stringToMapMarker {};
-			class addCBASettings {preInit=1;};
+	};
-			class addDNI_PlayerFPS { postInit = 1; };
+};
-
+
-			// PFHs managed in addCBASettings onChange code
+class DOUBLES(PREFIX,performance) {
-			class addClientStatsPFH {};
+	class functions {
-			class calculateClientStats {};
+		file = "framework\performance\functions";
-			class addServerStatsPFH {};
+		class addCBASettings {preInit=1;};
-			class calculateServerStats {};
+		class addDNI_PlayerFPS {postInit = 1;};
-		};
+
-	};
+		// PFHs managed in addCBASettings onChange code
-
+		class addClientStatsPFH {};
-	class DOUBLES(PREFIX,reinsert) {
+		class calculateClientStats {};
-		class functions {
+		class addServerStatsPFH {};
-			file = "framework\reinsert\functions";
+		class calculateServerStats {};
-			class addCBASettings {preInit=1;};
+		class addEmptyGroupCleanupPFH {};
-		};
+	};
-		class server {
+};
-			file = "framework\reinsert\server";
+
-			class initServer {};
+class DOUBLES(PREFIX,reinsert) {
-			class addToQueue {};
+	class functions {
-			class globalShowQueue {};
+		file = "framework\reinsert\functions";
-			class removeFromQueue {};
+		class addCBASettings {preInit=1;};
-			class returnReinsertQueueNotification {};
+	};
-			class validateQueue {};
+	class server {
-		};
+		file = "framework\reinsert\server";
-		class client {
+		class initServer {};
-			file = "framework\reinsert\client";
+		class addToQueue {};
-			class initClient {};
+		class globalShowQueue {};
-			class addAceSelfActions {};
+		class removeFromQueue {};
-			class addCheckQueueSelfAction {};
+		class returnReinsertQueueNotification {};
-			class requestShowQueue {};
+		class validateQueue {};
-		};
+	};
-	};
+	class client {
-
+		file = "framework\reinsert\client";
-	class DOUBLES(PREFIX,resupply) {
+		class initClient {};
-		class functions {
+		class addAceSelfActions {};
-			file = "framework\resupply\functions";
+		class addCheckQueueSelfAction {};
-			class addCBASettings {preInit=1;};
+		class requestShowQueue {};
-			class initClient {};
+	};
-			class createBox {};
+};
-			class getSupplyCratesCfg {};
+
-			class addArsenalObjectSpawnBoxActions {};
+class DOUBLES(PREFIX,resupply) {
-		};
+	class functions {
-	};
+		file = "framework\resupply\functions";
-
+		class addCBASettings {preInit=1;};
-	class DOUBLES(PREFIX,triageIcons) {
+		class initClient {};
-		class functions {
+		class createBox {};
-			file = "framework\triageIcons\functions";
+		class getSupplyCratesCfg {};
-			class addCBASettings {preInit=1;};
+		class addArsenalObjectSpawnBoxActions {};
-			class initClient {};
+	};
-			class addDrawIconsPFH {};
+};
-			class addGetEntitiesPFH {};
+
-			class updateColors {};
+class DOUBLES(PREFIX,triageIcons) {
-		};
+	class functions {
-	};
+		file = "framework\triageIcons\functions";
-
+		class addCBASettings {preInit=1;};
-	class DOUBLES(PREFIX,vehicleFlags) {
+		class initClient {};
-		class functions {
+		class draw3D {};
-			file = "framework\vehicleFlags\functions";
+		class updateColors {};
-			class initClient {};
+	};
-			class getActionsFlagCategories {};
+};
-			class getVehicleFlagsCfg {};
+
-			class isClassExcluded {};
+class DOUBLES(PREFIX,vehicleFlags) {
-		};
+	class functions {
-	};
+		file = "framework\vehicleFlags\functions";
-
+		class initClient {};
-	class DOUBLES(PREFIX,zeus) {
+		class addFlagActions {};
-		class functions {
+		class draw3D {};
-			file = "framework\zeus\functions";
+		class getActionsFlagCategories {};
-			class initClient {};
+		class getVehicleFlagsCfg {};
-			class addZenModules {};
+		class isClassExcluded {};
-		};
+	};
+};
+
+class DOUBLES(PREFIX,zeus) {
+	class functions {
+		file = "framework\zeus\functions";
+		class initClient {};
+		class addZenModules {};
 	};
 };

framework/client/functions/fn_addDraw3DPFH.sqf

@@ -0,0 +1,10 @@
+#include "..\script_component.hpp"
+
+
+if (!isNil QGVAR(draw3DPFH)) then {
+	[GVAR(draw3DPFH)] call CBA_fnc_removePerFrameHandler;
+};
+// add pfh that processes queued code
+GVAR(draw3DPFH) = [{
+	{call _x; true;} count (localNamespace getVariable [QGVAR(pfhCode), []]);
+}, 0] call CBA_fnc_addPerFrameHandler;

framework/client/functions/fn_addGetNearMenPFH.sqf

@@ -0,0 +1,17 @@
+#include "..\script_component.hpp"
+
+// subroutine to gather nearest 50 units every 5 seconds and store in GVAR(nearMen)
+// cleanup
+if (!isNil QGVAR(getNearMenPFH)) then {
+	[GVAR(getNearMenPFH)] call CBA_fnc_removePerFrameHandler;
+};
+// add pfh
+GVAR(getNearMenPFH) = [{
+	localNamespace setVariable [
+		QGVAR(nearMen), 
+		(nearestObjects [player,["Man"],50,false]) select {
+			!isNull _x &&
+			player isNotEqualTo _x
+		}
+	];
+}, 1] call CBA_fnc_addPerFrameHandler;

framework/client/functions/fn_addMicroDAGRWaypoints.sqf

@@ -0,0 +1,76 @@
+#include "..\script_component.hpp"
+
+// adds default base locations to players' microDAGR as waypoints
+
+if (!hasInterface) exitWith {};
+
+[{!isNull player}, {
+
+	// add base locations (respawn modules)
+	{
+		private _wpName = [_x] call EFUNC(common,getNameOfBase);
+		private _posASL = getPosASL _x;
+		[_wpName, _posASL] call ace_microdagr_fnc_deviceAddWaypoint;
+	} forEach GVARMAIN(baseObjects);
+
+	// add custom waypoints from mission_settings.hpp
+	private _customWaypoints = [missionConfigFile >> "custom_microdagr_waypoints", "ARRAY", []] call CBA_fnc_getConfigEntry;
+	{
+		_x params [
+			["_wpName", ""],
+			["_pos", [0, 0, 0], [[], ""]],
+			["_object", "", [""]]
+		];
+		private _realPos = nil;
+		// if pos was provided, process
+		if (count _pos >= 2) then {
+			switch (typeName _pos) do {
+				case "ARRAY": {
+					// pos is provided as an array
+					_realPos = _pos select [0, 2];
+					_realPos set [2, getTerrainHeightASL _realPos];
+				};
+				case "STRING": {
+					// pos is provided as a string
+					_realPos = [_pos, true] call ACE_common_fnc_getMapPosFromGrid;
+					_realPos set [2, getTerrainHeightASL _realPos];
+				};
+				default {
+					[
+						LEVEL_WARNING,
+						QUOTE(COMPONENT),
+						format["Invalid position for custom microDAGR waypoint: %1", _wpName],
+					[["name", _wpName], ["pos", _pos], ["object", _object]]] call EFUNC(common,log);
+					continue;
+				};
+			};
+		};
+		// if object was provided, process and override any pos
+		if (count _object > 0) then {
+			// object is provided as a string variable name
+			private _realObject = missionNamespace getVariable _object;
+			if (isNull _realObject) then {
+				[
+					LEVEL_WARNING,
+					QUOTE(COMPONENT),
+					format["Invalid object for custom microDAGR waypoint: %1", _wpName],
+				[["name", _wpName], ["pos", _pos], ["object", _object]]] call EFUNC(common,log);
+				continue;
+			};
+			_realPos = getPosASL (missionNamespace getVariable _object);
+		};
+		if (isNil "_realPos") then {
+			[
+				LEVEL_WARNING,
+				QUOTE(COMPONENT),
+				format["Invalid waypoint position for custom microDAGR waypoint: %1", _wpName],
+			[["name", _wpName], ["pos", _pos], ["object", _object]]] call EFUNC(common,log);
+			continue;
+		};
+
+		[_wpName, _realPos] call ace_microdagr_fnc_deviceAddWaypoint;
+		true;
+	} count _customWaypoints;
+}] call CBA_fnc_waitUntilAndExecute;
+
+nil;

framework/client/functions/fn_bindEventHandlers.sqf

@@ -7,11 +7,19 @@ player addEventHandler["Respawn",
 		params ["_unit", "_corpse"];
 		private _killer = _corpse getVariable ["ace_medical_causeOfDeath", "#scripted"];
 		if (_killer == "respawn_button") then {
+			private _timeWentUnconscious = _corpse getVariable [QGVARMAIN(lastTimeKnockedOut), -1];
+			private _durationSpentUnconscious = -1;
+			if (_timeWentUnconscious > -1) then {
+				_durationSpentUnconscious = diag_tickTime - _timeWentUnconscious;
+			};
+
 			[
 				LEVEL_INFO,
 				QUOTE(COMPONENT),
 				"RESPAWNED WHILE UNCONSCIOUS",
-				[_unit] call EFUNC(common,addPlayerInfoToArray)
+				[_unit, [
+					["durationSpentUnconscious", _durationSpentUnconscious]
+				]] call EFUNC(common,addPlayerInfoToArray)
 			] remoteExec [QEFUNC(common,log), 2];
 		//	format["%1 was unconscious then clicked the respawn button", name _unit] remoteExec["systemChat", 0];
 		};

framework/client/functions/fn_bindUnconsciousListener.sqf

@@ -0,0 +1,13 @@
+#include "..\script_component.hpp"
+
+if (!hasInterface) exitWith {};
+
+["ace_medical_knockOut", { // local event that's also used directly by the ACE medical statemachine
+	private _unit = _this;
+	_this setVariable [QGVARMAIN(lastTimeKnockedOut), diag_tickTime, true];
+}] call CBA_fnc_addEventHandler;
+
+["ace_medical_WakeUp", { // local event that's also used directly by the ACE medical statemachine
+	private _unit = _this;
+	_this setVariable [QGVARMAIN(lastTimeKnockedOut), nil, true];
+}] call CBA_fnc_addEventHandler;

framework/client/functions/fn_clearPFHCode.sqf

@@ -0,0 +1,5 @@
+#include "..\script_component.hpp"
+
+localNamespace setVariable [QGVAR(pfhCode), []];
+
+count [];

framework/client/functions/fn_initClient.sqf

@@ -0,0 +1,28 @@
+#include "..\script_component.hpp"
+
+
+if (!hasInterface) exitWith {};
+
+call FUNC(addMicroDAGRWaypoints);
+call FUNC(addZenModules);
+call FUNC(bindEventHandlers);
+call FUNC(bindVehicleActions);
+
+localNamespace setVariable [QGVAR(nearMen), []];
+call FUNC(addGetNearMenPFH);
+localNamespace setVariable [QGVAR(pfhCode), []];
+call FUNC(addDraw3DPFH);
+
+// add listener that tracks when the player goes unconscious and saves a variable with time
+call FUNC(bindUnconsciousListener);
+
+[
+	LEVEL_DEBUG,
+	QUOTE(COMPONENT),
+	"initClient complete",
+	[]
+] call EFUNC(common,log);
+
+localNamespace setVariable [QGVAR(complete), true];
+
+nil;

framework/client/functions/fn_registerPFHCode.sqf

@@ -0,0 +1,9 @@
+#include "..\script_component.hpp"
+
+params [["_code", {}, [{}]]];
+
+private _pfhCode = localNamespace getVariable [QGVAR(pfhCode), []];
+_pfhCode pushBack _code;
+localNamespace setVariable [QGVAR(pfhCode), _pfhCode];
+
+count _pfhCode;

framework/common/functions/fn_draw3DIconStatus.sqf

@@ -0,0 +1,54 @@
+#include "..\script_component.hpp"
+
+if (!hasInterface) exitWith {};
+
+params [
+	["_drawTargets", [], [[]]],
+	["_icon", "", [""]],
+	["_text", "", [""]],
+	["_color", [], [[]]]
+];
+
+if (count _drawTargets isEqualTo 0) exitWith {};
+
+_cameraPos = positionCameraToWorld [0,0,0];
+_cameraPosASL = AGLToASL _cameraPos;
+
+{
+	_target = _x;
+	_visible = [objNull, "VIEW"] checkVisibility [_cameraPosASL, eyePos _target];
+	
+	if ( _visible isEqualTo 0 ) exitWith {};
+	
+	_objectPos = (_target modelToWorldVisual (_target selectionPosition "pilot"));
+	_distance =  (visiblePosition _target) vectorDiff _cameraPos;
+	
+	_scale = 0;
+	_heightOffset = 0;
+	_heightScaling = 0.012;
+
+	if ( _icon isNotEqualTo "") then {
+		_heightOffset = 0.065;
+		_scale = 1;
+		_heightScaling = 0.075;
+	};
+
+	_drawPos = _objectPos vectorAdd [0, 0, (0.18 + _heightOffset) + (vectorMagnitude _distance * _heightScaling)];
+	
+	drawIcon3D [
+		_icon,
+		_color,
+		_drawPos,
+		_scale,
+		_scale,
+		0,
+		_text,
+		2,
+		0.025
+	];
+	
+	true;
+} count _drawTargets;
+
+nil
+

framework/common/functions/fn_log.sqf

@@ -24,10 +24,10 @@ if (_logLevel < DEBUG_MODE) exitWith {};
 private _hash = createHashMapFromArray _data;
 
 // Replace square brackets with round brackets to avoid parsing issues.
-_message regexReplace ['(\[)', "("];
+[_message, "]", ")"] call CBA_fnc_replace;
-_message regexReplace ['(\])', ")"];
+[_message, "[", "("] call CBA_fnc_replace;
 
 private _json = [_hash] call CBA_fnc_encodeJSON;
-_log = format ["[%1] [%2] [%3] [%4] :: %5", QUOTE(PREFIX), _component, _fnc_scriptNameParent, _message, _json];
+private _log = format ["[%1] [%2] [%3] [%4] :: %5", QUOTE(PREFIX), _component, _fnc_scriptNameParent, _message, _json];
 
 diag_log text _log;

framework/init/functions/fn_addAARChatHandler.sqf

@@ -1,5 +1,7 @@
 #include "..\script_component.hpp"
 
+if (!hasInterface) exitWith {};
+
 [
 	"saveaar", 
 	{

framework/init/functions/fn_addRespawnChatHandler.sqf

@@ -1,17 +1,27 @@
 #include "..\script_component.hpp"
 
+if (!hasInterface) exitWith {};
+
 [
 	"respawn", 
 	{
 		_clientID = _thisArgs select 0;
 		player setDamage 1;
 
+		private _timeWentUnconscious = player getVariable [QGVARMAIN(lastTimeKnockedOut), -1];
+		private _durationSpentUnconscious = -1;
+		if (_timeWentUnconscious > - 1) then {
+			_durationSpentUnconscious = diag_tickTime - _timeWentUnconscious;
+		};
+
 		// log to server RPT
 		[
 			LEVEL_INFO,
 			QUOTE(COMPONENT),
 			"CHAT COMMAND RESPAWN",
-			[player] call EFUNC(common,addPlayerInfoToArray)
+			[player, [
+				["durationSpentUnconscious", _durationSpentUnconscious]
+			]] call EFUNC(common,addPlayerInfoToArray)
 		] remoteExec [QEFUNC(common,log), 2];
 
 		// systemChat to all remote machines

framework/init/functions/fn_checkMissionSettings.sqf

@@ -0,0 +1,41 @@
+#include "..\script_component.hpp"
+
+if (!hasInterface || !is3DENPreview) exitWith {};
+
+private _warningText = [];
+
+if (getText(missionConfigFile >> "author") in ["MISSION AUTHOR", ""]) then {
+	_warningText pushBack "<t font='EtelkaMonospacePro' size='0.7'>mission_settings\author</t> is blank or default!";
+};
+if (getText(missionConfigFile >> "onLoadName") in ["THIS APPEARS ON TOP OF THE LOADING SCREEN IMAGE", ""]) then {
+	_warningText pushBack "<t font='EtelkaMonospacePro' size='0.7'>mission_settings\onLoadName</t> is blank or default!";
+};
+
+if (getText(missionConfigFile >> "briefingName") in ["THIS IS THE NAME ON THE #MISSIONS LIST", ""]) then {
+	_warningText pushBack "<t font='EtelkaMonospacePro' size='0.7'>mission_settings\briefingName</t> is blank or default!";
+};
+if (getText(missionConfigFile >> "overviewText") in ["THIS IS WHERE YOU DESCRIBE THE MISSION IN THE #MISSION LIST", ""]) then {
+	_warningText pushBack "<t font='EtelkaMonospacePro' size='0.7'>mission_settings\overviewText</t> is blank or default!";
+};
+
+if (getText(missionConfigFile >> "missionSeries") in ["MY SERIES NAME", ""]) then {
+	_warningText pushBack "<t font='EtelkaMonospacePro' size='0.7'>mission_settings\missionSeries</t> is blank or default!";
+};
+
+if (count GVARMAIN(baseObjects) isEqualTo 0) then {
+	_warningText pushBack "No respawn points placed!";
+};
+
+if (count _warningText > 0) then {
+	[{
+        if (isNull (call BIS_fnc_displayMission)) exitWith {};
+
+        (_this#0) spawn {
+			[_this joinString "<br/>", "Issues found!", true, false] call BIS_fnc_guiMessage;
+		};
+        [_this#1] call CBA_fnc_removePerFrameHandler;
+
+    }, 1, _warningText] call CBA_fnc_addPerFrameHandler;
+};
+
+nil;

framework/init/functions/fn_initClient.sqf

@@ -1,19 +1,17 @@
 #include "..\script_component.hpp"
 
-if ( !hasInterface ) exitWith {};
+if (!hasInterface) exitWith {};
-
-["milsim_logText", {
-	params [["_strArray", [""], [[]]]];
-	{
-		diag_log text _x;
-	} forEach _strArray;
-}] call CBA_fnc_addEventHandler;
 
 // make sure the server has finished init
 waitUntil {!isNil QGVARMAIN(complete)};
 
 ["InitializePlayer", [player, true]] call BIS_fnc_dynamicGroups;
 
+// run primary init functions
+call FUNC(addAARChatHandler);
+call FUNC(addRespawnChatHandler);
+call FUNC(setDefaults);
+
 // Initialize a holder for managing local diary records
 // store records in format:
 // [subject, [
@@ -23,6 +21,7 @@ EGVAR(common,diaryRecords) = createHashMap;
 
 
 // initialize other modules
+call EFUNC(client,initClient);
 call EFUNC(mapcopy,initClient);
 call EFUNC(reinsert,initClient);
 call EFUNC(resupply,initClient);
@@ -33,6 +32,8 @@ call EFUNC(fbcb2_main,initClient);
 call EFUNC(fbcb2_assets,initClient);
 
 
+call FUNC(checkMissionSettings);
+
 [
 	LEVEL_DEBUG,
 	QUOTE(COMPONENT),

framework/init/functions/fn_initServer.sqf

@@ -9,16 +9,6 @@ publicVariable QGVARMAIN(baseObjects);
 // Initializes the Dynamic Groups framework and groups
 ["Initialize", [true]] call BIS_fnc_dynamicGroups;
 
-if (isDedicated) then {
-	["milsim_logText", {
-		params [["_strArray", [""], [[]]]];
-		{
-			diag_log text _x;
-		} forEach _strArray;
-	}] call CBA_fnc_addEventHandler;
-};
-
-
 // initialize other modules
 call EFUNC(common,logMissionInfo);
 call EFUNC(fbcb2_assets,initServer);

framework/init/functions/fn_setDefaults.sqf

@@ -1,5 +1,7 @@
 #include "..\script_component.hpp"
 
+if (!hasInterface) exitWith {};
+
 enableSaving[false, false];
 
 enableRadio false;

framework/mapcopy/functions/fn_initClient.sqf

@@ -10,6 +10,9 @@ private _mapCopyAction =
 	"\a3\ui_f\data\igui\cfg\actions\talk_ca.paa",
 	{
 		params ["_target", "_player", "_params"];
+		if (!isPlayer _target) exitWith {
+			format["%1 is not a player", name _target] call CBA_fnc_notify;
+		};
 		format["Copying map markers from %1", name _target] call CBA_fnc_notify;
 		[QGVAR(mapCopyRequest), _this, _target] call CBA_fnc_targetEvent;
 	},

framework/performance/functions/fn_addCBASettings.sqf

@@ -1,5 +1,27 @@
 #include "..\script_component.hpp"
 
+[
+	QGVAR(emptyGroupCleanup_enable),
+	"CHECKBOX",
+	"Empty Group Cleanup Enabled",
+	[QUOTE(SETTINGS_GROUP_NAME), QUOTE(COMPONENT_BEAUTIFIED)],
+	true,
+	true,
+	{
+		params ["_value"];
+		[
+			QGVAR(emptyGroupCleanup_enable),
+			_value
+		] call EFUNC(common,logSettingChanged);
+
+		if (!isNull (missionNamespace getVariable [QGVAR(emptyGroupCleanupPFH), locationNull])) then {
+			deleteLocation GVAR(emptyGroupCleanupPFH);
+		};
+
+		call FUNC(addEmptyGroupCleanupPFH);
+	}
+] call CBA_fnc_addSetting;
+
 //---------------------
 //	Server CPS
 //---------------------

framework/performance/functions/fn_addEmptyGroupCleanupPFH.sqf

@@ -7,7 +7,7 @@
 	[]
 ] call EFUNC(common,log);
 
-_emptyGroupPFH = [
+GVAR(emptyGroupCleanupPFH) = [
 	{ 
 		{
 			if (local _x) then {
@@ -19,7 +19,7 @@ _emptyGroupPFH = [
 	},
 	300,
 	[],
-	{ 
+	{ // on creation
 		[
 			LEVEL_INFO,
 			QUOTE(COMPONENT),
@@ -27,15 +27,16 @@ _emptyGroupPFH = [
 			[]
 		] call EFUNC(common,log);
 	},
-	{ 	[
+	{ // on deletion
+		[
 			LEVEL_INFO,
 			QUOTE(COMPONENT),
 			"Empty group deletion PFH unloaded",
 			[]
 		] call EFUNC(common,log);
 	},
-	{ true },
+	{ (missionNamespace getVariable [QGVAR(emptyGroupCleanup_enable), false]) },
-	{ false },
+	{ not (missionNamespace getVariable [QGVAR(emptyGroupCleanup_enable), false]) },
 	[]
 ] call CBA_fnc_createPerFrameHandlerObject;
 

framework/triageIcons/functions/fn_addGetEntitiesPFH.sqf

@@ -1,18 +0,0 @@
-#include "..\script_component.hpp"
-
-// subroutine to gather nearest 50 units every 5 seconds and store in GVAR(drawTargets)
-// cleanup
-if (!isNil QGVAR(getEntitiesPFH)) then {
-	[GVAR(getEntitiesPFH)] call CBA_fnc_removePerFrameHandler;
-};
-// add pfh
-GVAR(getEntitiesPFH) = [{
-	GVAR(drawTargets) = (
-		(allUnits + allDeadMen) select {
-			_x isKindOf "CAManBase" && 
-			player distance _x < 50 &&
-			!isNull _x &&
-			player isNotEqualTo _x
-		}
-	);
-}, 10] call CBA_fnc_addPerFrameHandler;

framework/triageIcons/functions/fn_draw3D.sqf

@@ -1,6 +1,6 @@
 /*
 
-milsim_fnc_addMedicalOverlayPFH
+milsim_triageIcons_fnc_draw3D
 
 Author: IndigoFox
 
@@ -14,29 +14,19 @@ Description:
 
 #include "..\script_component.hpp"
 
+if (!hasInterface) exitWith {};
 
-// Per-frame handler to draw icons
+
-// cleanup
+// adds codeblock to common array to be processed per frame
-if (!isNil QGVAR(drawIconsPfh)) then {
+private _code = {
-	[GVAR(drawIconsPfh)] call CBA_fnc_removePerFrameHandler;
-};
-// add pfh
-GVAR(drawIconsPfh) = [{
 	// if disabled, skip processing
 	if (!GVAR(setting_enabled)) exitWith {false};
-	// if no targets, skip processing
+
-	if (count GVAR(drawTargets) == 0) exitWith {false};
 	// if the player doesn't have medical perms, skip processing
 	if !([player] call ace_medical_treatment_fnc_isMedic) exitWith {false};
+
 	{
 		private _unit = _x;
-		// distance within X meters
-		if (player distance _unit > GVAR(setting_drawRange)) then {continue};
-		// check unit not null, not conscious, and not in a vehicle
-		if (
-			!(_unit getVariable ["ACE_isUnconscious", false]) ||
-			!isNull (objectParent _unit)
-		) then {continue};
 	
 		// color based on triage level
 		private _triageLevel = _unit getVariable ["ace_medical_triageLevel", 4];
@@ -57,6 +47,17 @@ GVAR(drawIconsPfh) = [{
 			true // outline
 			// further params optional, omitted
 		];
-	} forEach GVAR(drawTargets);
-}, 0, []] call CBA_fnc_addPerFrameHandler;
 		
+		true;
+	} count (
+		(localNamespace getVariable [QEGVAR(client,nearMen), []]) select {
+			// is unconscious and is NOT in vehicle and is within draw range
+			(_x getVariable ["ACE_isUnconscious", false]) &&
+			isNull (objectParent _x) &&
+			player distance _x <= GVAR(setting_drawRange)
+		}
+	);
+};
+
+// add codeblock to common array
+[_code] call EFUNC(client,registerPFHCode);

framework/triageIcons/functions/fn_initClient.sqf

@@ -1,7 +1,8 @@
 #include "..\script_component.hpp"
 
-// List of units to draw icons for
+if (!hasInterface) exitWith {};
-GVAR(drawTargets) = []; 
+
+call FUNC(draw3D);
 
 [
 	LEVEL_DEBUG,

framework/vehicleFlags/functions/fn_addFlagActions.sqf

@@ -0,0 +1,103 @@
+#include "..\script_component.hpp"
+
+private _vehicleFlagsCfg = call FUNC(getVehicleFlagsCfg);
+
+if (!isClass _vehicleFlagsCfg) exitWith {
+	["WARNING: Vehicle Flags: Vehicle Flags config not found. Vehicle Flags will not be available."] call BIS_fnc_error;
+};
+
+private _baseClassesToApplyActionsFor = 
+	(_vehicleFlagsCfg >> "baseClassesToApplyActionsFor") call BIS_fnc_getCfgDataArray;
+private _flagCategoryCfgs = (_vehicleFlagsCfg >> "FlagCategories") call BIS_fnc_returnChildren;
+
+{ // forEach _baseClassesToApplyActionsFor
+	private _parentClass = _x;
+
+	////////////////////////////////////////////////////////////////////////
+	// create the root action
+	////////////////////////////////////////////////////////////////////////
+	private _rootActionID = QGVAR(SetVehicleFlagAction);
+	private _flagRootAction = [
+		_rootActionID, // id
+		"Set Vehicle Flag", // displayed title
+		"\A3\ui_f\data\map\markers\flags\nato_ca.paa", // flag icon
+		{
+			params ["_target", "_player", "_params"];
+			// set broadcasted variable of self to indicate we're looking at flags
+			_player setVariable [QGVAR(inFlagMenu), true, true];
+			[{_this setVariable [QGVAR(inFlagMenu), false, true];}, _player, 3] call CBA_fnc_waitAndExecute;
+			true
+		}, // statement
+		{
+			params ["_target", "_player", "_params"];
+			// _params params ["_parentActionID", "_flagCategories"];
+			
+			// check if vehicle is excluded
+			private _excluded = [typeOf _target] call FUNC(isClassExcluded);
+			if (_excluded || !alive _target) exitWith {false};
+			
+			true;
+		}, // condition
+		{
+			////////////////////////////////////////////////////////////////////////
+			// create the flag category actions (with nested flag actions)
+			////////////////////////////////////////////////////////////////////////
+			params ["_target", "_player", "_params"];
+			_params params ["_rootActionID"];
+
+			private _vehicleFlagsCfg = call FUNC(getVehicleFlagsCfg);
+			if (isNull _vehicleFlagsCfg) exitWith {[]};
+			private _flagCategoryCfgs = (_vehicleFlagsCfg >> "FlagCategories") call BIS_fnc_returnChildren;
+
+			// return category child actions with individual flag actions nested as children
+			[_rootActionID, _flagCategoryCfgs] call FUNC(getActionsFlagCategories);
+
+		}, // child code
+		[_rootActionID], // params
+		nil, // position
+		4, // distance
+		[false, false, false, true, false], // other params - run on hover is true
+		nil // modifier function code
+	] call ace_interact_menu_fnc_createAction;
+
+	////////////////////////////////////////////////////////////////////////
+	// add root action to add flags
+	////////////////////////////////////////////////////////////////////////
+	[
+		_parentClass, // parent classname
+		0, // action 0 or self-action 1
+		["ACE_MainActions"], // parent
+		_flagRootAction, // action
+		true // apply to child classes
+	] call ace_interact_menu_fnc_addActionToClass;
+	
+	////////////////////////////////////////////////////////////////////////
+	// add action to remove flag under the root action
+	////////////////////////////////////////////////////////////////////////
+	// create action
+	private _removeFlagAction = [
+		_rootActionID + "_removeflag", // id
+		"Remove Flag", // displayed title
+		"\A3\ui_f\data\map\markers\flags\nato_ca.paa", // flag icon
+		{
+			params ["_target", "_player", "_params"];
+			_target forceFlagTexture "";
+		}, // statement
+		{
+			params ["_target", "_player", "_params"];
+			alive _target && getForcedFlagTexture _target != "";
+		}, // condition
+		nil // child code
+	] call ace_interact_menu_fnc_createAction;
+
+	// add the action to the vehicle
+	// in this class event handler, this#0 will be the vehicle
+	[
+		_parentClass, // parent classname
+		0, // action 0 or self-action 1
+		["ACE_MainActions", _rootActionID], // parent
+		_removeFlagAction, // action
+		true // apply to child classes
+	] call ace_interact_menu_fnc_addActionToClass;
+
+} forEach _baseClassesToApplyActionsFor;

framework/vehicleFlags/functions/fn_draw3D.sqf

@@ -0,0 +1,24 @@
+#include "..\script_component.hpp"
+
+// we'll use this to display status if nearby players are in the flag menu
+
+// adds codeblock to common array to be processed per frame
+private _code = {
+	private _unitsToDraw = (localNamespace getVariable [QEGVAR(client,nearMen), []]) select {
+		(_x getVariable [QGVAR(inFlagMenu), false]) && {
+			// distance within X meters
+			player distance _x <= 15 ||
+			// check unit not in a vehicle
+			isNull (objectParent _x)
+		}
+	};
+	[
+		_unitsToDraw,
+		"",
+		"Setting vehicle flag...",
+		[0.9, 0.9, 0.9, 1]
+	] call EFUNC(common,draw3dIconStatus);
+};
+
+// add codeblock to common array
+[_code] call EFUNC(client,registerPFHCode);

framework/vehicleFlags/functions/fn_initClient.sqf

@@ -2,101 +2,8 @@
 
 if (!hasInterface) exitWith {};
 
-private _vehicleFlagsCfg = call FUNC(getVehicleFlagsCfg);
+call FUNC(addFlagActions);
-
+call FUNC(draw3D);
-if (!isClass _vehicleFlagsCfg) exitWith {
-	["WARNING: Vehicle Flags: Vehicle Flags config not found. Vehicle Flags will not be available."] call BIS_fnc_error;
-};
-
-private _baseClassesToApplyActionsFor = 
-	(_vehicleFlagsCfg >> "baseClassesToApplyActionsFor") call BIS_fnc_getCfgDataArray;
-private _flagCategoryCfgs = (_vehicleFlagsCfg >> "FlagCategories") call BIS_fnc_returnChildren;
-
-{ // forEach _baseClassesToApplyActionsFor
-	private _parentClass = _x;
-
-	////////////////////////////////////////////////////////////////////////
-	// create the root action
-	////////////////////////////////////////////////////////////////////////
-	private _rootActionID = QGVAR(SetVehicleFlagAction);
-	private _flagRootAction = [
-		_rootActionID, // id
-		"Set Vehicle Flag", // displayed title
-		"\A3\ui_f\data\map\markers\flags\nato_ca.paa", // flag icon
-		{true}, // statement
-		{
-			params ["_target", "_player", "_params"];
-			// _params params ["_parentActionID", "_flagCategories"];
-			
-			// check if vehicle is excluded
-			private _excluded = [typeOf _target] call FUNC(isClassExcluded);
-			if (_excluded || !alive _target) exitWith {false};
-			
-			true;
-		}, // condition
-		{
-			////////////////////////////////////////////////////////////////////////
-			// create the flag category actions (with nested flag actions)
-			////////////////////////////////////////////////////////////////////////
-			params ["_target", "_player", "_params"];
-			_params params ["_rootActionID"];
-
-			private _vehicleFlagsCfg = call FUNC(getVehicleFlagsCfg);
-			if (isNull _vehicleFlagsCfg) exitWith {[]};
-			private _flagCategoryCfgs = (_vehicleFlagsCfg >> "FlagCategories") call BIS_fnc_returnChildren;
-
-			// return category child actions with individual flag actions nested as children
-			[_rootActionID, _flagCategoryCfgs] call FUNC(getActionsFlagCategories);
-
-		}, // child code
-		[_rootActionID], // params
-		nil, // position
-		4, // distance
-		[false, false, false, false, false], // other params
-		nil // modifier function code
-	] call ace_interact_menu_fnc_createAction;
-
-	////////////////////////////////////////////////////////////////////////
-	// add root action to add flags
-	////////////////////////////////////////////////////////////////////////
-	[
-		_parentClass, // parent classname
-		0, // action 0 or self-action 1
-		["ACE_MainActions"], // parent
-		_flagRootAction, // action
-		true // apply to child classes
-	] call ace_interact_menu_fnc_addActionToClass;
-	
-	////////////////////////////////////////////////////////////////////////
-	// add action to remove flag under the root action
-	////////////////////////////////////////////////////////////////////////
-	// create action
-	private _removeFlagAction = [
-		_rootActionID + "_removeflag", // id
-		"Remove Flag", // displayed title
-		"\A3\ui_f\data\map\markers\flags\nato_ca.paa", // flag icon
-		{
-			params ["_target", "_player", "_params"];
-			_target forceFlagTexture "";
-		}, // statement
-		{
-			params ["_target", "_player", "_params"];
-			alive _target && getForcedFlagTexture _target != "";
-		}, // condition
-		nil // child code
-	] call ace_interact_menu_fnc_createAction;
-
-	// add the action to the vehicle
-	// in this class event handler, this#0 will be the vehicle
-	[
-		_parentClass, // parent classname
-		0, // action 0 or self-action 1
-		["ACE_MainActions", _rootActionID], // parent
-		_removeFlagAction, // action
-		true // apply to child classes
-	] call ace_interact_menu_fnc_addActionToClass;
-
-} forEach _baseClassesToApplyActionsFor;
 
 [
 	LEVEL_DEBUG,

mission_settings.hpp

@@ -9,8 +9,21 @@ overviewText = "THIS IS WHERE YOU DESCRIBE THE MISSION IN THE #MISSION LIST";
 // The name for the series of missions of your campaign. Used for organizational and search purposes
 missionSeries = "MY SERIES NAME";
 
-// activate via #ace-fortify west base 2000
 
+// Add waypoints to players' MicroDAGR devices
+// respawn locations (bases) are added by default, don't put them here
+custom_microdagr_waypoints[] = {
+    // the first element is the waypoint name
+    // the second element is the position of the waypoint - you may use a string for map grid (up to 10 digit) or an array for {X, Y} coordinates
+    // the third element is optional - provide the variable name of an object if you want to use its initial position instead
+    // {"WAYPOINT NAME", {POSITION <[x,y]>}, OBJECT <objNull>},
+    // EXAMPLES:
+    //      {"KAVALA HOSPITAL", {1234.56, 7890.12}, ""},
+    //      {"CAMP TEMPEST", "03421460, ""},
+    //      {"MY CUSTOM OBJECT", {}, "myCustomObject"}
+};
+
+// activate via #ace-fortify west base 2000
 class ACEX_Fortify_Presets {
     class base {
         displayName = "Ken Custom";