summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Shenton <theshenton@gmail.com>2023-01-12 15:08:36 +0200
committerRobert Shenton <theshenton@gmail.com>2023-01-12 15:10:06 +0200
commit39d7e984d428846e2fe5aa39e08fa2323ec32e8b (patch)
treebad33c94467f9f9f4f2e19f566b0d235661293ee
parentcaf94f244e1a952300c6426f5d7d9939dd93d472 (diff)
Improve clarity surrounding Timer's time_left variable
-rw-r--r--doc/classes/Timer.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/Timer.xml b/doc/classes/Timer.xml
index d171797e80..1b6c05284e 100644
--- a/doc/classes/Timer.xml
+++ b/doc/classes/Timer.xml
@@ -48,7 +48,7 @@
</member>
<member name="time_left" type="float" setter="" getter="get_time_left">
The timer's remaining time in seconds. Returns 0 if the timer is inactive.
- [b]Note:[/b] You cannot set this value. To change the timer's remaining time, use [method start].
+ [b]Note:[/b] This value is read-only and cannot be set. It is based on [member wait_time], which can be set using [method start].
</member>
<member name="wait_time" type="float" setter="set_wait_time" getter="get_wait_time" default="1.0">
The wait time in seconds.