asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Merge pull request #95485 from sepTN/clarify-timer-docs

Browse source 
Clarify `Timer.start()` documentation to match the current behavior.
This commit is contained in:
Rémi Verschelde 2024-08-16 14:35:01 +02:00
commit 63397b5b17
No known key found for this signature in database
GPG key ID: C3336907360768E1
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/classes/Timer.xml
View file

@ -28,7 +28,7 @@
<return type="void" /> <return type="void" />
<param index="0" name="time_sec" type="float" default="-1" /> <param index="0" name="time_sec" type="float" default="-1" />
<description> <description>
Starts the timer, if it was not started already. Fails if the timer is not inside the tree. If [param time_sec] is greater than [code]0[/code], this value is used for the [member wait_time]. Starts the timer, or resets the timer if it was started already. Fails if the timer is not inside the tree. If [param time_sec] is greater than [code]0[/code], this value is used for the [member wait_time].
[b]Note:[/b] This method does not resume a paused timer. See [member paused]. [b]Note:[/b] This method does not resume a paused timer. See [member paused].
</description> </description>
</method> </method>