diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-05-17 11:36:05 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-17 11:36:05 +0200 |
| commit | 4c8832701b291b8f7bc64e22d93972f6bc968a24 (patch) | |
| tree | 1da1f03ff15d57df7b40bf60a3f580d7271aa821 /doc | |
| parent | 72608e571aea11f2565e9b38d2bcdc779ca16afe (diff) | |
| parent | 7f5c81c32f8b5fe3c7db25b8e77ff08ffaae51ba (diff) | |
Merge pull request #38695 from dreamsComeTrue/node-swap-order-arguments
Replace 'add_child_below_node' with 'add_sibling' in Node
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Node.xml | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 0c0d16753a..04c8d2bf57 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -129,21 +129,19 @@ 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. + If you need the child node to be added below a specific node in the list of children, use [method add_sibling] 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"> + <method name="add_sibling"> <return type="void"> </return> - <argument index="0" name="preceding_node" type="Node"> + <argument index="0" name="sibling" type="Node"> </argument> - <argument index="1" name="node" type="Node"> - </argument> - <argument index="2" name="legible_unique_name" type="bool" default="false"> + <argument index="1" name="legible_unique_name" type="bool" default="false"> </argument> <description> - Adds a child node below the [code]preceding_node[/code]. + Adds a [code]sibling[/code] node to current's node parent, at the the same level as that node, right below it. 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> |