summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorZi Ye <major.mcdoom@gmail.com>2024-02-25 15:57:58 -0600
committerZi Ye <major.mcdoom@gmail.com>2024-02-29 08:40:32 -0600
commit4c8015bec3c70202d14e778bf086e48e307f5c58 (patch)
tree59a9b23fbf028c88f475ed1346671317e5525df5
parentf77bc872114ebe77f1604db47b81016ff478ce17 (diff)
downloadredot-engine-4c8015bec3c70202d14e778bf086e48e307f5c58.tar.gz
Add necessary elaboration to documentation for Node3D::get_parent_node_3d
-rw-r--r--doc/classes/Node3D.xml3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/Node3D.xml b/doc/classes/Node3D.xml
index 0b7b982e52..4a289f9cab 100644
--- a/doc/classes/Node3D.xml
+++ b/doc/classes/Node3D.xml
@@ -49,7 +49,8 @@
<method name="get_parent_node_3d" qualifiers="const">
<return type="Node3D" />
<description>
- Returns the parent [Node3D], or an empty [Object] if no parent exists or parent is not of type [Node3D].
+ Returns the parent [Node3D], or [code]null[/code] if no parent exists, the parent is not of type [Node3D], or [member top_level] is [code]true[/code].
+ [b]Note:[/b] Calling this method is not equivalent to [code]get_parent() as Node3D[/code], which does not take [member top_level] into account.
</description>
</method>
<method name="get_world_3d" qualifiers="const">