Browse Source

Mention that NetworkedMultiplayerENet uses UDP only

This is important to clarify for those doing port forwarding.
Hugo Locurcio 4 years ago
parent
commit
7b33498995
1 changed files with 2 additions and 0 deletions
  1. 2 0
      modules/enet/doc_classes/NetworkedMultiplayerENet.xml

+ 2 - 0
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>