Merge pull request #481 from CBATeam/cleanup-network2

Cleanup network component
CBATeam · Aug 22, 2016 · 8793cff · 8793cff
2 parents 4874876 + 92f3185
commit 8793cff
Show file tree

Hide file tree

Showing 9 changed files with 58 additions and 153 deletions.
diff --git a/addons/network/CfgEventHandlers.hpp b/addons/network/CfgEventHandlers.hpp
diff --git a/addons/network/CfgFunctions.hpp b/addons/network/CfgFunctions.hpp
@@ -1,44 +1,16 @@
-// -----------------------------------------------------------------------------
-// Automatically generated by 'functions_config.rb'
-// DO NOT MANUALLY EDIT THIS FILE!
-// -----------------------------------------------------------------------------
 
-class CfgFunctions
-{
-    class CBA
-    {
-        class Network
-        {
-            // CBA_fnc_globalExecute
-            class globalExecute
-            {
-                description = "Executes code on given destinations";
-                file = "\x\cba\addons\network\fnc_globalExecute.sqf";
-            };
-            // CBA_fnc_globalSay
-            class globalSay
-            {
-                description = "Says sound on all client computer";
-                file = "\x\cba\addons\network\fnc_globalSay.sqf";
-            };
-            // CBA_fnc_globalSay3d
-            class globalSay3d
-            {
-                description = "Says sound on all client computer in 3d";
-                file = "\x\cba\addons\network\fnc_globalSay3d.sqf";
-            };
-            // CBA_fnc_publicVariable
-            class publicVariable
-            {
-                description = "CBA_fnc_publicVariable does only broadcast the new value if it doesn't exist in missionNamespace or the new value is different to the one in missionNamespace. Checks also for different types. Nil as value gets always broadcasted.";
-                file = "\x\cba\addons\network\fnc_publicVariable.sqf";
-            };
-            // CBA_fnc_setVarNet
-            class setVarNet
-            {
-                description = "Same as setVariable [""name"",var, true] but only broadcasts when the value of var is different to the one which is already saved in the variable space. Checks also for different types. Nil as value gets always broadcasted.";
-                file = "\x\cba\addons\network\fnc_setVarNet.sqf";
-            };
+#define F_FILEPATH(func) class func {\
+    file = QUOTE(PATHTOF(DOUBLES(fnc,func).sqf));\
+}
+
+class CfgFunctions {
+    class CBA {
+        class Network {
+            F_FILEPATH(globalExecute);
+            F_FILEPATH(globalSay);
+            F_FILEPATH(globalSay3d);
+            F_FILEPATH(publicVariable);
+            F_FILEPATH(setVarNet);
         };
     };
 };
diff --git a/addons/network/CfgSettings.hpp b/addons/network/CfgSettings.hpp
@@ -0,0 +1,8 @@
+
+class CfgSettings {
+    class CBA {
+        class COMPONENT {
+            disableGlobalExecute = 0;
+        };
+    };
+};
diff --git a/addons/network/XEH_preInit.sqf b/addons/network/XEH_preInit.sqf
diff --git a/addons/network/config.cpp b/addons/network/config.cpp
@@ -6,20 +6,14 @@ class CfgPatches {
         name = CSTRING(component);
         url = "$STR_CBA_URL";
         units[] = {};
+        weapons[] = {};
         requiredVersion = REQUIRED_VERSION;
-        requiredAddons[] = { "CBA_common", "CBA_events" };
+        requiredAddons[] = {"CBA_common", "CBA_events"};
         version = VERSION;
         authors[] = {"Sickboy"};
     };
 };
 
-class CfgSettings {
-    class CBA {
-        class COMPONENT {
-            disableGlobalExecute = 0;
-        };
-    };
-};
-
-#include "CfgEventHandlers.hpp"
 #include "CfgFunctions.hpp"
+
+#include "CfgSettings.hpp"
diff --git a/addons/network/fnc_globalExecute.sqf b/addons/network/fnc_globalExecute.sqf
@@ -1,17 +1,18 @@
-/*
+/* ----------------------------------------------------------------------------
 Function: CBA_fnc_globalExecute
 
-DEPRECATED. Use <remoteExec at https://community.bistudio.com/wiki/remoteExec> instead.
-
-Description
+Description:
     Executes code on given destinations.
 
+    DEPRECATED. Use <remoteExec at https://community.bistudio.com/wiki/remoteExec> instead.
+
 Parameters:
-    _channel    - All: -2, ClientsOnly: -1, ServerOnly: 0 [Integer]
-    _code       - Code to execute [Code]
-    _parameters - OPTIONAL. Parameter to pass to the code in the _this variables [Any]
+    _channel    - All: -2, ClientsOnly: -1, ServerOnly: 0 <NUMBER>
+    _code       - Code to execute <CODE>
+    _parameters - Parameter to pass in the _this variable. (optional) <ANY>
 
 Returns:
+    Magazine of the units binocular <STRING>
 
 Example:
     (begin example)
@@ -20,17 +21,9 @@ Example:
 
 Author:
     Sickboy, commy2
-*/
+---------------------------------------------------------------------------- */
 #include "script_component.hpp"
 
-#define CBA_SEND_TO_ALL -2
-#define CBA_SEND_TO_CLIENTS_ONLY -1
-#define CBA_SEND_TO_SERVER_ONLY 0
-
-#define BI_SEND_TO_ALL 0
-#define BI_SEND_TO_CLIENTS_ONLY -2
-#define BI_SEND_TO_SERVER_ONLY 2
-
 params [["_channel", CBA_SEND_TO_ALL, [CBA_SEND_TO_ALL]], ["_code", {}, [{}]], ["_parameters", []]];
 
 // translate CBA channel to BI channel

diff --git a/addons/network/fnc_globalSay.sqf b/addons/network/fnc_globalSay.sqf
@@ -1,16 +1,17 @@
-/*
+/* ----------------------------------------------------------------------------
 Function: CBA_fnc_globalSay
 
-DEPRECATED. Use <remoteExec at https://community.bistudio.com/wiki/remoteExec> ["say"] instead.
-
 Description:
-    Says sound on all client computer.
+    Says sound on all clients.
+
+    DEPRECATED. Use <remoteExec at https://community.bistudio.com/wiki/remoteExec> ["say"] instead.
 
 Parameters:
-    [_objects] - Array of Objects that perform Say [Object]
-    _say - [sound, maxTitlesDistance,speed] or "sound" [Array or String]
+    _objects - Object or array of objects that perform Say <OBJECT, ARRAY>
+    _params  - [sound, maxTitlesDistance,speed] or "sound" <ARRAY, STRING>
 
 Returns:
+    Nothing
 
 Example:
     (begin example)
@@ -19,7 +20,7 @@ Example:
 
 Author:
     Sickboy, commy2
-*/
+---------------------------------------------------------------------------- */
 #include "script_component.hpp"
 
 params [["_objects", [], [[], objNull]], ["_params", "", ["", []]]];

diff --git a/addons/network/fnc_globalSay3d.sqf b/addons/network/fnc_globalSay3d.sqf
@@ -1,17 +1,18 @@
-/*
+/* ----------------------------------------------------------------------------
 Function: CBA_fnc_globalSay3d
 
-DEPRECATED. Use <remoteExec at https://community.bistudio.com/wiki/remoteExec> ["say3D"] instead.
-
 Description:
-    Says sound on all client computer in 3D.
+    Says sound on all clients in 3D.
+
+    DEPRECATED. Use <remoteExec at https://community.bistudio.com/wiki/remoteExec> ["say3D"] instead.
 
 Parameters:
-    _object - Object that performs Say [Object] can also be _array - [object, targetObject]
-    _speechName - Speechname
-    _range - (Optional parameter) maximum distance from camera to execute command [Number]
+    _objects - Object or array of objects that perform Say <OBJECT, ARRAY>
+    _params  - [sound, maxTitlesDistance,speed] or "sound" <STRING, ARRAY>
+    _range   - Maximum distance from camera to execute command (optional) <NUMBER>
 
 Returns:
+    Nothing
 
 Example:
     (begin example)
@@ -20,7 +21,7 @@ Example:
 
 Author:
     Sickboy, commy2
-*/
+---------------------------------------------------------------------------- */
 #include "script_component.hpp"
 
 params [["_objects", [], [[], objNull]], ["_params", "", ["", []]], ["_distance", nil, [0]]];

diff --git a/addons/network/script_component.hpp b/addons/network/script_component.hpp
@@ -11,3 +11,11 @@
 #endif
 
 #include "\x\cba\addons\main\script_macros.hpp"
+
+#define CBA_SEND_TO_ALL -2
+#define CBA_SEND_TO_CLIENTS_ONLY -1
+#define CBA_SEND_TO_SERVER_ONLY 0
+
+#define BI_SEND_TO_ALL 0
+#define BI_SEND_TO_CLIENTS_ONLY -2
+#define BI_SEND_TO_SERVER_ONLY 2