Skip to content

Commit d577a21

Browse files
authored
Merge pull request godotengine#78662 from AThousandShips/mp_doc
Clarify restrictions on nested `MultiplayerAPI` in `SceneTree`
2 parents 3710f06 + e9c9285 commit d577a21

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

doc/classes/SceneTree.xml

+2
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,7 @@
110110
<param index="0" name="for_path" type="NodePath" default="NodePath(&quot;&quot;)" />
111111
<description>
112112
Return the [MultiplayerAPI] configured for the given path, or the default one if [param for_path] is empty.
113+
[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.
113114
</description>
114115
</method>
115116
<method name="get_node_count" qualifiers="const">
@@ -208,6 +209,7 @@
208209
<param index="1" name="root_path" type="NodePath" default="NodePath(&quot;&quot;)" />
209210
<description>
210211
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.
212+
[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].
211213
</description>
212214
</method>
213215
<method name="unload_current_scene">

0 commit comments

Comments
 (0)