From e7899b9e35c044c33d050001cf67eec9f82ef691 Mon Sep 17 00:00:00 2001 From: Tomasz Chabora Date: Fri, 28 Jun 2019 18:58:30 +0200 Subject: [PATCH] Clarify docs for _ready and request_ready (cherry picked from commit b71a33916034b809e548a0368a0e49188da0fbcb) --- doc/classes/Node.xml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 72f56160c8f..a8295878fc8 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -84,7 +84,8 @@ Called when the node is "ready", i.e. when both the node and its children have entered the scene tree. If the node has children, their [method _ready] callbacks get triggered first, and the parent node will receive the ready notification afterwards. Corresponds to the [constant NOTIFICATION_READY] notification in [method Object._notification]. See also the [code]onready[/code] keyword for variables. - Usually used for initialization. For even earlier initialization, [method Object._init] may be used. Also see [method _enter_tree]. + Usually used for initialization. For even earlier initialization, [method Object._init] may be used. See also [method _enter_tree]. + [b]Note:[/b] [method _ready] may be called only once for each node. After removing a node from the scene tree and adding again, [code]_ready[/code] will not be called for the second time. This can be bypassed with requesting another call with [method request_ready], which may be called anywhere before adding the node again. @@ -582,7 +583,7 @@ - Requests that [code]_ready[/code] be called again. + Requests that [code]_ready[/code] be called again. Note that the method won't be called immediately, but is scheduled for when the node is added to the scene tree again (see [method _ready]). [code]_ready[/code] is called only for the node which requested it, which means that you need to request ready for each child if you want them to call [code]_ready[/code] too (in which case, [code]_ready[/code] will be called in the same order as it would normally).