From 971ae4eb5d35d551fc062f9a4ef33c23eeb03709 Mon Sep 17 00:00:00 2001
From: Ninni Pipping <over999ships@gmail.com>
Date: Sun, 23 Apr 2023 10:21:18 +0200
Subject: [PATCH] Add information about how `Engine.time_scale` affects Timers

(cherry picked from commit 16a1465380df708edebffc53c77011cd771f6b91)
---
 doc/classes/Engine.xml | 2 +-
 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 ac409f596..94f6acd66 100644
--- a/doc/classes/Engine.xml
+++ b/doc/classes/Engine.xml
@@ -204,7 +204,7 @@
 			The desired frames per second. If the hardware cannot keep up, this setting may not be respected. A value of 0 means no limit.
 		</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>
 	<constants>
diff --git a/doc/classes/Timer.xml b/doc/classes/Timer.xml
index 296b8fed4..1893aa059 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_mode] 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_mode] 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>