diff options
author | Bojidar Marinov <bojidar.marinov.bg@gmail.com> | 2018-01-12 00:38:35 +0200 |
---|---|---|
committer | Bojidar Marinov <bojidar.marinov.bg@gmail.com> | 2018-01-12 00:58:22 +0200 |
commit | ad79c703008394a360eb9875196a9414e1c84585 (patch) | |
tree | 99087c85636f2caf8717e42660017d9beb8a0f1f /doc/classes/Timer.xml | |
parent | 9b8e8b2220b4e2bac3310262d3d1cd7a8eb3b0a5 (diff) |
Update docs
[ci skip]
Diffstat (limited to 'doc/classes/Timer.xml')
-rw-r--r-- | doc/classes/Timer.xml | 29 |
1 files changed, 6 insertions, 23 deletions
diff --git a/doc/classes/Timer.xml b/doc/classes/Timer.xml index 09071b2ad1..876eed92ae 100644 --- a/doc/classes/Timer.xml +++ b/doc/classes/Timer.xml @@ -11,20 +11,6 @@ <demos> </demos> <methods> - <method name="get_time_left" qualifiers="const"> - <return type="float"> - </return> - <description> - Returns the timer's remaining time in seconds. Returns 0 if the timer is inactive. - </description> - </method> - <method name="is_paused" qualifiers="const"> - <return type="bool"> - </return> - <description> - Returns [code]true[/code] if the timer is paused. - </description> - </method> <method name="is_stopped" qualifiers="const"> <return type="bool"> </return> @@ -32,15 +18,6 @@ Returns [code]true[/code] if the timer is stopped. </description> </method> - <method name="set_paused"> - <return type="void"> - </return> - <argument index="0" name="paused" type="bool"> - </argument> - <description> - 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> - </method> <method name="start"> <return type="void"> </return> @@ -64,9 +41,15 @@ <member name="one_shot" type="bool" setter="set_one_shot" getter="is_one_shot"> If [code]true[/code], Timer will stop when reaching 0. If [code]false[/code], it will restart. Default value: [code]false[/code]. </member> + <member name="paused" type="bool" setter="set_paused" getter="is_paused"> + If [code]true[/code], the timer is paused and will not process until it is unpaused again, even if [method start] is called. + </member> <member name="process_mode" type="int" setter="set_timer_process_mode" getter="get_timer_process_mode" enum="Timer.TimerProcessMode"> Processing mode. Uses TIMER_PROCESS_* constants as value. </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. + </member> <member name="wait_time" type="float" setter="set_wait_time" getter="get_wait_time"> Wait time in seconds. </member> |