Skip to content

Commit

Permalink
Merge pull request #88961 from AThousandShips/deferred_doc
Browse files Browse the repository at this point in the history
[Doc] Clarify some details about deferred calls
  • Loading branch information
akien-mga committed Feb 29, 2024
2 parents 7434f8b + 1cc5b0a commit dc87f05
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions doc/classes/Callable.xml
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@
}
[/csharp]
[/codeblocks]
[b]Note:[/b] Deferred calls are processed at idle time. Idle time happens mainly at the end of process and physics frames. In it, deferred calls will be run until there are none left, which means you can defer calls from other deferred calls and they'll still be run in the current idle time cycle. This means you should not call a method deferred from itself (or from a method called by it), as this causes infinite recursion the same way as if you had called the method directly.
See also [method Object.call_deferred].
</description>
</method>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/Object.xml
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,7 @@
<param index="0" name="method" type="StringName" />
<description>
Calls the [param method] on the object during idle time. Always returns null, [b]not[/b] the method's result.
Idle time happens mainly at the end of process and physics frames. In it, deferred calls will be run until there are none left, which means you can defer calls from other deferred calls and they'll still be run in the current idle time cycle. If not done carefully, this can result in infinite recursion without causing a stack overflow, which will hang the game similarly to an infinite loop.
Idle time happens mainly at the end of process and physics frames. In it, deferred calls will be run until there are none left, which means you can defer calls from other deferred calls and they'll still be run in the current idle time cycle. This means you should not call a method deferred from itself (or from a method called by it), as this causes infinite recursion the same way as if you had called the method directly.
This method supports a variable number of arguments, so parameters can be passed as a comma separated list.
[codeblocks]
[gdscript]
Expand Down

0 comments on commit dc87f05

Please sign in to comment.