Expose node network IDs to GDScript

Author: elementbound

modules/multiplayer/scene_cache_interface.cpp

@@ -30,6 +30,9 @@
 
 #include "scene_cache_interface.h"
 
+#include "core/error/error_macros.h"
+#include "core/object/object_id.h"
+#include "core/variant/variant.h"
 #include "scene_multiplayer.h"
 
 #include "core/io/marshalls.h"
@@ -204,6 +207,29 @@ Error SceneCacheInterface::_send_confirm_path(Node *p_node, NodeCache &p_cache,
 	return err;
 }
 
+ObjectID SceneCacheInterface::resolve_object_id(int p_id) const {
+  if (assigned_ids.has(p_id)) {
+    return assigned_ids.get(p_id);
+  }
+
+  return ObjectID{ (uint64_t)0 };
+}
+
+int SceneCacheInterface::get_network_id(const Object* p_object, int p_peer_id) const {
+  ERR_FAIL_NULL_V(p_object, 0);
+
+  ObjectID oid = p_object->get_instance_id();
+  const NodeCache* nc = nodes_cache.getptr(oid);
+  ERR_FAIL_NULL_V_MSG(nc, 0, vformat("No node cache found for ObjectID %d!", (uint64_t)oid));
+
+  // if (!nc->confirmed_peers.has(p_peer_id) || !nc->confirmed_peers.get(p_peer_id) || !nc->recv_ids.has(p_peer_id)) {
+  //   // Peer hasn't confirmed ID
+  //   return -1;
+  // }
+
+  return nc->cache_id;
+}
+
 bool SceneCacheInterface::is_cache_confirmed(Node *p_node, int p_peer) {
 	ERR_FAIL_NULL_V(p_node, false);
 	const ObjectID oid = p_node->get_instance_id();

modules/multiplayer/scene_cache_interface.h

@@ -80,6 +80,9 @@ class SceneCacheInterface : public RefCounted {
 	void process_simplify_path(int p_from, const uint8_t *p_packet, int p_packet_len);
 	void process_confirm_path(int p_from, const uint8_t *p_packet, int p_packet_len);
 
+  ObjectID resolve_object_id(int p_id) const;
+  int get_network_id(const Object* p_object, int p_peer_id) const;
+
 	// Returns true if all peers have cached path.
 	bool send_object_cache(Object *p_obj, int p_target, int &p_id);
 	int make_object_cache(Object *p_obj);

modules/multiplayer/scene_multiplayer.cpp

@@ -32,6 +32,8 @@
 
 #include "core/debugger/engine_debugger.h"
 #include "core/io/marshalls.h"
+#include "core/object/class_db.h"
+#include "core/object/object.h"
 
 #ifdef DEBUG_ENABLED
 #include "core/os/os.h"
@@ -576,6 +578,21 @@ String SceneMultiplayer::get_rpc_md5(const Object *p_obj) {
 	return rpc->get_rpc_md5(p_obj);
 }
 
+int SceneMultiplayer::get_network_id(Object* p_object, int p_peer_id) const {
+	Node *node = Object::cast_to<Node>(p_object);
+	ERR_FAIL_COND_V_MSG(!node || !node->is_inside_tree(), 0, "The object must be a valid Node inside the SceneTree");
+
+  return cache->get_network_id(node, p_peer_id);
+}
+
+Object* SceneMultiplayer::instance_from_network_id(int p_id) const {
+  ObjectID oid = cache->resolve_object_id(p_id);
+  if(oid.is_null()) {
+    return nullptr;
+  }
+  return ObjectDB::get_instance(oid);
+}
+
 Error SceneMultiplayer::rpcp(Object *p_obj, int p_peer_id, const StringName &p_method, const Variant **p_arg, int p_argcount) {
 	return rpc->rpcp(p_obj, p_peer_id, p_method, p_arg, p_argcount);
 }
@@ -652,6 +669,9 @@ void SceneMultiplayer::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("set_auth_timeout", "timeout"), &SceneMultiplayer::set_auth_timeout);
 	ClassDB::bind_method(D_METHOD("get_auth_timeout"), &SceneMultiplayer::get_auth_timeout);
 
+  ClassDB::bind_method(D_METHOD("get_network_id", "object", "peer_id"), &SceneMultiplayer::get_network_id);
+  ClassDB::bind_method(D_METHOD("instance_from_network_id", "id"), &SceneMultiplayer::instance_from_network_id);
+
 	ClassDB::bind_method(D_METHOD("set_refuse_new_connections", "refuse"), &SceneMultiplayer::set_refuse_new_connections);
 	ClassDB::bind_method(D_METHOD("is_refusing_new_connections"), &SceneMultiplayer::is_refusing_new_connections);
 	ClassDB::bind_method(D_METHOD("set_allow_object_decoding", "enable"), &SceneMultiplayer::set_allow_object_decoding);

modules/multiplayer/scene_multiplayer.h

@@ -30,6 +30,7 @@
 
 #pragma once
 
+#include "core/object/object.h"
 #include "scene_cache_interface.h"
 #include "scene_replication_interface.h"
 #include "scene_rpc_interface.h"
@@ -184,6 +185,9 @@ class SceneMultiplayer : public MultiplayerAPI {
 
 	const HashSet<int> get_connected_peers() const { return connected_peers; }
 
+  int get_network_id(Object* p_object, int p_peer_id) const;
+  Object* instance_from_network_id(int p_id) const;
+
 	void set_remote_sender_override(int p_id) { remote_sender_override = p_id; }
 	void set_refuse_new_connections(bool p_refuse);
 	bool is_refusing_new_connections() const;

modules/multiplayer/scene_rpc_interface.cpp

@@ -30,6 +30,8 @@
 
 #include "scene_rpc_interface.h"
 
+#include "core/string/print_string.h"
+#include "core/variant/variant.h"
 #include "scene_multiplayer.h"
 
 #include "core/debugger/engine_debugger.h"
@@ -205,6 +207,8 @@ void SceneRPCInterface::process_rpc(int p_from, const uint8_t *p_packet, int p_p
 	}
 
 	Node *node = _process_get_node(p_from, p_packet, node_target, p_packet_len);
+  print_line(vformat("[core] Received RPC call on ID#%d, resolving to node %s", node_target, node)); // TODO: Remove
+
 	ERR_FAIL_NULL_MSG(node, "Invalid packet received. Requested node was not found.");
 
 	uint16_t name_id = 0;
@@ -378,6 +382,8 @@ void SceneRPCInterface::_send_rpc(Node *p_node, int p_to, uint16_t p_rpc_id, con
 		ofs += 4;
 	}
 
+  print_line(vformat("[core] Sending RPC to node %s with ID#%d", p_node, psc_id)); // TODO: Remove
+
 	// Encode method ID
 	if (p_rpc_id <= UINT8_MAX) {
 		// The ID fits in 1 byte