:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/stag-toolkit/sphinx/gen/gdscript/StagTest.TickTimer.xml.

.. _class_StagTest_TickTimer:

StagTest.TickTimer
==================

**Inherits:** ``RefCounted``

Testing class for awaiting process/physics_process ticks.

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +---------+-------------------------------------------------------------------+-------+
   | ``int`` | :ref:`_wait_ticks<class_StagTest_TickTimer_property__wait_ticks>` | ``0`` |
   +---------+-------------------------------------------------------------------+-------+

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
   :widths: auto

   +----------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | ``bool`` | :ref:`_decrement<class_StagTest_TickTimer_private_method__decrement>`\ (\ t\: :ref:`StagTest.TickTimer<class_StagTest_TickTimer>`, wait_until\: ``Signal``\ ) |static| |
   +----------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | ``int``  | :ref:`ticks_left<class_StagTest_TickTimer_method_ticks_left>`\ (\ )                                                                                                    |
   +----------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | ``bool`` | :ref:`keep<class_StagTest_TickTimer_method_keep>`\ (\ t\: :ref:`StagTest.TickTimer<class_StagTest_TickTimer>`\ ) |static|                                              |
   +----------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Signals
-------

.. _class_StagTest_TickTimer_signal_done:

.. rst-class:: classref-signal

**done**\ (\ ) :ref:`🔗<class_StagTest_TickTimer_signal_done>`

Emitted after the specified wait ticks have passed.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_StagTest_TickTimer_property__wait_ticks:

.. rst-class:: classref-property

``int`` **_wait_ticks** = ``0`` :ref:`🔗<class_StagTest_TickTimer_property__wait_ticks>`

.. container:: contribute

	There is currently no description for this property. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Method Descriptions
-------------------

.. _class_StagTest_TickTimer_private_method__decrement:

.. rst-class:: classref-method

``bool`` **_decrement**\ (\ t\: :ref:`StagTest.TickTimer<class_StagTest_TickTimer>`, wait_until\: ``Signal``\ ) |static| :ref:`🔗<class_StagTest_TickTimer_private_method__decrement>`

Decreases the wait tick count by 1, and emits upon reaching zero ticks. Returns true if still waiting on ticks.

.. rst-class:: classref-item-separator

----

.. _class_StagTest_TickTimer_method_ticks_left:

.. rst-class:: classref-method

``int`` **ticks_left**\ (\ ) :ref:`🔗<class_StagTest_TickTimer_method_ticks_left>`

Returns the number of wait ticks left.

.. rst-class:: classref-item-separator

----

.. _class_StagTest_TickTimer_method_keep:

.. rst-class:: classref-method

``bool`` **keep**\ (\ t\: :ref:`StagTest.TickTimer<class_StagTest_TickTimer>`\ ) |static| :ref:`🔗<class_StagTest_TickTimer_method_keep>`

.. container:: contribute

	There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`