godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current upstream master branch

Browse Source
This commit is contained in:
Rémi Verschelde
2017-09-23 11:01:36 +02:00
parent 5e952ae7d5
commit 0cc4b36524
467 changed files with 5484 additions and 2561 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
classes/class_timer.rst
View File

@@ -1,5 +1,6 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. 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:
@@ -13,7 +14,7 @@ Timer
Brief Description
-----------------
A simple Timer node.
A countdown timer.
Member Functions
----------------
@@ -52,27 +53,27 @@ Signals
-------
- **timeout** **(** **)**
Emitted when the time runs out.
Emitted when the Timer reaches 0.
Member Variables
----------------
- :ref:`bool<class_bool>` **autostart**
- :ref:`bool<class_bool>` **one_shot**
- :ref:`int<class_int>` **process_mode**
- :ref:`float<class_float>` **wait_time**
- :ref:`bool<class_bool>` **autostart** - If [code]true[/code], Timer will automatically start when entering the scene tree. Default value: [code]false[/code].
- :ref:`bool<class_bool>` **one_shot** - If [code]true[/code], Timer will stop when reaching 0. If [code]false[/code], it will restart. Default value: [code]false[/code].
- :ref:`int<class_int>` **process_mode** - Processing mode. Uses TIMER_PROCESS_* constants as value.
- :ref:`float<class_float>` **wait_time** - Wait time in seconds.
Numeric Constants
-----------------
- **TIMER_PROCESS_FIXED** = **0** --- Update the timer at fixed intervals (framerate processing).
- **TIMER_PROCESS_IDLE** = **1** --- Update the timer during the idle time at each frame.
- **TIMER_PROCESS_FIXED** = **0** --- Update the Timer at fixed intervals (framerate processing).
- **TIMER_PROCESS_IDLE** = **1** --- Update the Timer during the idle time at each frame.
Description
-----------
Timer node. This is a simple node that will emit a timeout callback when the timer runs out. It can optionally be set to loop.
Counts down a specified interval and emits a signal on reaching 0. Can be set to repeat or "one shot" mode.
Member Function Description
---------------------------
@@ -151,12 +152,12 @@ Set wait time in seconds. When the time is over, it will emit the timeout signal
- void **start** **(** **)**
Start the timer.
Start the Timer.
.. _class_Timer_stop:
- void **stop** **(** **)**
Stop (cancel) the timer.
Stop (cancel) the Timer.