Merge pull request #78662 from AThousandShips/mp_doc

Clarify restrictions on nested `MultiplayerAPI` in `SceneTree`
This commit is contained in:
Fabio Alessandrelli 2023-06-26 10:06:00 +02:00 committed by GitHub
commit d577a2109a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -110,6 +110,7 @@
<param index="0" name="for_path" type="NodePath" default="NodePath(&quot;&quot;)" />
<description>
Return the [MultiplayerAPI] configured for the given path, or the default one if [param for_path] is empty.
[b]Note:[/b] Only one [MultiplayerAPI] may be configured for any subpath. If one is configured for [code]"/root/Foo"[/code] then calling this for [code]"/root/Foo/Bar"[/code] will return the one configured for [code]"/root/Foo"[/code], regardless if one is configured for that path.
</description>
</method>
<method name="get_node_count" qualifiers="const">
@ -208,6 +209,7 @@
<param index="1" name="root_path" type="NodePath" default="NodePath(&quot;&quot;)" />
<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] Only one [MultiplayerAPI] may be configured for any subpath. If one is configured for [code]"/root/Foo"[/code] setting one for [code]"/root/Foo/Bar"[/code] will be ignored. See [method get_multiplayer].
</description>
</method>
<method name="unload_current_scene">