Merge pull request #77920 from biswas08433/master

doc: Clarify description of `SceneTree.create_timer()`
This commit is contained in:
Rémi Verschelde 2023-06-15 16:08:30 +02:00
commit 99068d48d4
No known key found for this signature in database
GPG key ID: C3336907360768E1

View file

@ -61,7 +61,7 @@
<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].
Returns a [SceneTreeTimer] which will emit [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.
If [param process_in_physics] is set to [code]true[/code], will update the [SceneTreeTimer] during the physics frame instead of the process frame (fixed framerate processing).
If [param ignore_time_scale] is set to [code]true[/code], will ignore [member Engine.time_scale] and update the [SceneTreeTimer] with the actual frame delta.