summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSteven Schoen <steven@stevenschoen.com>2023-12-19 21:22:39 -0500
committerSteven Schoen <steven.schoen@reddit.com>2024-01-07 00:01:03 -0400
commit3c416f3a643cf9df01b7076a052e2dd9d5f29717 (patch)
tree683b154854aa71e4f6af627ec8726725834189b4
parentc8c483cf57a768110fce57e509f9b855e69d34b7 (diff)
downloadredot-engine-3c416f3a643cf9df01b7076a052e2dd9d5f29717.tar.gz
Clarify Node doc: get_child returns null for invalid index
-rw-r--r--doc/classes/Node.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml
index 4d31b5b8ed..8fb2e65faf 100644
--- a/doc/classes/Node.xml
+++ b/doc/classes/Node.xml
@@ -267,7 +267,7 @@
<param index="0" name="idx" type="int" />
<param index="1" name="include_internal" type="bool" default="false" />
<description>
- Fetches a child node by its index. Each child node has an index relative its siblings (see [method get_index]). The first child is at index 0. Negative values can also be used to start from the end of the list. This method can be used in combination with [method get_child_count] to iterate over this node's children.
+ Fetches a child node by its index. Each child node has an index relative its siblings (see [method get_index]). The first child is at index 0. Negative values can also be used to start from the end of the list. This method can be used in combination with [method get_child_count] to iterate over this node's children. If no child exists at the given index, this method returns [code]null[/code] and an error is generated.
If [param include_internal] is [code]false[/code], internal children are ignored (see [method add_child]'s [code]internal[/code] parameter).
[codeblock]
# Assuming the following are children of this node, in order: