Stowage/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-12-07 22:00:10 +00:00
Code Issues Projects Releases Packages Wiki Activity

Document SceneTree.set_multiplayer() should be called in _enter_tree()

Browse source 
If it's called in `_ready()`, it will be too late as child nodes will
already be set up by the time the custom multiplayer API is set.
This commit is contained in:
Hugo Locurcio 2025-04-23 17:17:46 +02:00
parent 1696ab0cb6
commit 665342c1ff
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C
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">