classref: Sync with current 3.4 branch

This commit is contained in:
Rémi Verschelde
2021-11-19 10:05:42 +01:00
parent 2864ab4f65
commit 9060c28080
683 changed files with 8789 additions and 2973 deletions

View File

@@ -1,6 +1,6 @@
:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. Generated automatically by doc/tools/make_rst.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.
@@ -23,7 +23,7 @@ Counts down a specified interval and emits a signal on reaching 0. Can be set to
Tutorials
---------
- `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`_
- `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`__
Properties
----------
@@ -170,7 +170,9 @@ The timer's remaining time in seconds. Returns 0 if the timer is inactive.
| *Getter* | get_wait_time() |
+-----------+----------------------+
Wait time in seconds.
The wait time in seconds.
**Note:** Timers can only emit once per rendered frame at most (or once per physics frame if :ref:`process_mode<class_Timer_property_process_mode>` is :ref:`TIMER_PROCESS_PHYSICS<class_Timer_constant_TIMER_PROCESS_PHYSICS>`). This means very low wait times (lower than 0.05 seconds) will behave in significantly different ways depending on the rendered framerate. For very low wait times, it is recommended to use a process loop in a script instead of using a Timer node.
Method Descriptions
-------------------
@@ -189,7 +191,7 @@ Returns ``true`` if the timer is stopped.
Starts the timer. Sets ``wait_time`` to ``time_sec`` if ``time_sec > 0``. This also resets the remaining time to ``wait_time``.
**Note:** this method will not resume a paused timer. See :ref:`paused<class_Timer_property_paused>`.
**Note:** This method will not resume a paused timer. See :ref:`paused<class_Timer_property_paused>`.
----