Merge pull request #77814 from RedworkDE/doc-node-queuefree

Clarify the docs on Node.queue_free
This commit is contained in:
Rémi Verschelde 2023-06-05 13:43:03 +02:00
commit 9d3d2ead69
No known key found for this signature in database
GPG Key ID: C3336907360768E1

View File

@ -654,7 +654,8 @@
<method name="queue_free">
<return type="void" />
<description>
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.
Queues a node for deletion at the end of the current frame. When deleted, all of its child nodes will be deleted as well, and all references to the node and its children will become invalid, see [method Object.free].
It is safe to call [method queue_free] multiple times per frame on a node, and to [method Object.free] a node that is currently queued for deletion. 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="remove_child">