summaryrefslogtreecommitdiff
path: root/modules/enet/doc_classes
diff options
context:
space:
mode:
authorFabio Alessandrelli <fabio.alessandrelli@gmail.com>2021-01-15 15:52:29 +0100
committerGitHub <noreply@github.com>2021-01-15 15:52:29 +0100
commit9a2f848855299623e601b7426d35b6fbd1ae9e1c (patch)
treee8c5b7d51e79cb03018e3f1bbf714391b395040f /modules/enet/doc_classes
parentfa5ead4db7c26208f0edb54837aa6124d4550d0c (diff)
parent7b33498995e3aa23b935cd728d3291600f2cdcb5 (diff)
Merge pull request #45171 from Calinou/doc-enet-udp-only
Mention that NetworkedMultiplayerENet uses UDP only
Diffstat (limited to 'modules/enet/doc_classes')
-rw-r--r--modules/enet/doc_classes/NetworkedMultiplayerENet.xml2
1 files changed, 2 insertions, 0 deletions
diff --git a/modules/enet/doc_classes/NetworkedMultiplayerENet.xml b/modules/enet/doc_classes/NetworkedMultiplayerENet.xml
index f46ef2d812..6c713fa1ce 100644
--- a/modules/enet/doc_classes/NetworkedMultiplayerENet.xml
+++ b/modules/enet/doc_classes/NetworkedMultiplayerENet.xml
@@ -5,6 +5,8 @@
</brief_description>
<description>
A PacketPeer implementation that should be passed to [member SceneTree.network_peer] after being initialized as either a client or server. Events can then be handled by connecting to [SceneTree] signals.
+ ENet's purpose is to provide a relatively thin, simple and robust network communication layer on top of UDP (User Datagram Protocol).
+ [b]Note:[/b] ENet only uses UDP, not TCP. When forwarding the server port to make your server accessible on the public Internet, you only need to forward the server port in UDP. You can use the [UPNP] class to try to forward the server port automatically when starting the server.
</description>
<tutorials>
<link title="High-level multiplayer">https://docs.godotengine.org/en/latest/tutorials/networking/high_level_multiplayer.html</link>