Plugin - Add Mumble support

.github/workflows/release.yml

@@ -88,13 +88,13 @@ jobs:
       run: |
         cd extensions\\vcproj
         cmake .. -A Win32
-        msbuild ACRE.sln /m '/t:ACRE2Arma\acre;ACRE2Arma\arma2ts;ACRE2\ACRE2Steam;ACRE2\ACRE2TS;Extras\Wav2B64' /p:Configuration=RelWithDebInfo
+        msbuild ACRE.sln /m '/t:ACRE2Arma\acre;ACRE2Arma\arma2ts;ACRE2\ACRE2Mumble;ACRE2\ACRE2Steam;ACRE2\ACRE2TS;Extras\Wav2B64' /p:Configuration=RelWithDebInfo
     - name: Build Extensions (x64)
       if: matrix.arch == 'x64'
       run: |
         cd extensions\\vcproj64
         cmake .. -A x64
-        msbuild ACRE.sln /m '/t:ACRE2Arma\acre;ACRE2Arma\arma2ts;ACRE2\ACRE2Steam;ACRE2\ACRE2TS' /p:Configuration=RelWithDebInfo
+        msbuild ACRE.sln /m '/t:ACRE2Arma\acre;ACRE2Arma\arma2ts;ACRE2\ACRE2Mumble;ACRE2\ACRE2Steam;ACRE2\ACRE2TS' /p:Configuration=RelWithDebInfo
     - name: Sign (BattlEye)
       run: |
         .\ci\battleye\signtool.exe sign /f .\ci\battleye\idi-systems.pfx /p ${{ secrets.BE_CRED_PASSWORD }} /t http://timestamp.digicert.com *.dll

addons/main/script_macros.hpp

@@ -108,7 +108,7 @@ SQF equivalent of extensions/src/ACRE2Shared/Types.h
 #define SCRATCH_GET(radioId, key) ([radioId, key] call EFUNC(sys_data,getScratchData))
 #define SCRATCH_GET_DEF(radioId, key, defaultVal) ([radioId, key, defaultVal] call EFUNC(sys_data,getScratchData))
 
-#define GET_TS3ID(object) (object call { private _ret = (_this getVariable [QGVAR(ts3id), -1]); if (_ret == -1) then { WARNING_1("%1 has no TS3 ID",_this); }; _ret })
+#define GET_VOIPID(object) (object call { private _ret = (_this getVariable [QGVAR(voipId), -1]); if (_ret == -1) then { WARNING_1("%1 has no VOIP ID",_this); }; _ret })
 
 #define IS_HASH(hash) (hash isEqualType locationNull && {(type hash) isEqualTo "ACRE_FastHashNamespaceDummy"})
 

addons/main/script_version.hpp

@@ -1,4 +1,4 @@
 #define MAJOR 2
 #define MINOR 10
 #define PATCHLVL 0
-#define BUILD 1050
+#define BUILD 1051

addons/sys_core/XEH_postInit.sqf

@@ -5,7 +5,7 @@
 
 if (!hasInterface) exitWith {};
 
-// Ensure the TeamSpeak plugin handler code is initialized first
+// Ensure the VOIP plugin handler code is initialized first
 [] call EFUNC(sys_io,startServer);
 
 ["handleGetClientID", FUNC(handleGetClientID)] call EFUNC(sys_rpc,addProcedure);
@@ -145,7 +145,7 @@ if (getClientStateNumber < 10) then { // Check before game has started (in brief
             ["setSoundSystemMasterOverride", [0]] call EFUNC(sys_rpc,callRemoteProcedure);
             [_this select 1] call CBA_fnc_removePerFrameHandler;
         } else {
-            // Keep calling incase ACRE is not connected to TeamSpeak
+            // Keep calling incase ACRE is not connected to VOIP solution
             ["setSoundSystemMasterOverride", [1]] call EFUNC(sys_rpc,callRemoteProcedure);
         };
     }, 0, []] call CBA_fnc_addPerFrameHandler;

addons/sys_core/XEH_preInit.sqf

@@ -25,13 +25,13 @@ DGVAR(lowered) = false;
 DGVAR(muting) = [];
 DGVAR(speakers) = [];
 DGVAR(enableDistanceMuting) = true;
-DGVAR(ts3id) = -1;
+DGVAR(voipId) = -1;
 DGVAR(keyedMicRadios) = [];
 DGVAR(keyedRadioIds) = HASH_CREATE;
 DGVAR(globalVolume) = 1.0;
 DGVAR(maxVolume) = 1.0;
 DGVAR(playerList) = []; // Paired array: [TS_ID, Object]
-//DGVAR(ts3IdPlayerList) = [];
+//DGVAR(voipIdPlayerList) = [];
 DGVAR(isDeaf) = false;
 //DGVAR(playerListHash) = HASH_CREATE;
 DGVAR(spectatorSpeakers) = [];

addons/sys_core/fnc_coreInitPFH.sqf

@@ -19,9 +19,9 @@
 if (isNull player) exitWith {};
 acre_player = player;
 
-if (!ACRE_MAP_LOADED || {!ACRE_DATA_SYNCED} || {GVAR(ts3id) == -1}) exitWith {};
+if (!ACRE_MAP_LOADED || {!ACRE_DATA_SYNCED} || {GVAR(voipId) == -1}) exitWith {};
 
-TRACE_1("GOT TS3 ID", GVAR(ts3id));
+TRACE_1("GOT VOIP ID", GVAR(voipId));
 
 [] call FUNC(utilityFunction); // OK
 [] call FUNC(muting);

addons/sys_core/fnc_cycleLanguage.sqf

@@ -28,7 +28,7 @@ if (_numSpokenLanguages > 1) then {
     ["acre_cycleLanguage", _languageName, "Now speaking", "", 1, EGVAR(sys_list,LanguageColor)] call EFUNC(sys_list,displayHint);
     [] call FUNC(updateSelf);
     if (ACRE_LOCAL_SPEAKING) then {
-        //@TODO: This is an uber hack, should probably be set up as a TS event.
+        //@TODO: This is an uber hack, should probably be set up as a Mumble/TS event.
         //Basically we update globally a locally set object variable from the
         //start speaking event when they cycle languages while talking.
         acre_player setVariable [QGVAR(languageId), _languageId, true];

addons/sys_core/fnc_getAlive.sqf

@@ -24,8 +24,8 @@ if (_unit isEqualTo acre_player) then {
     };
 } else {
     if (!isNull _unit) then {
-        private _ts3id = GET_TS3ID(_unit);
-        if ((alive _unit && {!(_ts3id in ACRE_SPECTATORS_LIST)}) || {(ACRE_IS_SPECTATOR && {!ACRE_MUTE_SPECTATORS} && {_ts3id in ACRE_SPECTATORS_LIST})}) then {
+        private _voipId = GET_VOIPID(_unit);
+        if ((alive _unit && {!(_voipId in ACRE_SPECTATORS_LIST)}) || {(ACRE_IS_SPECTATOR && {!ACRE_MUTE_SPECTATORS} && {_voipId in ACRE_SPECTATORS_LIST})}) then {
             _ret = 1;
         };
     };

addons/sys_core/fnc_getClientIdLoop.sqf

@@ -1,7 +1,7 @@
 #include "script_component.hpp"
 /*
  * Author: ACRE2Team
- * This function exists to setup the process for sending our object and player ID to other clients to associate with our TeamSpeak ID.
+ * This function exists to setup the process for sending our object and player ID to other clients to associate with our VOIP ID.
  *
  * Arguments:
  * None

addons/sys_core/fnc_handleGetClientID.sqf

@@ -1,11 +1,11 @@
 #include "script_component.hpp"
 /*
  * Author: ACRE2Team
- * Handles receipt of TS client ID alongside its objects network ID.
+ * Handles receipt of Mumble/TS client ID alongside its objects network ID.
  *
  * Arguments:
- * 0: TS client ID <STRING>
- * 1: Net ID of object for TS client ID <STRING>
+ * 0: Mumble/TS client ID <STRING>
+ * 1: Net ID of object for Mumble/TS client ID <STRING>
  *
  * Return Value:
  * Handled <BOOL>
@@ -16,48 +16,48 @@
  * Public: No
  */
 
-params ["_newTs3Id","_netId"];
+params ["_newVoipId", "_netId"];
 
-_newTs3Id = parseNumber _newTs3Id;
+_newVoipId = parseNumber _newVoipId;
 
 private _playerObject = objectFromNetId _netId;
 TRACE_1("got client ID", _this);
 if (_playerObject == acre_player) then {
     private _resendSpectator = false;
-    if (_newTs3Id != GVAR(ts3id)) then {
+    if (_newVoipId != GVAR(voipId)) then {
         if (ACRE_IS_SPECTATOR) then {
             [] call FUNC(spectatorOff);
             _resendSpectator = true;
         };
     };
-    GVAR(ts3id) = _newTs3Id;
+    GVAR(voipId) = _newVoipId;
     if (_resendSpectator) then {
         [] call FUNC(spectatorOn)
     };
-    TRACE_1("SETTING TS3ID",GVAR(ts3id));
+    TRACE_1("SETTING VOIPID",GVAR(voipId));
 } else {
-    _playerObject setVariable [QGVAR(ts3id), _newTs3Id, false];
+    _playerObject setVariable [QGVAR(voipId), _newVoipId, false];
 };
 
-//Ensure the incoming TS ID is pointing to the correct unit.
+// Ensure the incoming Mumble/TS ID is pointing to the correct unit.
 private _found = false;
 {
-    _x params ["_remoteTs3Id","_remoteUser"];
-    if (_remoteTs3Id == _newTs3Id) exitWith {
+    _x params ["_remoteVoipId", "_remoteUser"];
+    if (_remoteVoipId == _newVoipId) exitWith {
         _found = true;
         if (_playerObject != _remoteUser) then {
-            GVAR(playerList) set [_forEachIndex, [_newTs3Id, _playerObject]];
+            GVAR(playerList) set [_forEachIndex, [_newVoipId, _playerObject]];
             //If changed remove.
             REM(GVAR(speakers),_remoteUser);
-            REM(GVAR(spectatorSpeakers),_remoteTs3Id);
-            REM(GVAR(godSpeakers),_remoteTs3Id);
+            REM(GVAR(spectatorSpeakers),_remoteVoipId);
+            REM(GVAR(godSpeakers),_remoteVoipId);
             REM(GVAR(keyedMicRadios),_remoteUser);
         };
-        // Case where objects dont match but we found our TS ID.
+        // Case where objects dont match but we found our Mumble/TS ID.
     };
 } forEach (GVAR(playerList));
 if (!_found) then {
-    GVAR(playerList) pushBack [_newTs3Id,_playerObject];
+    GVAR(playerList) pushBack [_newVoipId,_playerObject];
 };
 
 true

addons/sys_core/fnc_handleGetHeadVector.sqf

@@ -1,7 +1,7 @@
 #include "script_component.hpp"
 /*
  * Author: ACRE2Team
- * Sends the current head direction vector to the TeamSpeak plugin.
+ * Sends the current head direction vector to the VOIP plugin.
  *
  * Arguments:
  * None

addons/sys_core/fnc_handleGetPluginVersion.sqf

@@ -1,10 +1,10 @@
 #include "script_component.hpp"
 /*
  * Author: ACRE2Team
- * Handles the return of the current plugin version from TeamSpeak. Displays messages to the player if any of the versions do not match.
+ * Handles the return of the current plugin version from VOIP. Displays messages to the player if any of the versions do not match.
  *
  * Arguments:
- * 0: TeamSpeak plugin version <STRING>
+ * 0: VOIP plugin version <STRING>
  *
  * Return Value:
  * Handled <BOOL>
@@ -35,7 +35,7 @@ if (!ACRE_SPIT_VERSION && {!isNil "ACRE_FULL_SERVER_VERSION"}) then {
 
 if (_warn) then {
     ACRE_HAS_WARNED = true;
-    ERROR_WITH_TITLE_3("Mismatched TeamSpeak plugin or mod versions!","\nTeamSpeak plugin version: %1\nYour version: %2\nServer version: %3",GVAR(pluginVersion),QUOTE(VERSION_STR),ACRE_FULL_SERVER_VERSION);
+    ERROR_WITH_TITLE_3("Mismatched VOIP plugin or mod versions!","\nVOIP plugin version: %1\nYour version: %2\nServer version: %3",GVAR(pluginVersion),QUOTE(VERSION_STR),ACRE_FULL_SERVER_VERSION);
 } else {
     if (ACRE_HAS_WARNED) then {
         ACRE_HAS_WARNED = false;

addons/sys_core/fnc_isMuted.sqf

@@ -1,7 +1,7 @@
 #include "script_component.hpp"
 /*
  * Author: ACRE2Team
- * This function determines is used to check if the unit should be muted on TeamSpeak or not.
+ * This function determines is used to check if the unit should be muted on VOIP or not.
  *
  * Arguments:
  * 0: unit <OBJECT>

addons/sys_core/fnc_localStartSpeaking.sqf

@@ -48,7 +48,7 @@ if (!GVAR(fullDuplex) && {ACRE_BROADCASTING_RADIOID != ""}) then {
                 private _unit = _x select 0;
                 if (!isNull _unit && {_unit != acre_player}) then {
                     private _canUnderstand = [_unit] call FUNC(canUnderstand);
-                    ["updateSpeakingData", ["r", GET_TS3ID(_unit), !_canUnderstand, 1, 0, 1, 0, false, [0, 0, 0]]] call EFUNC(sys_rpc,callRemoteProcedure);
+                    ["updateSpeakingData", ["r", GET_VOIPID(_unit), !_canUnderstand, 1, 0, 1, 0, false, [0, 0, 0]]] call EFUNC(sys_rpc,callRemoteProcedure);
                 };
             } forEach (_sources select _forEachIndex);
         };

addons/sys_core/fnc_localStopSpeaking.sqf

@@ -29,6 +29,6 @@ if (isNil "ACRE_CustomVolumeControl") then {
     EGVAR(sys_gui,volumeLevel) call EFUNC(sys_gui,setVoiceCurveLevel);
 };
 
-//[str GVAR(ts3id), netId acre_player] call FUNC(remoteStopSpeaking);
+//[str GVAR(voipId), netId acre_player] call FUNC(remoteStopSpeaking);
 
 true

addons/sys_core/fnc_muting.sqf

@@ -1,7 +1,8 @@
 #include "script_component.hpp"
 /*
  * Author: ACRE2Team
- * Sets up the per frame event handler to mute and unmute clients on TeamSpeak. The muting occurs to optimize TeamSpeak bandwidth as voice data is not sent for muted clients.
+ * Sets up the per frame event handler to mute and unmute clients on ^VOIP. The muting occurs to optimize VOIP
+ * bandwidth as voice data is not sent for muted clients.
  *
  * Arguments:
  * None
@@ -39,15 +40,15 @@ DFUNC(mutingPFHLoop) = {
         _dynamicPos = positionCameraToWorld [0, 0, 0];
     };
     {
-        _x params ["_remoteTs3Id","_remoteUser"];
+        _x params ["_remoteVoipId", "_remoteUser"];
         if (_remoteUser != acre_player) then {
             private _muted = 0;
-            //private _remoteTs3Id = (_remoteUser getVariable QGVAR(ts3id));
-            //if (!(isNil "_remoteTs3Id")) then {
-                if !(_remoteTs3Id in ACRE_SPECTATORS_LIST) then {
+            //private _remoteVoipId = (_remoteUser getVariable QGVAR(voipId));
+            //if (!(isNil "_remoteVoipId")) then {
+                if !(_remoteVoipId in ACRE_SPECTATORS_LIST) then {
                     private _isRemotePlayerAlive = [_remoteUser] call FUNC(getAlive);
                     if (_isRemotePlayerAlive == 1) then {
-                        //_playerIdList pushBack _remoteTs3Id;
+                        //_playerIdList pushBack _remoteVoipId;
 
                         // private _radioListRemote = [_remoteUser] call EFUNC(sys_data,getRemoteRadioList);
                         // private _radioListLocal = [] call EFUNC(sys_data,getPlayerRadioList);
@@ -61,10 +62,10 @@ DFUNC(mutingPFHLoop) = {
                         };
 
                         if (GVAR(fullListTime)) then {
-                            _mutingParams = _mutingParams + format ["%1,%2,", _remoteTs3Id, _muted];
+                            _mutingParams = _mutingParams + format ["%1,%2,", _remoteVoipId, _muted];
                         } else {
                             if ((_muted == 0 && {_remoteUser in GVAR(muting)}) || {(_muted == 1 && {!(_remoteUser in GVAR(muting))})}) then {
-                                _mutingParams = _mutingParams + format ["%1,%2,", _remoteTs3Id, _muted];
+                                _mutingParams = _mutingParams + format ["%1,%2,", _remoteVoipId, _muted];
                             };
                         };
                     };
@@ -82,7 +83,7 @@ DFUNC(mutingPFHLoop) = {
         };
         if (_newSpectators isNotEqualTo []) then {
             {
-                if (_x != GVAR(ts3id)) then {
+                if (_x != GVAR(voipId)) then {
                     _mutingParams = _mutingParams + format ["%1,1,", _x];
                 };
             } forEach _newSpectators;
@@ -94,7 +95,7 @@ DFUNC(mutingPFHLoop) = {
         if ((str ACRE_IS_SPECTATOR) != (str GVAR(lastSpectate))) then {
             if (ACRE_IS_SPECTATOR) then {
                 {
-                    if (_x != GVAR(ts3id)) then {
+                    if (_x != GVAR(voipId)) then {
                         _mutingParams = _mutingParams + format ["%1,0,", _x];
                     };
                 } forEach ACRE_SPECTATORS_LIST;
@@ -105,7 +106,7 @@ DFUNC(mutingPFHLoop) = {
 
     if (ACRE_IS_SPECTATOR && {GVAR(fullListTime)}) then {
         {
-            if (_x != GVAR(ts3id)) then {
+            if (_x != GVAR(voipId)) then {
                 _mutingParams = _mutingParams + format ["%1,0,", _x];
             };
         } forEach ACRE_SPECTATORS_LIST;

addons/sys_core/fnc_pong.sqf

@@ -1,7 +1,8 @@
 #include "script_component.hpp"
 /*
  * Author: ACRE2Team
- * Handler for recieving pong messages from the TeamSpeak plugin. This is called periodically as it provides a simple check to make sure TeamSpeak isis still connected to the game.
+ * Handler for recieving pong messages from the VOIP plugin. This is called periodically as it provides a
+ * simple check to make sure VOIP is still connected to the game.
  *
  * Arguments:
  * None

addons/sys_core/fnc_processDirectSpeaker.sqf

@@ -1,13 +1,13 @@
 #include "script_component.hpp"
 /*
  * Author: ACRE2Team
- * Calculates the information required by TeamSpeak for a direct speech speaker.
+ * Calculates the information required by VOIP for a direct speech speaker.
  *
  * Arguments:
  * 0: Unit <OBJECT>
  *
  * Return Value:
- * Parameters to send to TeamSpeak <ARRAY>
+ * Parameters to send to VOIP <ARRAY>
  *
  * Example:
  * [unit] call acre_sys_core_fnc_processDirectSpeaker
@@ -18,7 +18,7 @@
 private ["_emitterPos", "_emitterDir"];
 params ["_unit"];
 
-private _id = GET_TS3ID(_unit);
+private _id = GET_VOIPID(_unit);
 
 private _bothSpectating = false;
 private _isIntercomAttenuate = false;

addons/sys_core/fnc_processRadioSpeaker.sqf

@@ -1,14 +1,14 @@
 #include "script_component.hpp"
 /*
  * Author: ACRE2Team
- * Calculates the information required by TeamSpeak for a radio speaker.
+ * Calculates the information required by VOIP for a radio speaker.
  *
  * Arguments:
  * 0: Unit to process <OBJECT>
  * 1: List of radio classnames <ARRAY>
  *
  * Return Value:
- * Parameters to send to TeamSpeak  <ARRAY>
+ * Parameters to send to VOIP <ARRAY>
  *
  * Example:
  * [unit,["ACRE_PRC343_ID_1"]] call acre_sys_core_fnc_processRadioSpeaker