Merge pull request #33867 from rcorre/get_node_docs

Clarify get_node vs get_node_or_null.
This commit is contained in:
Rémi Verschelde 2019-11-25 14:35:45 +01:00 committed by GitHub
commit 934f6f2529
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -251,7 +251,7 @@
<argument index="0" name="path" type="NodePath">
</argument>
<description>
Fetches a node. The [NodePath] can be either a relative path (from the current node) or an absolute path (in the scene tree) to a node. If the path does not exist, a [code]null instance[/code] is returned and attempts to access it will result in an "Attempt to call &lt;method&gt; on a null instance." error.
Fetches a node. The [NodePath] can be either a relative path (from the current node) or an absolute path (in the scene tree) to a node. If the path does not exist, a [code]null instance[/code] is returned and an error is logged. Attempts to access methods on the return value will result in an "Attempt to call &lt;method&gt; on a null instance." error.
[b]Note:[/b] Fetching absolute paths only works when the node is inside the scene tree (see [method is_inside_tree]).
[b]Example:[/b] Assume your current node is Character and the following tree:
[codeblock]
@ -295,7 +295,7 @@
<argument index="0" name="path" type="NodePath">
</argument>
<description>
Similar to [method get_node], but does not raise an error if [code]path[/code] does not point to a valid [Node].
Similar to [method get_node], but does not log an error if [code]path[/code] does not point to a valid [Node].
</description>
</method>
<method name="get_parent" qualifiers="const">