diff options
| author | Xwdit <xwditfr@gmail.com> | 2022-07-15 08:21:51 +0200 |
|---|---|---|
| committer | Xwdit <xwditfr@gmail.com> | 2022-09-03 11:44:11 +0200 |
| commit | f3503561835e198ee73add80353e63985ac336e1 (patch) | |
| tree | d626ba0bdb19632fd1dd7f2eec19146fb92aad85 /doc | |
| parent | 654a31df062b58b3b534e790b2b4a4cc0762f6a4 (diff) | |
Some improvements to the SceneTreeTimer
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/SceneTree.xml | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index 417703ff01..221e627e35 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -58,8 +58,13 @@ <return type="SceneTreeTimer" /> <param index="0" name="time_sec" type="float" /> <param index="1" name="process_always" type="bool" default="true" /> + <param index="2" name="process_in_physics" type="bool" default="false" /> + <param index="3" name="ignore_time_scale" type="bool" default="false" /> <description> - Returns a [SceneTreeTimer] which will [signal SceneTreeTimer.timeout] after the given time in seconds elapsed in this [SceneTree]. If [param process_always] is set to [code]false[/code], pausing the [SceneTree] will also pause the timer. + Returns a [SceneTreeTimer] which will [signal SceneTreeTimer.timeout] after the given time in seconds elapsed in this [SceneTree]. + If [code]process_always[/code] is set to [code]false[/code], pausing the [SceneTree] will also pause the timer. + If [code]process_in_physics[/code] is set to [code]true[/code], will update the [SceneTreeTimer] during the physics frame instead of the process frame (fixed framerate processing). + If [code]ignore_time_scale[/code] is set to [code]true[/code], will ignore [member Engine.time_scale] and update the [SceneTreeTimer] with the actual frame delta. Commonly used to create a one-shot delay timer as in the following example: [codeblocks] [gdscript] |