Allows setting the Timer wait_time in start method.

Allows shortening the two line method of Timer.set_wait_time
followed by Timer.start set wait_time as a parameter to
Timer.start. Also modifies the class documentation.

Fixes: #18107
This commit is contained in:
Anish
2018-04-27 01:12:50 +05:30
parent e5a13e2626
commit f714637e58
3 changed files with 9 additions and 4 deletions

View File

@@ -21,8 +21,10 @@
<method name="start">
<return type="void">
</return>
<argument index="0" name="time_sec" type="float" default="-1">
</argument>
<description>
Starts the timer. This also resets the remaining time to [code]wait_time[/code].
Starts the timer. Sets [code]wait_time[/code] to [code]time_sec[/code] if [code]time_sec[/code] > 0. This also resets the remaining time to [code]wait_time[/code].
Note: this method will not resume a paused timer. See [method set_paused].
</description>
</method>