summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFabio Alessandrelli <fabio.alessandrelli@gmail.com>2023-06-26 10:06:00 +0200
committerGitHub <noreply@github.com>2023-06-26 10:06:00 +0200
commitd577a2109a442dc7555a571db262e8b0bb93e32c (patch)
treeaa1129999439e214199dc75a90d59d7666beedc9
parent3710f069293f2fde8afe33fea898c4b36fa5e943 (diff)
parente9c9285213725aa8fb2fa9b256d4fa775a66e297 (diff)
downloadredot-engine-d577a2109a442dc7555a571db262e8b0bb93e32c.tar.gz
Merge pull request #78662 from AThousandShips/mp_doc
Clarify restrictions on nested `MultiplayerAPI` in `SceneTree`
-rw-r--r--doc/classes/SceneTree.xml2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml
index ba6a6381fd..7b8eca2229 100644
--- a/doc/classes/SceneTree.xml
+++ b/doc/classes/SceneTree.xml
@@ -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">