godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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
No known key found for this signature in database
GPG Key ID: C3336907360768E1
2 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/classes/MultiplayerAPI.xml
View File

@ -4,9 +4,10 @@
High-level multiplayer API. High-level multiplayer API.
</brief_description> </brief_description>
<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. 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. 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> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>

3
doc/classes/NetworkedMultiplayerPeer.xml
View File

@ -4,7 +4,8 @@
A high-level network interface to simplify multiplayer interactions. A high-level network interface to simplify multiplayer interactions.
</brief_description> </brief_description>
<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> </description>
<tutorials> <tutorials>
<link title="High-level multiplayer">https://docs.godotengine.org/en/3.2/tutorials/networking/high_level_multiplayer.html</link> <link title="High-level multiplayer">https://docs.godotengine.org/en/3.2/tutorials/networking/high_level_multiplayer.html</link>