diff options
| author | Ninni Pipping <over999ships@gmail.com> | 2023-04-23 10:21:18 +0200 |
|---|---|---|
| committer | Yuri Sizov <yuris@humnom.net> | 2023-04-26 14:51:00 +0200 |
| commit | 08ec4a82bd29828d47c241f6d5dbc062564810b7 (patch) | |
| tree | 9525850504cf826a6896e4dda62290f199a526b4 | |
| parent | d327bb7a45212662254ba03e494c637603dadfda (diff) | |
Add information about how `Engine.time_scale` affects Timers
(cherry picked from commit 16a1465380df708edebffc53c77011cd771f6b91)
| -rw-r--r-- | doc/classes/Engine.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Timer.xml | 3 |
2 files changed, 3 insertions, 2 deletions
diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml index 461ffcb2e0..c41a853bb7 100644 --- a/doc/classes/Engine.xml +++ b/doc/classes/Engine.xml @@ -306,7 +306,7 @@ [b]Note:[/b] This property does not impact the editor's Errors tab when running a project from the editor. </member> <member name="time_scale" type="float" setter="set_time_scale" getter="get_time_scale" default="1.0"> - Controls how fast or slow the in-game clock ticks versus the real life one. It defaults to 1.0. A value of 2.0 means the game moves twice as fast as real life, whilst a value of 0.5 means the game moves at half the regular speed. + Controls how fast or slow the in-game clock ticks versus the real life one. It defaults to 1.0. A value of 2.0 means the game moves twice as fast as real life, whilst a value of 0.5 means the game moves at half the regular speed. This also affects [Timer] and [SceneTreeTimer] (see [method SceneTree.create_timer] for how to control this). </member> </members> </class> diff --git a/doc/classes/Timer.xml b/doc/classes/Timer.xml index 1b6c05284e..f4f4efd42e 100644 --- a/doc/classes/Timer.xml +++ b/doc/classes/Timer.xml @@ -5,6 +5,7 @@ </brief_description> <description> Counts down a specified interval and emits a signal on reaching 0. Can be set to repeat or "one-shot" mode. + [b]Note:[/b] Timers are affected by [member Engine.time_scale], a higher scale means quicker timeouts, and vice versa. [b]Note:[/b] To create a one-shot timer without instantiating a node, use [method SceneTree.create_timer]. </description> <tutorials> @@ -52,7 +53,7 @@ </member> <member name="wait_time" type="float" setter="set_wait_time" getter="get_wait_time" default="1.0"> The wait time in seconds. - [b]Note:[/b] Timers can only emit once per rendered frame at most (or once per physics frame if [member process_callback] is [constant TIMER_PROCESS_PHYSICS]). This means very low wait times (lower than 0.05 seconds) will behave in significantly different ways depending on the rendered framerate. For very low wait times, it is recommended to use a process loop in a script instead of using a Timer node. + [b]Note:[/b] Timers can only emit once per rendered frame at most (or once per physics frame if [member process_callback] is [constant TIMER_PROCESS_PHYSICS]). This means very low wait times (lower than 0.05 seconds) will behave in significantly different ways depending on the rendered framerate. For very low wait times, it is recommended to use a process loop in a script instead of using a Timer node. Timers are affected by [member Engine.time_scale], a higher scale means quicker timeouts, and vice versa. </member> </members> <signals> |