mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-27 11:24:59 +08:00
Code Issues Packages Projects Releases Wiki Activity
1b642d283c
godot/scene/main/multiplayer_peer.h

152 lines
5.6 KiB
C++
Raw Normal View History

One Copyright Update to rule them all As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
2023-01-05 20:25:55 +08:00
/**************************************************************************/
/* multiplayer_peer.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. */
/**************************************************************************/
Add missing copyright headers and fix formatting Using `misc/scripts/fix_headers.py` on all Godot files. Some missing header guards were added, and the header inclusion order was fixed in the Bullet module.
2018-01-05 07:50:27 +08:00
Code quality: Fix header guards consistency Adds `header_guards.sh` bash script, used in CI to validate future changes. Can be run locally to fix invalid header guards.
2022-07-24 05:41:51 +08:00
#ifndef MULTIPLAYER_PEER_H
#define MULTIPLAYER_PEER_H
WIP visual scripting, not working yet but you can check out stuff
2016-08-03 06:11:05 +08:00
Make core/ includes absolute, remove subfolders from include path This allows more consistency in the manner we include core headers, where previously there would be a mix of absolute, relative and include path-dependent includes.
2018-09-12 00:13:45 +08:00
#include "core/io/packet_peer.h"
WIP visual scripting, not working yet but you can check out stuff
2016-08-03 06:11:05 +08:00
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 11:09:07 +08:00
#include "core/extension/ext_wrappers.gen.inc"
[Net] Bind Multiplayer to GDExtension.
2021-09-07 00:09:29 +08:00
#include "core/object/gdvirtual.gen.inc"
#include "core/object/script_language.h"
#include "core/variant/native_ptr.h"
[Net] Rename NetworkedMultiplayerPeer to MultiplayerPeer.
2021-07-12 22:11:05 +08:00
class MultiplayerPeer : public PacketPeer {
GDCLASS(MultiplayerPeer, PacketPeer);
WIP visual scripting, not working yet but you can check out stuff
2016-08-03 06:11:05 +08:00
[Net] Modularize multiplayer, expose MultiplayerAPI to extensions. - RPC configurations are now dictionaries. - Script.get_rpc_methods renamed to Script.get_rpc_config. - Node.rpc[_id] and Callable.rpc now return an Error. - Refactor MultiplayerAPI to allow extension. - New MultiplayerAPI.rpc method with Array argument (for scripts). - Move the default MultiplayerAPI implementation to a module.
2022-07-13 05:12:42 +08:00
public:
enum TransferMode {
TRANSFER_MODE_UNRELIABLE,
TRANSFER_MODE_UNRELIABLE_ORDERED,
TRANSFER_MODE_RELIABLE
};
WIP visual scripting, not working yet but you can check out stuff
2016-08-03 06:11:05 +08:00
protected:
static void _bind_methods();
[Net] MultiplayerPeer cleanup, defaults.
2021-09-08 05:04:52 +08:00
private:
int transfer_channel = 0;
[Net] Modularize multiplayer, expose MultiplayerAPI to extensions. - RPC configurations are now dictionaries. - Script.get_rpc_methods renamed to Script.get_rpc_config. - Node.rpc[_id] and Callable.rpc now return an Error. - Refactor MultiplayerAPI to allow extension. - New MultiplayerAPI.rpc method with Array argument (for scripts). - Move the default MultiplayerAPI implementation to a module.
2022-07-13 05:12:42 +08:00
TransferMode transfer_mode = TRANSFER_MODE_RELIABLE;
[Net] MultiplayerPeer cleanup, defaults.
2021-09-08 05:04:52 +08:00
bool refuse_connections = false;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 23:44:50 +08:00
public:
Brand new networked multiplayer
2016-08-20 03:48:08 +08:00
enum {
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 23:44:50 +08:00
TARGET_PEER_BROADCAST = 0,
TARGET_PEER_SERVER = 1
Brand new networked multiplayer
2016-08-20 03:48:08 +08:00
};
WIP visual scripting, not working yet but you can check out stuff
2016-08-03 06:11:05 +08:00
Missing some bits, and added connection status.
2016-08-15 01:06:51 +08:00
enum ConnectionStatus {
CONNECTION_DISCONNECTED,
CONNECTION_CONNECTING,
CONNECTION_CONNECTED,
};
[Net] MultiplayerPeer cleanup, defaults.
2021-09-08 05:04:52 +08:00
virtual void set_transfer_channel(int p_channel);
virtual int get_transfer_channel() const;
[Net] Modularize multiplayer, expose MultiplayerAPI to extensions. - RPC configurations are now dictionaries. - Script.get_rpc_methods renamed to Script.get_rpc_config. - Node.rpc[_id] and Callable.rpc now return an Error. - Refactor MultiplayerAPI to allow extension. - New MultiplayerAPI.rpc method with Array argument (for scripts). - Move the default MultiplayerAPI implementation to a module.
2022-07-13 05:12:42 +08:00
virtual void set_transfer_mode(TransferMode p_mode);
virtual TransferMode get_transfer_mode() const;
[Net] MultiplayerPeer cleanup, defaults.
2021-09-08 05:04:52 +08:00
virtual void set_refuse_new_connections(bool p_enable);
virtual bool is_refusing_new_connections() const;
[MP] Let MultiplayerAPI handle packet relaying and peer signaling. MultiplayerPeer changes: - Adds is_server_relay_supported virtual method Informs the upper MultiplayerAPI layer if it can signal peers connected to the server to other clients, and perform packet relaying among them. - Adds get_packet_channel and get_packet_mode virtual methods Allows the MultiplayerAPI to retrieve the channel and transfer modes to use when relaying the last received packet. SceneMultiplayerPeer changes: - Implement peer signaling and packet relaying when the MultiplayerPeer advertise they are supported. ENet, WebRTC, WebSocket changes: - Removed custom code for relaying from WebSocket and ENet, and let it be handled by the upper layer. - Update WebRTC to split create_client, create_server, and create_mesh, with the latter behaving like the old initialize with "server_compatibility = false", and the first two supporting the upper layer relaying protocol.
2022-10-09 02:50:19 +08:00
virtual bool is_server_relay_supported() const;
[Net] MultiplayerPeer cleanup, defaults.
2021-09-08 05:04:52 +08:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 23:44:50 +08:00
virtual void set_target_peer(int p_peer_id) = 0;
-Added an ENet implementation for NetworkedMultiplayerPeer for "a bit higher level" networking.
2016-08-15 00:29:25 +08:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 23:44:50 +08:00
virtual int get_packet_peer() const = 0;
[MP] Let MultiplayerAPI handle packet relaying and peer signaling. MultiplayerPeer changes: - Adds is_server_relay_supported virtual method Informs the upper MultiplayerAPI layer if it can signal peers connected to the server to other clients, and perform packet relaying among them. - Adds get_packet_channel and get_packet_mode virtual methods Allows the MultiplayerAPI to retrieve the channel and transfer modes to use when relaying the last received packet. SceneMultiplayerPeer changes: - Implement peer signaling and packet relaying when the MultiplayerPeer advertise they are supported. ENet, WebRTC, WebSocket changes: - Removed custom code for relaying from WebSocket and ENet, and let it be handled by the upper layer. - Update WebRTC to split create_client, create_server, and create_mesh, with the latter behaving like the old initialize with "server_compatibility = false", and the first two supporting the upper layer relaying protocol.
2022-10-09 02:50:19 +08:00
virtual TransferMode get_packet_mode() const = 0;
virtual int get_packet_channel() const = 0;
Added high level networked multiplayer to Godot. It's complete, but absolutely and completely untested, undocumented and NSFW. Have fun :-)
2016-08-15 05:49:50 +08:00
[MP] Add MultiplayerPeer disconnect_peer, close. Update ENet, WebRTC, and WebSocket to support peer disconnection and unify the close function.
2022-10-22 23:49:40 +08:00
virtual void disconnect_peer(int p_peer, bool p_force = false) = 0;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 23:44:50 +08:00
virtual bool is_server() const = 0;
WIP visual scripting, not working yet but you can check out stuff
2016-08-03 06:11:05 +08:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 23:44:50 +08:00
virtual void poll() = 0;
[MP] Add MultiplayerPeer disconnect_peer, close. Update ENet, WebRTC, and WebSocket to support peer disconnection and unify the close function.
2022-10-22 23:49:40 +08:00
virtual void close() = 0;
Brand new networked multiplayer
2016-08-20 03:48:08 +08:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 23:44:50 +08:00
virtual int get_unique_id() const = 0;
Brand new networked multiplayer
2016-08-20 03:48:08 +08:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 23:44:50 +08:00
virtual ConnectionStatus get_connection_status() const = 0;
[Net] Bind Multiplayer to GDExtension.
2021-09-07 00:09:29 +08:00
[Net] Add generate_unique_id to MultiplayerPeer. Used by ENetMultiplayerPeer and WebSocketServer to generate network IDs, and exposed to the user for p2p networks (e.g. WebRTCMultiplayerPeer) and custom MultiplayerPeer implementations.
2021-07-16 06:43:49 +08:00
uint32_t generate_unique_id() const;
Missing some bits, and added connection status.
2016-08-15 01:06:51 +08:00
[Net] Rename NetworkedMultiplayerPeer to MultiplayerPeer.
2021-07-12 22:11:05 +08:00
MultiplayerPeer() {}
WIP visual scripting, not working yet but you can check out stuff
2016-08-03 06:11:05 +08:00
};
[Net] Bind Multiplayer to GDExtension.
2021-09-07 00:09:29 +08:00
VARIANT_ENUM_CAST(MultiplayerPeer::ConnectionStatus);
[Net] Modularize multiplayer, expose MultiplayerAPI to extensions. - RPC configurations are now dictionaries. - Script.get_rpc_methods renamed to Script.get_rpc_config. - Node.rpc[_id] and Callable.rpc now return an Error. - Refactor MultiplayerAPI to allow extension. - New MultiplayerAPI.rpc method with Array argument (for scripts). - Move the default MultiplayerAPI implementation to a module.
2022-07-13 05:12:42 +08:00
VARIANT_ENUM_CAST(MultiplayerPeer::TransferMode);
[Net] Bind Multiplayer to GDExtension.
2021-09-07 00:09:29 +08:00
class MultiplayerPeerExtension : public MultiplayerPeer {
GDCLASS(MultiplayerPeerExtension, MultiplayerPeer);
protected:
static void _bind_methods();
Allow extending MultiplayerPeerExtension from GDScript
2022-07-21 03:43:34 +08:00
PackedByteArray script_buffer;
[Net] Bind Multiplayer to GDExtension.
2021-09-07 00:09:29 +08:00
public:
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 11:09:07 +08:00
/* PacketPeer extension */
[Net] Bind Multiplayer to GDExtension.
2021-09-07 00:09:29 +08:00
virtual Error get_packet(const uint8_t **r_buffer, int &r_buffer_size) override; ///< buffer is GONE after next get_packet
Rename all gdnative occurences to gdextension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension ->Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION ->EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 19:11:28 +08:00
GDVIRTUAL2R(Error, _get_packet, GDExtensionConstPtr<const uint8_t *>, GDExtensionPtr<int>);
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 11:09:07 +08:00
GDVIRTUAL0R(PackedByteArray, _get_packet_script); // For GDScript.
[Net] Bind Multiplayer to GDExtension.
2021-09-07 00:09:29 +08:00
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 11:09:07 +08:00
virtual Error put_packet(const uint8_t *p_buffer, int p_buffer_size) override;
Rename all gdnative occurences to gdextension Non-exhaustive list of case-sensitive renames: GDExtension -> GDNative GDNATIVE -> GDEXTENSION gdextension -> gdnative ExtensionExtension ->Extension (for where there was GDNativeExtension) EXTENSION_EXTENSION ->EXTENSION (for where there was GDNATIVE_EXTENSION) gdnlib -> gdextension gdn_interface -> gde_interface gdni -> gde_interface
2022-12-07 19:11:28 +08:00
GDVIRTUAL2R(Error, _put_packet, GDExtensionConstPtr<const uint8_t>, int);
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 11:09:07 +08:00
GDVIRTUAL1R(Error, _put_packet_script, PackedByteArray); // For GDScript.
[Net] Bind Multiplayer to GDExtension.
2021-09-07 00:09:29 +08:00
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 11:09:07 +08:00
EXBIND0RC(int, get_available_packet_count);
EXBIND0RC(int, get_max_packet_size);
[Net] Bind Multiplayer to GDExtension.
2021-09-07 00:09:29 +08:00
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 11:09:07 +08:00
/* MultiplayerPeer extension */
[Net] Bind Multiplayer to GDExtension.
2021-09-07 00:09:29 +08:00
virtual void set_refuse_new_connections(bool p_enable) override;
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 11:09:07 +08:00
GDVIRTUAL1(_set_refuse_new_connections, bool); // Optional.
[Net] Bind Multiplayer to GDExtension.
2021-09-07 00:09:29 +08:00
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 11:09:07 +08:00
virtual bool is_refusing_new_connections() const override;
GDVIRTUAL0RC(bool, _is_refusing_new_connections); // Optional.
[MP] Let MultiplayerAPI handle packet relaying and peer signaling. MultiplayerPeer changes: - Adds is_server_relay_supported virtual method Informs the upper MultiplayerAPI layer if it can signal peers connected to the server to other clients, and perform packet relaying among them. - Adds get_packet_channel and get_packet_mode virtual methods Allows the MultiplayerAPI to retrieve the channel and transfer modes to use when relaying the last received packet. SceneMultiplayerPeer changes: - Implement peer signaling and packet relaying when the MultiplayerPeer advertise they are supported. ENet, WebRTC, WebSocket changes: - Removed custom code for relaying from WebSocket and ENet, and let it be handled by the upper layer. - Update WebRTC to split create_client, create_server, and create_mesh, with the latter behaving like the old initialize with "server_compatibility = false", and the first two supporting the upper layer relaying protocol.
2022-10-09 02:50:19 +08:00
virtual bool is_server_relay_supported() const override;
GDVIRTUAL0RC(bool, _is_server_relay_supported); // Optional.
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 11:09:07 +08:00
EXBIND1(set_transfer_channel, int);
EXBIND0RC(int, get_transfer_channel);
EXBIND1(set_transfer_mode, TransferMode);
EXBIND0RC(TransferMode, get_transfer_mode);
EXBIND1(set_target_peer, int);
EXBIND0RC(int, get_packet_peer);
[MP] Let MultiplayerAPI handle packet relaying and peer signaling. MultiplayerPeer changes: - Adds is_server_relay_supported virtual method Informs the upper MultiplayerAPI layer if it can signal peers connected to the server to other clients, and perform packet relaying among them. - Adds get_packet_channel and get_packet_mode virtual methods Allows the MultiplayerAPI to retrieve the channel and transfer modes to use when relaying the last received packet. SceneMultiplayerPeer changes: - Implement peer signaling and packet relaying when the MultiplayerPeer advertise they are supported. ENet, WebRTC, WebSocket changes: - Removed custom code for relaying from WebSocket and ENet, and let it be handled by the upper layer. - Update WebRTC to split create_client, create_server, and create_mesh, with the latter behaving like the old initialize with "server_compatibility = false", and the first two supporting the upper layer relaying protocol.
2022-10-09 02:50:19 +08:00
EXBIND0RC(TransferMode, get_packet_mode);
EXBIND0RC(int, get_packet_channel);
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 11:09:07 +08:00
EXBIND0RC(bool, is_server);
EXBIND0(poll);
[MP] Add MultiplayerPeer disconnect_peer, close. Update ENet, WebRTC, and WebSocket to support peer disconnection and unify the close function.
2022-10-22 23:49:40 +08:00
EXBIND0(close);
EXBIND2(disconnect_peer, int, bool);
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 11:09:07 +08:00
EXBIND0RC(int, get_unique_id);
EXBIND0RC(ConnectionStatus, get_connection_status);
[Net] Bind Multiplayer to GDExtension.
2021-09-07 00:09:29 +08:00
};
WIP visual scripting, not working yet but you can check out stuff
2016-08-03 06:11:05 +08:00
Code quality: Fix header guards consistency Adds `header_guards.sh` bash script, used in CI to validate future changes. Can be run locally to fix invalid header guards.
2022-07-24 05:41:51 +08:00
#endif // MULTIPLAYER_PEER_H
Reference in New Issue Copy Permalink