diff options
| author | kobewi <kobewi4e@gmail.com> | 2021-03-23 15:16:36 +0100 |
|---|---|---|
| committer | kobewi <kobewi4e@gmail.com> | 2021-09-16 02:22:45 +0200 |
| commit | 31ef94f2ecaac3fc32fb46f12e0a61f410cb84dc (patch) | |
| tree | b49f2a65dd2c2d77b73cc0f6b1e0d0796d954630 /doc | |
| parent | 4737b7bbb4a06e988d7906437834b136066b594b (diff) | |
Improve call_group documentation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/SceneTree.xml | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index 9a38e52b23..8d7427611a 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -18,7 +18,7 @@ <argument index="0" name="group" type="StringName" /> <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. + 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] [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,7 +29,9 @@ <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] Group call flags are used to control the method calling behavior. If the [constant GROUP_CALL_REALTIME] flag is present in the [code]flags[/code] argument, methods will be called immediately. If this flag isn't present in [code]flags[/code], methods will be called with a one-frame delay in a way similar to [method call_group]. + [codeblock] + get_tree().call_group_flags(SceneTree.GROUP_CALL_REALTIME | SceneTree.GROUP_CALL_REVERSE, "bases", "destroy") # Call the method immediately and in reverse order. + [/codeblock] </description> </method> <method name="change_scene"> |