summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2022-11-28 14:49:34 +0100
committerRémi Verschelde <rverschelde@gmail.com>2022-11-28 14:49:34 +0100
commitef090ee6eac429e51b26ea31e7882cc8cdfa2093 (patch)
treea94f2cb58a439a4767f4c18e7c5e7783bf279d12 /doc
parent12f06605181ff1a9d8fd1bb9ae7ee60e70227a9e (diff)
parentb9d1550590b94a3db00fe9373800256013ee078b (diff)
Merge pull request #68874 from TokageItLab/fix-unique-path-keying
Added option to `get_path_to()` to get the shortest path considering unique name
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/Node.xml3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml
index 0368f29a13..24df5977f9 100644
--- a/doc/classes/Node.xml
+++ b/doc/classes/Node.xml
@@ -384,8 +384,11 @@
<method name="get_path_to" qualifiers="const">
<return type="NodePath" />
<param index="0" name="node" type="Node" />
+ <param index="1" name="use_unique_path" type="bool" default="false" />
<description>
Returns the relative [NodePath] from this node to the specified [param node]. Both nodes must be in the same scene or the function will fail.
+ If [param use_unique_path] is [code]true[/code], returns the shortest path considering unique node.
+ [b]Note:[/b] If you get a relative path which starts from a unique node, the path may be longer than a normal relative path due to the addition of the unique node's name.
</description>
</method>
<method name="get_physics_process_delta_time" qualifiers="const">