73 lines
2.6 KiB
XML
73 lines
2.6 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="Timer" inherits="Node" category="Core" version="3.0-beta">
|
|
<brief_description>
|
|
A countdown timer.
|
|
</brief_description>
|
|
<description>
|
|
Counts down a specified interval and emits a signal on reaching 0. Can be set to repeat or "one shot" mode.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<demos>
|
|
</demos>
|
|
<methods>
|
|
<method name="is_stopped" qualifiers="const">
|
|
<return type="bool">
|
|
</return>
|
|
<description>
|
|
Returns [code]true[/code] if the timer is stopped.
|
|
</description>
|
|
</method>
|
|
<method name="start">
|
|
<return type="void">
|
|
</return>
|
|
<description>
|
|
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>
|
|
</method>
|
|
<method name="stop">
|
|
<return type="void">
|
|
</return>
|
|
<description>
|
|
Stop (cancel) the Timer.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="autostart" type="bool" setter="set_autostart" getter="has_autostart">
|
|
If [code]true[/code], Timer will automatically start when entering the scene tree. Default value: [code]false[/code].
|
|
</member>
|
|
<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>
|
|
</members>
|
|
<signals>
|
|
<signal name="timeout">
|
|
<description>
|
|
Emitted when the Timer reaches 0.
|
|
</description>
|
|
</signal>
|
|
</signals>
|
|
<constants>
|
|
<constant name="TIMER_PROCESS_PHYSICS" value="0" enum="TimerProcessMode">
|
|
Update the Timer during the physics step at each frame (fixed framerate processing).
|
|
</constant>
|
|
<constant name="TIMER_PROCESS_IDLE" value="1" enum="TimerProcessMode">
|
|
Update the Timer during the idle time at each frame.
|
|
</constant>
|
|
</constants>
|
|
</class>
|