Browse Source

Merge pull request #45432 from Calinou/doc-multiplayer-api-non-godot

Document that the high-level multiplayer API is only for Godot servers
Fabio Alessandrelli 4 years ago
parent
commit
c5c9517e1e
2 changed files with 4 additions and 2 deletions
  1. 2 1
      doc/classes/MultiplayerAPI.xml
  2. 2 1
      doc/classes/NetworkedMultiplayerPeer.xml

+ 2 - 1
doc/classes/MultiplayerAPI.xml

@@ -4,9 +4,10 @@
 		High-level multiplayer API.
 	</brief_description>
 	<description>
-		This class implements most of the logic behind the high-level multiplayer API.
+		This class implements most of the logic behind the high-level multiplayer API. See also [NetworkedMultiplayerPeer].
 		By default, [SceneTree] has a reference to this class that is used to provide multiplayer capabilities (i.e. RPC/RSET) across the whole scene.
 		It is possible to override the MultiplayerAPI instance used by specific Nodes by setting the [member Node.custom_multiplayer] property, effectively allowing to run both client and server in the same scene.
+		[b]Note:[/b] The high-level multiplayer API protocol is an implementation detail and isn't meant to be used by non-Godot servers. It may change without notice.
 	</description>
 	<tutorials>
 	</tutorials>

+ 2 - 1
doc/classes/NetworkedMultiplayerPeer.xml

@@ -4,7 +4,8 @@
 		A high-level network interface to simplify multiplayer interactions.
 	</brief_description>
 	<description>
-		Manages the connection to network peers. Assigns unique IDs to each client connected to the server.
+		Manages the connection to network peers. Assigns unique IDs to each client connected to the server. See also [MultiplayerAPI].
+		[b]Note:[/b] The high-level multiplayer API protocol is an implementation detail and isn't meant to be used by non-Godot servers. It may change without notice.
 	</description>
 	<tutorials>
 		<link title="High-level multiplayer">https://docs.godotengine.org/en/latest/tutorials/networking/high_level_multiplayer.html</link>