mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 23:28:59 +00:00
115 lines
3.8 KiB
ReStructuredText
115 lines
3.8 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the Timer.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_Timer:
|
|
|
|
Timer
|
|
=====
|
|
|
|
**Inherits:** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
A countdown timer.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+----------------------------+--------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_time_left<class_Timer_get_time_left>` **(** **)** const |
|
|
+----------------------------+--------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_paused<class_Timer_is_paused>` **(** **)** const |
|
|
+----------------------------+--------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_stopped<class_Timer_is_stopped>` **(** **)** const |
|
|
+----------------------------+--------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_paused<class_Timer_set_paused>` **(** :ref:`bool<class_bool>` paused **)** |
|
|
+----------------------------+--------------------------------------------------------------------------------------+
|
|
| void | :ref:`start<class_Timer_start>` **(** **)** |
|
|
+----------------------------+--------------------------------------------------------------------------------------+
|
|
| void | :ref:`stop<class_Timer_stop>` **(** **)** |
|
|
+----------------------------+--------------------------------------------------------------------------------------+
|
|
|
|
Signals
|
|
-------
|
|
|
|
.. _class_Timer_timeout:
|
|
|
|
- **timeout** **(** **)**
|
|
|
|
Emitted when the Timer reaches 0.
|
|
|
|
|
|
Member Variables
|
|
----------------
|
|
|
|
.. _class_Timer_autostart:
|
|
|
|
- :ref:`bool<class_bool>` **autostart** - If ``true``, Timer will automatically start when entering the scene tree. Default value: ``false``.
|
|
|
|
.. _class_Timer_one_shot:
|
|
|
|
- :ref:`bool<class_bool>` **one_shot** - If ``true``, Timer will stop when reaching 0. If ``false``, it will restart. Default value: ``false``.
|
|
|
|
.. _class_Timer_process_mode:
|
|
|
|
- :ref:`int<class_int>` **process_mode** - Processing mode. Uses TIMER_PROCESS\_\* constants as value.
|
|
|
|
.. _class_Timer_wait_time:
|
|
|
|
- :ref:`float<class_float>` **wait_time** - Wait time in seconds.
|
|
|
|
|
|
Numeric Constants
|
|
-----------------
|
|
|
|
- **TIMER_PROCESS_PHYSICS** = **0** --- Update the Timer during the physics step at each frame (fixed framerate processing).
|
|
- **TIMER_PROCESS_IDLE** = **1** --- Update the Timer during the idle time at each frame.
|
|
|
|
Description
|
|
-----------
|
|
|
|
Counts down a specified interval and emits a signal on reaching 0. Can be set to repeat or "one shot" mode.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_Timer_get_time_left:
|
|
|
|
- :ref:`float<class_float>` **get_time_left** **(** **)** const
|
|
|
|
Return the time left for timeout in seconds if the timer is active, 0 otherwise.
|
|
|
|
.. _class_Timer_is_paused:
|
|
|
|
- :ref:`bool<class_bool>` **is_paused** **(** **)** const
|
|
|
|
Return if the timer is paused or not.
|
|
|
|
.. _class_Timer_is_stopped:
|
|
|
|
- :ref:`bool<class_bool>` **is_stopped** **(** **)** const
|
|
|
|
.. _class_Timer_set_paused:
|
|
|
|
- void **set_paused** **(** :ref:`bool<class_bool>` paused **)**
|
|
|
|
Set whether the timer is paused or not. A paused timer will be inactive until it is unpaused again.
|
|
|
|
.. _class_Timer_start:
|
|
|
|
- void **start** **(** **)**
|
|
|
|
Start the Timer.
|
|
|
|
.. _class_Timer_stop:
|
|
|
|
- void **stop** **(** **)**
|
|
|
|
Stop (cancel) the Timer.
|
|
|
|
|