Document that the high-level multiplayer API is only for Godot servers

(cherry picked from commit 1b03f3f72b)
This commit is contained in:
Hugo Locurcio
2021-01-25 01:57:32 +01:00
committed by Rémi Verschelde
parent 349f25429b
commit af891cebe4
2 changed files with 4 additions and 2 deletions

View File

@@ -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>