summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2019-06-29 11:27:27 +0200
committerGitHub <noreply@github.com>2019-06-29 11:27:27 +0200
commit9adc158097b5bfdb14fbd283918183e19bd2b133 (patch)
tree6c693a8e6c7795e3b97a7f5056f795118a4a60d4 /doc
parentff3a54398daf493c930d831caa77d936982be0ad (diff)
parentb71a33916034b809e548a0368a0e49188da0fbcb (diff)
Merge pull request #30162 from KoBeWi/doc-ready
Clarify docs for _ready and request_ready
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/Node.xml3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml
index 5956d7a364..d9df2a50c6 100644
--- a/doc/classes/Node.xml
+++ b/doc/classes/Node.xml
@@ -85,6 +85,7 @@
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. 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.
</description>
</method>
<method name="_unhandled_input" qualifiers="virtual">
@@ -595,7 +596,7 @@
<return type="void">
</return>
<description>
- 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).
</description>
</method>
<method name="rpc" qualifiers="vararg">