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

Merge pull request #105687 from Calinou/doc-scenetree-custom-multiplayer

Browse Source 
Document `SceneTree.set_multiplayer()` should be called in `_enter_tree()`
This commit is contained in:
Thaddeus Crews
2025-04-27 19:21:28 -05:00
parent bdd3cb3f31 665342c1ff
commit 22b22625db
1 changed files with 1 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doc/classes/SceneTree.xml
View File

@ -234,6 +234,7 @@
<description>
Sets a custom [MultiplayerAPI] with the given [param root_path] (controlling also the relative subpaths), or override the default one if [param root_path] is empty.
[b]Note:[/b] No [MultiplayerAPI] must be configured for the subpath containing [param root_path], nested custom multiplayers are not allowed. I.e. if one is configured for [code]"/root/Foo"[/code] setting one for [code]"/root/Foo/Bar"[/code] will cause an error.
[b]Note:[/b] [method set_multiplayer] should be called [i]before[/i] the child nodes are ready at the given [param root_path]. If multiplayer nodes like [MultiplayerSpawner] or [MultiplayerSynchronizer] are added to the tree before the custom multiplayer API is set, they will not work.
</description>
</method>
<method name="unload_current_scene">