diff options
| author | Anish <anishbhobe@hotmail.com> | 2018-04-27 01:12:50 +0530 |
|---|---|---|
| committer | Anish <anishbhobe@hotmail.com> | 2018-04-27 01:17:20 +0530 |
| commit | f714637e58034b6340fa0725c7935a1ae29d92c0 (patch) | |
| tree | 2937ecb14ceda40ecb7fdbcee8c232a70cafadc6 /doc | |
| parent | e5a13e26265179d9d6b477c6d744758521745123 (diff) | |
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
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Timer.xml | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/classes/Timer.xml b/doc/classes/Timer.xml index aba1b78188..c51a52d911 100644 --- a/doc/classes/Timer.xml +++ b/doc/classes/Timer.xml @@ -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> |