summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2021-10-07 22:35:17 +0200
committerGitHub <noreply@github.com>2021-10-07 22:35:17 +0200
commit8aa55435b3397dcefb1edf0ae0de5be90e69fb47 (patch)
tree322595afc8d4cf7d6b7842c8cd210bbec0ea5013
parent8b9022d2f3cf10a646319959ace6f3b4c9279bcc (diff)
parentf6d7f3759236750dc1bc42a94a2deb756a910373 (diff)
Merge pull request #53541 from Calinou/doc-call-group-null
-rw-r--r--doc/classes/SceneTree.xml5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml
index 68f2d9a8d8..ce7fd293d5 100644
--- a/doc/classes/SceneTree.xml
+++ b/doc/classes/SceneTree.xml
@@ -19,6 +19,7 @@
<argument index="1" name="method" type="StringName" />
<description>
Calls [code]method[/code] on each member of the given group. You can pass arguments to [code]method[/code] by specifying them at the end of the method call. This method is equivalent of calling [method call_group_flags] with [constant GROUP_CALL_DEFAULT] flag.
+ [b]Note:[/b] Due to design limitations, [method call_group] will fail silently if one of the arguments is [code]null[/code].
[b]Note:[/b] [method call_group] will always call methods with an one-frame delay, in a way similar to [method Object.call_deferred]. To call methods immediately, use [method call_group_flags] with the [constant GROUP_CALL_REALTIME] flag.
</description>
</method>
@@ -29,8 +30,10 @@
<argument index="2" name="method" type="StringName" />
<description>
Calls [code]method[/code] on each member of the given group, respecting the given [enum GroupCallFlags]. You can pass arguments to [code]method[/code] by specifying them at the end of the method call.
+ [b]Note:[/b] Due to design limitations, [method call_group_flags] will fail silently if one of the arguments is [code]null[/code].
[codeblock]
- get_tree().call_group_flags(SceneTree.GROUP_CALL_REALTIME | SceneTree.GROUP_CALL_REVERSE, "bases", "destroy") # Call the method immediately and in reverse order.
+ # Call the method immediately and in reverse order.
+ get_tree().call_group_flags(SceneTree.GROUP_CALL_REALTIME | SceneTree.GROUP_CALL_REVERSE, "bases", "destroy")
[/codeblock]
</description>
</method>