| 
									
										
										
										
											2021-10-08 14:13:06 +02:00
										 |  |  | /**************************************************************************/ | 
					
						
							|  |  |  | /*  multiplayer_synchronizer.h                                            */ | 
					
						
							|  |  |  | /**************************************************************************/ | 
					
						
							|  |  |  | /*                         This file is part of:                          */ | 
					
						
							|  |  |  | /*                             GODOT ENGINE                               */ | 
					
						
							|  |  |  | /*                        https://godotengine.org                         */ | 
					
						
							|  |  |  | /**************************************************************************/ | 
					
						
							|  |  |  | /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */ | 
					
						
							|  |  |  | /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */ | 
					
						
							|  |  |  | /*                                                                        */ | 
					
						
							|  |  |  | /* Permission is hereby granted, free of charge, to any person obtaining  */ | 
					
						
							|  |  |  | /* a copy of this software and associated documentation files (the        */ | 
					
						
							|  |  |  | /* "Software"), to deal in the Software without restriction, including    */ | 
					
						
							|  |  |  | /* without limitation the rights to use, copy, modify, merge, publish,    */ | 
					
						
							|  |  |  | /* distribute, sublicense, and/or sell copies of the Software, and to     */ | 
					
						
							|  |  |  | /* permit persons to whom the Software is furnished to do so, subject to  */ | 
					
						
							|  |  |  | /* the following conditions:                                              */ | 
					
						
							|  |  |  | /*                                                                        */ | 
					
						
							|  |  |  | /* The above copyright notice and this permission notice shall be         */ | 
					
						
							|  |  |  | /* included in all copies or substantial portions of the Software.        */ | 
					
						
							|  |  |  | /*                                                                        */ | 
					
						
							|  |  |  | /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,        */ | 
					
						
							|  |  |  | /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF     */ | 
					
						
							|  |  |  | /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */ | 
					
						
							|  |  |  | /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY   */ | 
					
						
							|  |  |  | /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,   */ | 
					
						
							|  |  |  | /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE      */ | 
					
						
							|  |  |  | /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                 */ | 
					
						
							|  |  |  | /**************************************************************************/ | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | #ifndef MULTIPLAYER_SYNCHRONIZER_H
 | 
					
						
							|  |  |  | #define MULTIPLAYER_SYNCHRONIZER_H
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-12 23:12:42 +02:00
										 |  |  | #include "scene_replication_config.h"
 | 
					
						
							| 
									
										
										
										
											2021-10-08 14:13:06 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2023-06-13 16:56:21 +02:00
										 |  |  | #include "scene/main/node.h"
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-10-08 14:13:06 +02:00
										 |  |  | class MultiplayerSynchronizer : public Node { | 
					
						
							|  |  |  | 	GDCLASS(MultiplayerSynchronizer, Node); | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-09 20:45:30 +02:00
										 |  |  | public: | 
					
						
							|  |  |  | 	enum VisibilityUpdateMode { | 
					
						
							|  |  |  | 		VISIBILITY_PROCESS_IDLE, | 
					
						
							|  |  |  | 		VISIBILITY_PROCESS_PHYSICS, | 
					
						
							|  |  |  | 		VISIBILITY_PROCESS_NONE, | 
					
						
							|  |  |  | 	}; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-10-08 14:13:06 +02:00
										 |  |  | private: | 
					
						
							| 
									
										
										
										
											2023-03-28 09:30:58 +02:00
										 |  |  | 	struct Watcher { | 
					
						
							|  |  |  | 		NodePath prop; | 
					
						
							|  |  |  | 		uint64_t last_change_usec = 0; | 
					
						
							|  |  |  | 		Variant value; | 
					
						
							|  |  |  | 	}; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-10-08 14:13:06 +02:00
										 |  |  | 	Ref<SceneReplicationConfig> replication_config; | 
					
						
							| 
									
										
										
										
											2022-05-23 02:24:14 +02:00
										 |  |  | 	NodePath root_path = NodePath(".."); // Start with parent, like with AnimationPlayer.
 | 
					
						
							| 
									
										
										
										
											2023-03-28 09:30:58 +02:00
										 |  |  | 	uint64_t sync_interval_usec = 0; | 
					
						
							|  |  |  | 	uint64_t delta_interval_usec = 0; | 
					
						
							| 
									
										
										
										
											2022-07-09 20:45:30 +02:00
										 |  |  | 	VisibilityUpdateMode visibility_update_mode = VISIBILITY_PROCESS_IDLE; | 
					
						
							|  |  |  | 	HashSet<Callable> visibility_filters; | 
					
						
							|  |  |  | 	HashSet<int> peer_visibility; | 
					
						
							| 
									
										
										
										
											2023-03-28 09:30:58 +02:00
										 |  |  | 	Vector<Watcher> watchers; | 
					
						
							|  |  |  | 	uint64_t last_watch_usec = 0; | 
					
						
							| 
									
										
										
										
											2021-10-08 14:13:06 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-09-30 22:35:56 +02:00
										 |  |  | 	ObjectID root_node_cache; | 
					
						
							| 
									
										
										
										
											2023-03-28 09:30:58 +02:00
										 |  |  | 	uint64_t last_sync_usec = 0; | 
					
						
							| 
									
										
										
										
											2022-09-30 22:35:56 +02:00
										 |  |  | 	uint16_t last_inbound_sync = 0; | 
					
						
							|  |  |  | 	uint32_t net_id = 0; | 
					
						
							| 
									
										
										
										
											2023-10-11 18:55:32 +02:00
										 |  |  | 	bool sync_started = false; | 
					
						
							| 
									
										
										
										
											2022-09-30 22:35:56 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-10-08 14:13:06 +02:00
										 |  |  | 	static Object *_get_prop_target(Object *p_obj, const NodePath &p_prop); | 
					
						
							|  |  |  | 	void _start(); | 
					
						
							|  |  |  | 	void _stop(); | 
					
						
							| 
									
										
										
										
											2022-07-09 20:45:30 +02:00
										 |  |  | 	void _update_process(); | 
					
						
							| 
									
										
										
										
											2023-03-28 09:30:58 +02:00
										 |  |  | 	Error _watch_changes(uint64_t p_usec); | 
					
						
							| 
									
										
										
										
											2021-10-08 14:13:06 +02:00
										 |  |  | 
 | 
					
						
							|  |  |  | protected: | 
					
						
							|  |  |  | 	static void _bind_methods(); | 
					
						
							|  |  |  | 	void _notification(int p_what); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | public: | 
					
						
							|  |  |  | 	static Error get_state(const List<NodePath> &p_properties, Object *p_obj, Vector<Variant> &r_variant, Vector<const Variant *> &r_variant_ptrs); | 
					
						
							|  |  |  | 	static Error set_state(const List<NodePath> &p_properties, Object *p_obj, const Vector<Variant> &p_state); | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-09-30 22:35:56 +02:00
										 |  |  | 	void reset(); | 
					
						
							|  |  |  | 	Node *get_root_node(); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 	uint32_t get_net_id() const; | 
					
						
							|  |  |  | 	void set_net_id(uint32_t p_net_id); | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2023-03-28 09:30:58 +02:00
										 |  |  | 	bool update_outbound_sync_time(uint64_t p_usec); | 
					
						
							| 
									
										
										
										
											2022-09-30 22:35:56 +02:00
										 |  |  | 	bool update_inbound_sync_time(uint16_t p_network_time); | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-09-19 16:43:15 +01:00
										 |  |  | 	PackedStringArray get_configuration_warnings() const override; | 
					
						
							| 
									
										
										
										
											2022-09-16 22:42:05 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-10-08 14:13:06 +02:00
										 |  |  | 	void set_replication_interval(double p_interval); | 
					
						
							|  |  |  | 	double get_replication_interval() const; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2023-03-28 09:30:58 +02:00
										 |  |  | 	void set_delta_interval(double p_interval); | 
					
						
							|  |  |  | 	double get_delta_interval() const; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-10-08 14:13:06 +02:00
										 |  |  | 	void set_replication_config(Ref<SceneReplicationConfig> p_config); | 
					
						
							|  |  |  | 	Ref<SceneReplicationConfig> get_replication_config(); | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 	void set_root_path(const NodePath &p_path); | 
					
						
							|  |  |  | 	NodePath get_root_path() const; | 
					
						
							|  |  |  | 	virtual void set_multiplayer_authority(int p_peer_id, bool p_recursive = true) override; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-09 20:45:30 +02:00
										 |  |  | 	bool is_visibility_public() const; | 
					
						
							|  |  |  | 	void set_visibility_public(bool p_public); | 
					
						
							|  |  |  | 	bool is_visible_to(int p_peer); | 
					
						
							|  |  |  | 	void set_visibility_for(int p_peer, bool p_visible); | 
					
						
							|  |  |  | 	bool get_visibility_for(int p_peer) const; | 
					
						
							|  |  |  | 	void update_visibility(int p_for_peer); | 
					
						
							|  |  |  | 	void set_visibility_update_mode(VisibilityUpdateMode p_mode); | 
					
						
							|  |  |  | 	void add_visibility_filter(Callable p_callback); | 
					
						
							|  |  |  | 	void remove_visibility_filter(Callable p_callback); | 
					
						
							|  |  |  | 	VisibilityUpdateMode get_visibility_update_mode() const; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2023-03-28 09:30:58 +02:00
										 |  |  | 	List<Variant> get_delta_state(uint64_t p_cur_usec, uint64_t p_last_usec, uint64_t &r_indexes); | 
					
						
							|  |  |  | 	List<NodePath> get_delta_properties(uint64_t p_indexes); | 
					
						
							| 
									
										
										
										
											2023-10-02 10:56:21 +02:00
										 |  |  | 	SceneReplicationConfig *get_replication_config_ptr() const; | 
					
						
							| 
									
										
										
										
											2023-03-28 09:30:58 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-09 20:45:30 +02:00
										 |  |  | 	MultiplayerSynchronizer(); | 
					
						
							| 
									
										
										
										
											2021-10-08 14:13:06 +02:00
										 |  |  | }; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-09 20:45:30 +02:00
										 |  |  | VARIANT_ENUM_CAST(MultiplayerSynchronizer::VisibilityUpdateMode); | 
					
						
							| 
									
										
										
										
											2022-07-23 23:41:51 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-10-08 14:13:06 +02:00
										 |  |  | #endif // MULTIPLAYER_SYNCHRONIZER_H
 |