Added option to disable RPC

Dragon-Developer · Dragon-Developer · commit 4a4d2e26e7fc · 2023-11-22T14:30:16.000-03:00
diff --git a/GM Netcode.resource_order b/GM Netcode.resource_order
@@ -8,11 +8,14 @@
     {"name":"Socket","order":4,"path":"scripts/Socket/Socket.yy",},
     {"name":"Client","order":2,"path":"scripts/Client/Client.yy",},
     {"name":"obj_client","order":1,"path":"objects/obj_client/obj_client.yy",},
+    {"name":"obj_client_status","order":3,"path":"objects/obj_client_status/obj_client_status.yy",},
     {"name":"RPC","order":1,"path":"scripts/RPC/RPC.yy",},
+    {"name":"obj_controller","order":1,"path":"objects/obj_controller/obj_controller.yy",},
     {"name":"Server","order":3,"path":"scripts/Server/Server.yy",},
     {"name":"WebSocket","order":1,"path":"scripts/WebSocket/WebSocket.yy",},
     {"name":"Manager","order":2,"path":"scripts/Manager/Manager.yy",},
     {"name":"TCPSocket","order":1,"path":"scripts/TCPSocket/TCPSocket.yy",},
     {"name":"GameClient","order":1,"path":"scripts/GameClient/GameClient.yy",},
+    {"name":"obj_server_status","order":2,"path":"objects/obj_server_status/obj_server_status.yy",},
   ],
 }
diff --git a/objects/obj_ball/Create_0.gml b/objects/obj_ball/Create_0.gml
@@ -0,0 +1 @@
+color = c_white;
diff --git a/objects/obj_ball/Draw_0.gml b/objects/obj_ball/Draw_0.gml
@@ -1 +1,3 @@
+draw_set_color(color);
 draw_circle(x, y, 8, false);
+draw_set_color(c_white);
diff --git a/objects/obj_ball/obj_ball.yy b/objects/obj_ball/obj_ball.yy
diff --git a/objects/obj_client/Other_68.gml b/objects/obj_client/Other_68.gml
@@ -18,9 +18,12 @@ else if (_type == network_type_data) {
 	try {
 		var _json = buffer_read(_buffer, buffer_text);
 		var _data = json_parse(_json);
-		client.rpc.handleMessage(_data, _id);
+		client.triggerEvent("message", {
+			data: _data,
+			socket: _id
+		});
 	} catch (_error) {
-		show_debug_message(_error.message);
+		client.triggerEvent("error", _error);
 	}
 }
 
diff --git a/objects/obj_server/Other_68.gml b/objects/obj_server/Other_68.gml
@@ -19,9 +19,12 @@ else if (_type == network_type_data && server.hasClient(_id)) {
 	try {
 		var _json = buffer_read(_buffer, buffer_text);
 		var _data = json_parse(_json);
-		server.rpc.handleMessage(_data, _id);
+		server.triggerEvent("message", {
+			data: _data,
+			socket: _id
+		});
 	} catch (_error) {
-		show_debug_message(_error.message);
+		server.triggerEvent("error", _error);
 	}
 }
 
diff --git a/objects/obj_server_status/Draw_0.gml b/objects/obj_server_status/Draw_0.gml
@@ -1,2 +1,2 @@
-var _count = global.server.clientManager.getCount();
+var _count = global.server.clients.getCount();
 draw_text(16, 16, "Total Client: " + string(_count));
diff --git a/readme.md b/readme.md
@@ -1,5 +1,6 @@
-This framework is designed to simplify the setup of a GameMaker server and client.  
-It uses [JSON-RPC](https://www.jsonrpc.org/specification) to invoke methods from another application.  
+# GM Netcode
+This library is designed to simplify the setup of a GameMaker server and client.  
+It uses [JSON-RPC](https://www.jsonrpc.org/specification) to invoke methods from another application but you can disable it if needed.  
 
 _Note: it is still in its early stages, there is still much to document and improve._
 
@@ -87,11 +88,56 @@ function GameServer(_port) : TCPServer(_port) constructor {
         // Server received notification to create ball, then store the ball position
         ballPosition = _pos;
         // Send "create_ball" notification to all clients
-        clientManager.forEach(function(_client_socket, _client) {
+        clients.forEach(function(_client_socket, _client) {
             rpc.sendNotification("create_ball", ballPosition, _client_socket);
         });
     });
 }
 ```
 Start the server and multiple clients, 
-then click on the screen to check if the balls appear on all clients.
+then click on the screen to check if the balls appear on all clients.
+## Example without RPC
+If you don't want to use RPC, override the "message" event on server/client.
+1. Disabling RPC on GameServer:
+```gml
+function GameServer(_port) : TCPServer(_port) constructor {
+	// Disable RPC by setting the message event
+	setEvent("message", function(_message) {
+		var _data = _message.data;
+		var _socket = _message.socket;
+		// If the message type is "create_ball"
+		if (_data.type == "create_ball") {
+			// Store the data
+			data = _data;
+			// Send this data to all clients
+			clients.forEach(function(_client_socket) {
+				network.sendData(data, _client_socket);	
+			});
+		}
+	});
+}
+```
+2. Disable RPC on GameClient:
+```gml
+function GameClient(_ip, _port) : TCPSocket(_ip, _port) constructor {
+	// Disable RPC by setting the message event
+	setEvent("message", function(_message) {
+		var _data = _message.data;
+		// If the message type is "create_ball"
+		if (_data.type == "create_ball") {
+			// Create the ball instance
+			instance_create_depth(_data.x, _data.y, 0, obj_ball);
+		}
+	});
+	static step = function() {
+		if (mouse_check_button_pressed(mb_left)) {
+			// Send message to create ball
+			network.sendData({
+				type: "create_ball",
+				x: mouse_x,
+				y: mouse_y
+			});
+		}
+	}
+}
+```
diff --git a/scripts/GameClient/GameClient.gml b/scripts/GameClient/GameClient.gml
@@ -1,7 +1,7 @@
 function GameClient(_ip, _port) : TCPSocket(_ip, _port) constructor {
 	self.ping = 0;
-	rpc.registerHandler("create_ball", function(_position) {
-		instance_create_depth(_position.x, _position.y, 0, obj_ball);
+	rpc.registerHandler("create_ball", function(_pos) {
+		var _inst = instance_create_depth(_pos.x, _pos.y, 0, obj_ball);
 	});
 	sendPing = function() {
 		// Wait 1 second to send ping
diff --git a/scripts/GameServer/GameServer.gml b/scripts/GameServer/GameServer.gml
@@ -5,9 +5,9 @@ function GameServer(_port) : TCPServer(_port) constructor {
 	rpc.registerHandler("ping", function(_params, _socket) {
 		return _params;
 	});
-	rpc.registerHandler("create_ball", function(_params, _socket) {
-		ballPosition = _params;
-		clientManager.forEach(function(_client_socket, _client) {
+	rpc.registerHandler("create_ball", function(_position, _socket) {
+		ballPosition = _position;
+		clients.forEach(function(_client_socket) {
 			rpc.sendNotification("create_ball", ballPosition, _client_socket);
 		});
 	});
@@ -21,7 +21,7 @@ function GameServer(_port) : TCPServer(_port) constructor {
 	});
 	rpc.registerHandler("get_name_list", function(_params, _socket) {
 		nameList = [];
-		clientManager.forEach(function(_client_socket, _client) {
+		clients.forEach(function(_client_socket, _client) {
 			array_push(nameList, _client.getName());
 		});
 		return string_join_ext(", ", nameList);	
diff --git a/scripts/Network/Network.gml b/scripts/Network/Network.gml
@@ -3,17 +3,21 @@ function Network() constructor {
 	static buffer = buffer_create(1, buffer_grow, 1);
 	self.raw = false;
 	self.type = network_socket_tcp;
+	self.defaultSocket = -1;
 	static setRAW = function(_raw) {
 		self.raw = _raw;
 	}
 	static setType = function(_type) {
 		self.type = _type;	
 	}
+	static setDefaultSocket = function(_socket) {
+		self.defaultSocket = _socket;	
+	}
 	/// @function					sendData()
 	/// @description				Send data to server.
 	/// @param {Struct} data		Data to be sent.
 	/// @param {Id.Socket} socket	Socket to send to.
-	static sendData = function(_data, _socket) {
+	static sendData = function(_data, _socket = self.defaultSocket) {
 		buffer_seek(buffer, buffer_seek_start, 0);
 		var _json_string = json_stringify(_data);
 		buffer_write(buffer, buffer_text, _json_string);
diff --git a/scripts/RPC/RPC.gml b/scripts/RPC/RPC.gml
@@ -3,7 +3,10 @@ function RPC(_socket) constructor {
 	self.handlers = {};
 	self.socket = _socket;
 	self.timeout = 5;
-	self.network = new Network();
+	self.network = undefined;
+	static setNetwork = function(_network) {
+		self.network = _network;	
+	}
 	static setTimeout = function(_timeout) {
 		self.timeout = _timeout;	
 	}
diff --git a/scripts/Server/Server.gml b/scripts/Server/Server.gml
@@ -4,40 +4,41 @@ function Server(_type, _port, _max_clients) constructor {
 	self.port = _port;
 	self.maxClients = _max_clients;
 	self.clients = [];
-	self.clientManager = new Manager();
+	self.clients = new Manager();
 	self.serverInstance = undefined;
+	self.network = new Network();
+	self.network.setType(_type);
 	self.rpc = new RPC();
-	self.rpc.network.setType(_type);
+	self.rpc.setNetwork(network);
 	self.events = {};
 	static createServerInstance = function() {
 		serverInstance = instance_create_depth(0, 0, 0, obj_server);
 		serverInstance.server = self;
 	}
 	createServer = function() {
-		show_message("SERVER NON RAW");
 		return network_create_server(type, port, maxClients);
 	}
 	static createClient = function() {
 		return {};
 	}
 	static addClient = function(_socket) {
-		clientManager.setElement(_socket, createClient());
+		clients.setElement(_socket, createClient());
 		triggerEvent("connected", _socket);
 	}
 	static hasClient = function(_socket) {
-		return clientManager.hasElement(_socket);	
+		return clients.hasElement(_socket);	
 	}
 	static getClient = function(_socket) {
-		return clientManager.getElement(_socket);	
+		return clients.getElement(_socket);	
 	}
 	static removeClient = function(_socket) {
 		triggerEvent("disconnected", _socket);
-		clientManager.removeElement(_socket);
+		clients.removeElement(_socket);
 	}
 	static destroy = function() {
 		network_destroy(socket);
 		instance_destroy(serverInstance);
-		clientManager.clearAll();
+		clients.clearAll();
 	}
 	static setEvent = function(_event, _method) {
 		events[$ _event] = _method;
@@ -49,14 +50,17 @@ function Server(_type, _port, _max_clients) constructor {
 	}
 	static start = function() {
 		socket = createServer();
+		network.setDefaultSocket(socket);
 		createServerInstance();
+		setEvent("message", function(_msg) {
+			rpc.handleMessage(_msg.data, _msg.socket);
+		});
 	}
 	static step = function() {}
 }
 function ServerRAW(_type, _port, _max_clients) : Server(_type, _port, _max_clients) constructor {
-	self.rpc.network.setRAW(true);
+	self.network.setRAW(true);
 	createServer = function() {
-		show_message("SOCKET RAW");
 		return network_create_server_raw(type, port, maxClients);
 	}
 }
diff --git a/scripts/Socket/Socket.gml b/scripts/Socket/Socket.gml
@@ -6,28 +6,33 @@ function Socket(_type, _ip, _port) constructor {
 	self.port = _port;
 	self.clientInstance = undefined;
 	self.rpc = undefined;
+	self.network = new Network();
 	self.connect = function() {
 		network_connect_async(socket, ip, port);	
-		show_message("SOCKET NON RAW");
 	}
 	static setType = function(_type) {
 		type = _type;	
 	}
 	static setEvent = function(_event, _method) {
 		events[$ _event] = _method;
 	}
-	static triggerEvent = function(_event) {
+	static triggerEvent = function(_event, _params) {
 		if (struct_exists(events, _event)) {
-			events[$ _event]();	
+			events[$ _event](_params);	
 		}
 	}
 	static start = function() {
 		socket = network_create_socket(type);
+		network.setDefaultSocket(socket);
 		rpc = new RPC(socket);
-		rpc.network.setType(type);
+		rpc.setNetwork(network);
+		network.setType(type);
 		connect();
 		clientInstance = instance_create_depth(0, 0, 0, obj_client);
 		clientInstance.client = self;
+		setEvent("message", function(_msg) {
+			rpc.handleMessage(_msg.data, _msg.socket);
+		});
 	}
 	static destroy = function() {
 		network_destroy(socket);
@@ -37,8 +42,7 @@ function Socket(_type, _ip, _port) constructor {
 }
 function SocketRAW(_type, _ip, _port) : Socket(_type, _ip, _port) constructor {
 	self.connect = function() {
-		self.rpc.network.setRAW(true);
+		self.network.setRAW(true);
 		network_connect_raw_async(socket, ip, port);	
-		show_message("SOCKET RAW");
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
	`1`	`+draw_set_color(color);`
`1`	`2`	`draw_circle(x, y, 8, false);`
	`3`	`+draw_set_color(c_white);`
Original file line number	Diff line number	Diff line change
`@@ -18,9 +18,12 @@ else if (_type == network_type_data) {`
`18`	`18`	`try {`
`19`	`19`	`var _json = buffer_read(_buffer, buffer_text);`
`20`	`20`	`var _data = json_parse(_json);`
`21`		`- client.rpc.handleMessage(_data, _id);`
	`21`	`+ client.triggerEvent("message", {`
	`22`	`+ data: _data,`
	`23`	`+ socket: _id`
	`24`	`+ });`
`22`	`25`	`} catch (_error) {`
`23`		`- show_debug_message(_error.message);`
	`26`	`+ client.triggerEvent("error", _error);`
`24`	`27`	`}`
`25`	`28`	`}`
`26`	`29`
Original file line number	Diff line number	Diff line change
`@@ -19,9 +19,12 @@ else if (_type == network_type_data && server.hasClient(_id)) {`
`19`	`19`	`try {`
`20`	`20`	`var _json = buffer_read(_buffer, buffer_text);`
`21`	`21`	`var _data = json_parse(_json);`
`22`		`- server.rpc.handleMessage(_data, _id);`
	`22`	`+ server.triggerEvent("message", {`
	`23`	`+ data: _data,`
	`24`	`+ socket: _id`
	`25`	`+ });`
`23`	`26`	`} catch (_error) {`
`24`		`- show_debug_message(_error.message);`
	`27`	`+ server.triggerEvent("error", _error);`
`25`	`28`	`}`
`26`	`29`	`}`
`27`	`30`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-var _count = global.server.clientManager.getCount();`
	`1`	`+var _count = global.server.clients.getCount();`
`2`	`2`	`draw_text(16, 16, "Total Client: " + string(_count));`