|
@@ -15,20 +15,21 @@
|
|
<return type="float">
|
|
<return type="float">
|
|
</return>
|
|
</return>
|
|
<description>
|
|
<description>
|
|
- Return the time left for timeout in seconds if the timer is active, 0 otherwise.
|
|
|
|
|
|
+ Returns the timer's remaining time in seconds. Returns 0 if the timer is inactive.
|
|
</description>
|
|
</description>
|
|
</method>
|
|
</method>
|
|
<method name="is_paused" qualifiers="const">
|
|
<method name="is_paused" qualifiers="const">
|
|
<return type="bool">
|
|
<return type="bool">
|
|
</return>
|
|
</return>
|
|
<description>
|
|
<description>
|
|
- Return if the timer is paused or not.
|
|
|
|
|
|
+ Returns [code]true[/code] if the timer is paused.
|
|
</description>
|
|
</description>
|
|
</method>
|
|
</method>
|
|
<method name="is_stopped" qualifiers="const">
|
|
<method name="is_stopped" qualifiers="const">
|
|
<return type="bool">
|
|
<return type="bool">
|
|
</return>
|
|
</return>
|
|
<description>
|
|
<description>
|
|
|
|
+ Returns [code]true[/code] if the timer is stopped.
|
|
</description>
|
|
</description>
|
|
</method>
|
|
</method>
|
|
<method name="set_paused">
|
|
<method name="set_paused">
|
|
@@ -37,14 +38,15 @@
|
|
<argument index="0" name="paused" type="bool">
|
|
<argument index="0" name="paused" type="bool">
|
|
</argument>
|
|
</argument>
|
|
<description>
|
|
<description>
|
|
- Set whether the timer is paused or not. A paused timer will be inactive until it is unpaused again.
|
|
|
|
|
|
+ Pauses the timer. If [code]paused[/code] is [code]true[/code], the timer will not process until it is started or unpaused again, even if [method start] is called.
|
|
</description>
|
|
</description>
|
|
</method>
|
|
</method>
|
|
<method name="start">
|
|
<method name="start">
|
|
<return type="void">
|
|
<return type="void">
|
|
</return>
|
|
</return>
|
|
<description>
|
|
<description>
|
|
- Start the Timer.
|
|
|
|
|
|
+ Starts the timer. 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>
|
|
</description>
|
|
</method>
|
|
</method>
|
|
<method name="stop">
|
|
<method name="stop">
|