summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2022-09-08 09:23:31 +0200
committerRémi Verschelde <rverschelde@gmail.com>2022-09-08 09:23:31 +0200
commit7936b3cc4c657e4b273b376068f095e1e0e4d82a (patch)
treea57e1d039f6f53b4a6b03fb123f5a3f4e23b374f /doc
parentde739530c215a65788e047c793f376ad6097863a (diff)
parentb218727599b956384c4c77446535737cbd415173 (diff)
Merge pull request #60108 from KoBeWi/arise_to_top
Rename raise() to move_to_front()
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/CanvasItem.xml7
-rw-r--r--doc/classes/Node.xml6
2 files changed, 7 insertions, 6 deletions
diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml
index d8c1af0b3c..70d825efac 100644
--- a/doc/classes/CanvasItem.xml
+++ b/doc/classes/CanvasItem.xml
@@ -500,6 +500,13 @@
Transformations issued by [param event]'s inputs are applied in local space instead of global space.
</description>
</method>
+ <method name="move_to_front">
+ <return type="void" />
+ <description>
+ Moves this node to display on top of its siblings. This has more use in [Control], as [Node2D] can be ordered with [member Node2D.z_index].
+ Internally, the node is moved to the bottom of parent's children list. The method has no effect on nodes without a parent.
+ </description>
+ </method>
<method name="queue_redraw">
<return type="void" />
<description>
diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml
index a0c5bfd4bb..92beefa5fc 100644
--- a/doc/classes/Node.xml
+++ b/doc/classes/Node.xml
@@ -577,12 +577,6 @@
Queues a node for deletion at the end of the current frame. When deleted, all of its child nodes will be deleted as well. This method ensures it's safe to delete the node, contrary to [method Object.free]. Use [method Object.is_queued_for_deletion] to check whether a node will be deleted at the end of the frame.
</description>
</method>
- <method name="raise">
- <return type="void" />
- <description>
- Moves this node to the bottom of parent node's children hierarchy. This is often useful in GUIs ([Control] nodes), because their order of drawing depends on their order in the tree. The top Node is drawn first, then any siblings below the top Node in the hierarchy are successively drawn on top of it. After using [code]raise[/code], a Control will be drawn on top of its siblings.
- </description>
- </method>
<method name="remove_and_skip">
<return type="void" />
<description>