diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2020-02-26 23:37:55 +0100 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2020-02-27 18:41:18 +0100 |
| commit | 393a3c3122ac3b54044190ba7bdd081d6703db64 (patch) | |
| tree | 665782b4d3a09f92722586c0318f91b6c96027be /doc/classes | |
| parent | fde1211771f2b3957ba5e5c64a747d3de69cb9f9 (diff) | |
Improve the `Node.add_child_below_node()` documentation
This closes https://github.com/godotengine/godot-docs/issues/2730.
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/Node.xml | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 3ddc3af200..eb15bc2ad9 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -129,21 +129,23 @@ child_node.get_parent().remove_child(child_node) add_child(child_node) [/codeblock] + If you need the child node to be added below a specific node in the list of children, use [method add_child_below_node] instead of this method. [b]Note:[/b] If you want a child to be persisted to a [PackedScene], you must set [member owner] in addition to calling [method add_child]. This is typically relevant for [url=https://godot.readthedocs.io/en/latest/tutorials/misc/running_code_in_the_editor.html]tool scripts[/url] and [url=https://godot.readthedocs.io/en/latest/tutorials/plugins/editor/index.html]editor plugins[/url]. If [method add_child] is called without setting [member owner], the newly added [Node] will not be visible in the scene tree, though it will be visible in the 2D/3D view. </description> </method> <method name="add_child_below_node"> <return type="void"> </return> - <argument index="0" name="node" type="Node"> + <argument index="0" name="preceding_node" type="Node"> </argument> - <argument index="1" name="child_node" type="Node"> + <argument index="1" name="node" type="Node"> </argument> <argument index="2" name="legible_unique_name" type="bool" default="false"> </argument> <description> - Adds a child node. The child is placed below the given node in the list of children. + Adds a child node below the [code]preceding_node[/code]. If [code]legible_unique_name[/code] is [code]true[/code], the child node will have an human-readable name based on the name of the node being instanced instead of its type. + Use [method add_child] instead of this method if you don't need the child node to be added below a specific node in the list of children. </description> </method> <method name="add_to_group"> |