: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.xml.

.. _class_StagTest:

StagTest
========

**Experimental:** Fairly solidified, but changes may be made as seen fit.

**Inherits:** ``Node``

Singleton for handling unit and integration tests.

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

Properties
----------

.. table::
   :widths: auto

   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+
   | :ref:`Dictionary<class_Dictionary>`\[``String``, ``String``\]                    | :ref:`args<class_StagTest_property_args>`                                                       |                           |
   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+
   | ``Callable``                                                                     | :ref:`_quit_function<class_StagTest_property__quit_function>`                                   | ``_quit_default``         |
   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+
   | :ref:`StagLogger<class_StagLogger>`                                              | :ref:`_logger<class_StagTest_property__logger>`                                                 |                           |
   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+
   | :ref:`Dictionary<class_Dictionary>`\[``String``, ``Variant``\]                   | :ref:`statistics<class_StagTest_property_statistics>`                                           | ``{...}``                 |
   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+
   | :ref:`Dictionary<class_Dictionary>`\[``String``, ``Variant``\]                   | :ref:`test_data_default<class_StagTest_property_test_data_default>`                             | ``{...}``                 |
   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+
   | ``Dictionary``                                                                   | :ref:`test_data<class_StagTest_property_test_data>`                                             | ``<unknown>``             |
   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+
   | ``Dictionary``                                                                   | :ref:`_benchmarks<class_StagTest_property__benchmarks>`                                         | ``Dictionary()``          |
   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+
   | ``Dictionary``                                                                   | :ref:`_reports_benchmarks<class_StagTest_property__reports_benchmarks>`                         | ``Dictionary()``          |
   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+
   | ``float``                                                                        | :ref:`_time_scale_base<class_StagTest_property__time_scale_base>`                               | ``1.0``                   |
   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+
   | ``String``                                                                       | :ref:`_reports_path<class_StagTest_property__reports_path>`                                     | ``"res://test/reports/"`` |
   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+
   | ``PackedStringArray``                                                            | :ref:`tests<class_StagTest_property_tests>`                                                     | ``[]``                    |
   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+
   | ``PackedStringArray``                                                            | :ref:`test_failures<class_StagTest_property_test_failures>`                                     | ``[]``                    |
   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+
   | ``PackedStringArray``                                                            | :ref:`_test_suffixes<class_StagTest_property__test_suffixes>`                                   | ``[]``                    |
   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+
   | ``int``                                                                          | :ref:`test_idx<class_StagTest_property_test_idx>`                                               | ``0``                     |
   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+
   | ``String``                                                                       | :ref:`active_path<class_StagTest_property_active_path>`                                         | ``""``                    |
   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+
   | ``bool``                                                                         | :ref:`force_exiting<class_StagTest_property_force_exiting>`                                     | ``false``                 |
   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+
   | ``bool``                                                                         | :ref:`test_resulted<class_StagTest_property_test_resulted>`                                     | ``false``                 |
   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+
   | ``bool``                                                                         | :ref:`in_test<class_StagTest_property_in_test>`                                                 | ``false``                 |
   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+
   | :ref:`Array<class_Array>`\[:ref:`StagTest.TickTimer<class_StagTest_TickTimer>`\] | :ref:`_tick_timers_process<class_StagTest_property__tick_timers_process>`                       | ``[]``                    |
   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+
   | :ref:`Array<class_Array>`\[:ref:`StagTest.TickTimer<class_StagTest_TickTimer>`\] | :ref:`_tick_timers_physics_process<class_StagTest_property__tick_timers_physics_process>`       | ``[]``                    |
   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+
   | ``Mutex``                                                                        | :ref:`_tick_timers_process_mu<class_StagTest_property__tick_timers_process_mu>`                 | ``<unknown>``             |
   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+
   | ``Mutex``                                                                        | :ref:`_tick_timers_physics_process_mu<class_StagTest_property__tick_timers_physics_process_mu>` | ``<unknown>``             |
   +----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------+---------------------------+

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

Methods
-------

.. table::
   :widths: auto

   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`_init<class_StagTest_private_method__init>`\ (\ )                                                                                                     |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`_ready<class_StagTest_private_method__ready>`\ (\ )                                                                                                   |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`_exit_tree<class_StagTest_private_method__exit_tree>`\ (\ )                                                                                           |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`_begin<class_StagTest_private_method__begin>`\ (\ test_root\: ``String``\ )                                                                           |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | ``String``                                                      | :ref:`_join_path<class_StagTest_private_method__join_path>`\ (\ directory\: ``String``, relpath\: ``String``\ )                                             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`_print_rich<class_StagTest_private_method__print_rich>`\ (\ msg\: ``String``\ )                                                                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`_display_post_test_message<class_StagTest_private_method__display_post_test_message>`\ (\ )                                                           |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`_walk_directory<class_StagTest_private_method__walk_directory>`\ (\ dirpath\: ``String``\ )                                                           |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`_run_test<class_StagTest_private_method__run_test>`\ (\ filepath\: ``String``\ )                                                                      |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`_cleanup_test<class_StagTest_private_method__cleanup_test>`\ (\ )                                                                                     |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`_finish_test<class_StagTest_private_method__finish_test>`\ (\ )                                                                                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`_results<class_StagTest_private_method__results>`\ (\ )                                                                                               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`_exit<class_StagTest_private_method__exit>`\ (\ status\: ``int`` = 0\ )                                                                               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`_timeout<class_StagTest_private_method__timeout>`\ (\ timeout\: ``float``\ )                                                                          |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`_force_exit<class_StagTest_private_method__force_exit>`\ (\ reason\: ``String``\ )                                                                    |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`_pass_test_if_not_failed<class_StagTest_private_method__pass_test_if_not_failed>`\ (\ )                                                               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | ``bool``                                                        | :ref:`_has_failed<class_StagTest_private_method__has_failed>`\ (\ )                                                                                         |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | ``Variant``                                                     | :ref:`_format_assertion_message<class_StagTest_private_method__format_assertion_message>`\ (\ message\: ``String``\ )                                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | ``String``                                                      | :ref:`_format_assertion_value<class_StagTest_private_method__format_assertion_value>`\ (\ val\: ``Variant``\ )                                              |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | ``String``                                                      | :ref:`_format_duration<class_StagTest_private_method__format_duration>`\ (\ t\: ``float``\ )                                                                |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`_add_report<class_StagTest_private_method__add_report>`\ (\ reports_list\: ``Dictionary``, new_report\: ``Variant``, label\: ``String``\ )            |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`_output_reports<class_StagTest_private_method__output_reports>`\ (\ )                                                                                 |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | ``int``                                                         | :ref:`_ensure_directory<class_StagTest_private_method__ensure_directory>`\ (\ filepath\: ``String``\ )                                                      |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`_quit_default<class_StagTest_private_method__quit_default>`\ (\ status\: ``int``\ )                                                                   |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`_process<class_StagTest_private_method__process>`\ (\ _delta\: ``float``\ )                                                                           |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`_physics_process<class_StagTest_private_method__physics_process>`\ (\ _delta\: ``float``\ )                                                           |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`_catch_error<class_StagTest_private_method__catch_error>`\ (\ message\: ``String``\ )                                                                 |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`override_exit_function<class_StagTest_method_override_exit_function>`\ (\ new_quit\: ``Callable``\ )                                                  |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | ``bool``                                                        | :ref:`is_active<class_StagTest_method_is_active>`\ (\ )                                                                                                     |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | ``String``                                                      | :ref:`path<class_StagTest_method_path>`\ (\ )                                                                                                               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`pause<class_StagTest_method_pause>`\ (\ paused\: ``bool``\ )                                                                                          |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`time_scale<class_StagTest_method_time_scale>`\ (\ new_scale\: ``float`` = _time_scale_base\ )                                                         |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`teardown<class_StagTest_method_teardown>`\ (\ )                                                                                                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`skip<class_StagTest_method_skip>`\ (\ reason\: ``String``\ )                                                                                          |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`fail<class_StagTest_method_fail>`\ (\ reason\: ``String``\ )                                                                                          |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`assert_true<class_StagTest_method_assert_true>`\ (\ value\: ``bool``, message\: ``String`` = ""\ )                                                    |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`assert_equal<class_StagTest_method_assert_equal>`\ (\ a\: ``Variant``, b\: ``Variant``, message\: ``String`` = ""\ )                                  |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`assert_unequal<class_StagTest_method_assert_unequal>`\ (\ a\: ``Variant``, b\: ``Variant``, message\: ``String`` = ""\ )                              |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`assert_valid<class_StagTest_method_assert_valid>`\ (\ a\: ``Object``, message\: ``String`` = ""\ )                                                    |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`assert_approx_equal<class_StagTest_method_assert_approx_equal>`\ (\ a\: ``Variant``, b\: ``Variant``, message\: ``String`` = ""\ )                    |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                          | :ref:`assert_in_delta<class_StagTest_method_assert_in_delta>`\ (\ a\: ``Variant``, b\: ``Variant``, delta\: ``float`` = 1e-05, message\: ``String`` = ""\ ) |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`StagTest.SignalExpector<class_StagTest_SignalExpector>`   | :ref:`signal_expector<class_StagTest_method_signal_expector>`\ (\ emitter\: ``Signal``, message\: ``String`` = ""\ )                                        |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | ``Signal``                                                      | :ref:`tick_timer_process<class_StagTest_method_tick_timer_process>`\ (\ ticks\: ``int``\ )                                                                  |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | ``Signal``                                                      | :ref:`tick_timer_physics_process<class_StagTest_method_tick_timer_physics_process>`\ (\ ticks\: ``int``\ )                                                  |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`StagTest.BenchmarkResult<class_StagTest_BenchmarkResult>` | :ref:`benchmark<class_StagTest_method_benchmark>`\ (\ f\: ``Callable``, count\: ``int``, label\: ``String``, timeout\: ``float`` = -1.0\ )                  |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

----

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

Signals
-------

.. _class_StagTest_signal_test_post_ready:

.. rst-class:: classref-signal

**test_post_ready**\ (\ ) :ref:`🔗<class_StagTest_signal_test_post_ready>`

Called just after beginning a test.

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

----

.. _class_StagTest_signal_tick_process:

.. rst-class:: classref-signal

**tick_process**\ (\ ) :ref:`🔗<class_StagTest_signal_tick_process>`

Emitted at the beginning of each process tick during the test.

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

----

.. _class_StagTest_signal_tick_physics_process:

.. rst-class:: classref-signal

**tick_physics_process**\ (\ ) :ref:`🔗<class_StagTest_signal_tick_physics_process>`

Emitted at the beginning of each physics process tick during the test.

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

----

.. _class_StagTest_signal_internal_tick_process_list_ready:

.. rst-class:: classref-signal

**internal_tick_process_list_ready**\ (\ ) :ref:`🔗<class_StagTest_signal_internal_tick_process_list_ready>`

.. container:: contribute

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

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

----

.. _class_StagTest_signal_internal_tick_physics_process_list_ready:

.. rst-class:: classref-signal

**internal_tick_physics_process_list_ready**\ (\ ) :ref:`🔗<class_StagTest_signal_internal_tick_physics_process_list_ready>`

.. container:: contribute

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

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

----

.. _class_StagTest_signal_test_pre_exit:

.. rst-class:: classref-signal

**test_pre_exit**\ (\ ) :ref:`🔗<class_StagTest_signal_test_pre_exit>`

Called just before exiting a test.

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

----

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

Enumerations
------------

.. _enum_StagTest_ExitCodes:

.. rst-class:: classref-enumeration

enum **ExitCodes**: :ref:`🔗<enum_StagTest_ExitCodes>`

.. _class_StagTest_constant_Ok:

.. rst-class:: classref-enumeration-constant

:ref:`ExitCodes<enum_StagTest_ExitCodes>` **Ok** = ``0``

.. container:: contribute

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



.. _class_StagTest_constant_Failed:

.. rst-class:: classref-enumeration-constant

:ref:`ExitCodes<enum_StagTest_ExitCodes>` **Failed** = ``1``

.. container:: contribute

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



.. _class_StagTest_constant_BadFile:

.. rst-class:: classref-enumeration-constant

:ref:`ExitCodes<enum_StagTest_ExitCodes>` **BadFile** = ``15``

.. container:: contribute

	There is currently no description for this enum. 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

Constants
---------

.. _class_StagTest_constant_DEFAULT_TEST_PATH:

.. rst-class:: classref-constant

**DEFAULT_TEST_PATH** = ``"res://test/scenarios/"`` :ref:`🔗<class_StagTest_constant_DEFAULT_TEST_PATH>`

.. container:: contribute

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



.. _class_StagTest_constant_DEFAULT_BENCHMARK_PATH:

.. rst-class:: classref-constant

**DEFAULT_BENCHMARK_PATH** = ``"res://test/benchmarks/"`` :ref:`🔗<class_StagTest_constant_DEFAULT_BENCHMARK_PATH>`

.. container:: contribute

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



.. _class_StagTest_constant_DEFAULT_REPORTS_PATH:

.. rst-class:: classref-constant

**DEFAULT_REPORTS_PATH** = ``"res://test/reports/"`` :ref:`🔗<class_StagTest_constant_DEFAULT_REPORTS_PATH>`

.. container:: contribute

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



.. _class_StagTest_constant_DEFAULT_SUFFIXES:

.. rst-class:: classref-constant

**DEFAULT_SUFFIXES** = ``".tscn,.scn"`` :ref:`🔗<class_StagTest_constant_DEFAULT_SUFFIXES>`

.. container:: contribute

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



.. _class_StagTest_constant_DEFAULT_TIMEOUT:

.. rst-class:: classref-constant

**DEFAULT_TIMEOUT** = ``30.0`` :ref:`🔗<class_StagTest_constant_DEFAULT_TIMEOUT>`

.. container:: contribute

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



.. _class_StagTest_constant_DEFAULT_TIME_SCALE:

.. rst-class:: classref-constant

**DEFAULT_TIME_SCALE** = ``1.0`` :ref:`🔗<class_StagTest_constant_DEFAULT_TIME_SCALE>`

.. container:: contribute

	There is currently no description for this constant. 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

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

.. _class_StagTest_property_args:

.. rst-class:: classref-property

:ref:`Dictionary<class_Dictionary>`\[``String``, ``String``\] **args** :ref:`🔗<class_StagTest_property_args>`

.. 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-item-separator

----

.. _class_StagTest_property__quit_function:

.. rst-class:: classref-property

``Callable`` **_quit_function** = ``_quit_default`` :ref:`🔗<class_StagTest_property__quit_function>`

.. 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-item-separator

----

.. _class_StagTest_property__logger:

.. rst-class:: classref-property

:ref:`StagLogger<class_StagLogger>` **_logger** :ref:`🔗<class_StagTest_property__logger>`

.. 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-item-separator

----

.. _class_StagTest_property_statistics:

.. rst-class:: classref-property

:ref:`Dictionary<class_Dictionary>`\[``String``, ``Variant``\] **statistics** = ``{...}`` :ref:`🔗<class_StagTest_property_statistics>`

.. 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-item-separator

----

.. _class_StagTest_property_test_data_default:

.. rst-class:: classref-property

:ref:`Dictionary<class_Dictionary>`\[``String``, ``Variant``\] **test_data_default** = ``{...}`` :ref:`🔗<class_StagTest_property_test_data_default>`

.. 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-item-separator

----

.. _class_StagTest_property_test_data:

.. rst-class:: classref-property

``Dictionary`` **test_data** = ``<unknown>`` :ref:`🔗<class_StagTest_property_test_data>`

.. 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-item-separator

----

.. _class_StagTest_property__benchmarks:

.. rst-class:: classref-property

``Dictionary`` **_benchmarks** = ``Dictionary()`` :ref:`🔗<class_StagTest_property__benchmarks>`

.. 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-item-separator

----

.. _class_StagTest_property__reports_benchmarks:

.. rst-class:: classref-property

``Dictionary`` **_reports_benchmarks** = ``Dictionary()`` :ref:`🔗<class_StagTest_property__reports_benchmarks>`

.. 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-item-separator

----

.. _class_StagTest_property__time_scale_base:

.. rst-class:: classref-property

``float`` **_time_scale_base** = ``1.0`` :ref:`🔗<class_StagTest_property__time_scale_base>`

.. 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-item-separator

----

.. _class_StagTest_property__reports_path:

.. rst-class:: classref-property

``String`` **_reports_path** = ``"res://test/reports/"`` :ref:`🔗<class_StagTest_property__reports_path>`

.. 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-item-separator

----

.. _class_StagTest_property_tests:

.. rst-class:: classref-property

``PackedStringArray`` **tests** = ``[]`` :ref:`🔗<class_StagTest_property_tests>`

.. 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>`__!

**Note:** The returned array is *copied* and any changes to it will not update the original property value. See ``PackedStringArray`` for more details.

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

----

.. _class_StagTest_property_test_failures:

.. rst-class:: classref-property

``PackedStringArray`` **test_failures** = ``[]`` :ref:`🔗<class_StagTest_property_test_failures>`

.. 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>`__!

**Note:** The returned array is *copied* and any changes to it will not update the original property value. See ``PackedStringArray`` for more details.

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

----

.. _class_StagTest_property__test_suffixes:

.. rst-class:: classref-property

``PackedStringArray`` **_test_suffixes** = ``[]`` :ref:`🔗<class_StagTest_property__test_suffixes>`

.. 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>`__!

**Note:** The returned array is *copied* and any changes to it will not update the original property value. See ``PackedStringArray`` for more details.

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

----

.. _class_StagTest_property_test_idx:

.. rst-class:: classref-property

``int`` **test_idx** = ``0`` :ref:`🔗<class_StagTest_property_test_idx>`

.. 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-item-separator

----

.. _class_StagTest_property_active_path:

.. rst-class:: classref-property

``String`` **active_path** = ``""`` :ref:`🔗<class_StagTest_property_active_path>`

.. 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-item-separator

----

.. _class_StagTest_property_force_exiting:

.. rst-class:: classref-property

``bool`` **force_exiting** = ``false`` :ref:`🔗<class_StagTest_property_force_exiting>`

.. 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-item-separator

----

.. _class_StagTest_property_test_resulted:

.. rst-class:: classref-property

``bool`` **test_resulted** = ``false`` :ref:`🔗<class_StagTest_property_test_resulted>`

.. 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-item-separator

----

.. _class_StagTest_property_in_test:

.. rst-class:: classref-property

``bool`` **in_test** = ``false`` :ref:`🔗<class_StagTest_property_in_test>`

.. 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-item-separator

----

.. _class_StagTest_property__tick_timers_process:

.. rst-class:: classref-property

:ref:`Array<class_Array>`\[:ref:`StagTest.TickTimer<class_StagTest_TickTimer>`\] **_tick_timers_process** = ``[]`` :ref:`🔗<class_StagTest_property__tick_timers_process>`

.. 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-item-separator

----

.. _class_StagTest_property__tick_timers_physics_process:

.. rst-class:: classref-property

:ref:`Array<class_Array>`\[:ref:`StagTest.TickTimer<class_StagTest_TickTimer>`\] **_tick_timers_physics_process** = ``[]`` :ref:`🔗<class_StagTest_property__tick_timers_physics_process>`

.. 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-item-separator

----

.. _class_StagTest_property__tick_timers_process_mu:

.. rst-class:: classref-property

``Mutex`` **_tick_timers_process_mu** = ``<unknown>`` :ref:`🔗<class_StagTest_property__tick_timers_process_mu>`

.. 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-item-separator

----

.. _class_StagTest_property__tick_timers_physics_process_mu:

.. rst-class:: classref-property

``Mutex`` **_tick_timers_physics_process_mu** = ``<unknown>`` :ref:`🔗<class_StagTest_property__tick_timers_physics_process_mu>`

.. 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_private_method__init:

.. rst-class:: classref-method

|void| **_init**\ (\ ) :ref:`🔗<class_StagTest_private_method__init>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__ready:

.. rst-class:: classref-method

|void| **_ready**\ (\ ) :ref:`🔗<class_StagTest_private_method__ready>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__exit_tree:

.. rst-class:: classref-method

|void| **_exit_tree**\ (\ ) :ref:`🔗<class_StagTest_private_method__exit_tree>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__begin:

.. rst-class:: classref-method

|void| **_begin**\ (\ test_root\: ``String``\ ) :ref:`🔗<class_StagTest_private_method__begin>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__join_path:

.. rst-class:: classref-method

``String`` **_join_path**\ (\ directory\: ``String``, relpath\: ``String``\ ) :ref:`🔗<class_StagTest_private_method__join_path>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__print_rich:

.. rst-class:: classref-method

|void| **_print_rich**\ (\ msg\: ``String``\ ) :ref:`🔗<class_StagTest_private_method__print_rich>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__display_post_test_message:

.. rst-class:: classref-method

|void| **_display_post_test_message**\ (\ ) :ref:`🔗<class_StagTest_private_method__display_post_test_message>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__walk_directory:

.. rst-class:: classref-method

|void| **_walk_directory**\ (\ dirpath\: ``String``\ ) :ref:`🔗<class_StagTest_private_method__walk_directory>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__run_test:

.. rst-class:: classref-method

|void| **_run_test**\ (\ filepath\: ``String``\ ) :ref:`🔗<class_StagTest_private_method__run_test>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__cleanup_test:

.. rst-class:: classref-method

|void| **_cleanup_test**\ (\ ) :ref:`🔗<class_StagTest_private_method__cleanup_test>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__finish_test:

.. rst-class:: classref-method

|void| **_finish_test**\ (\ ) :ref:`🔗<class_StagTest_private_method__finish_test>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__results:

.. rst-class:: classref-method

|void| **_results**\ (\ ) :ref:`🔗<class_StagTest_private_method__results>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__exit:

.. rst-class:: classref-method

|void| **_exit**\ (\ status\: ``int`` = 0\ ) :ref:`🔗<class_StagTest_private_method__exit>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__timeout:

.. rst-class:: classref-method

|void| **_timeout**\ (\ timeout\: ``float``\ ) :ref:`🔗<class_StagTest_private_method__timeout>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__force_exit:

.. rst-class:: classref-method

|void| **_force_exit**\ (\ reason\: ``String``\ ) :ref:`🔗<class_StagTest_private_method__force_exit>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__pass_test_if_not_failed:

.. rst-class:: classref-method

|void| **_pass_test_if_not_failed**\ (\ ) :ref:`🔗<class_StagTest_private_method__pass_test_if_not_failed>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__has_failed:

.. rst-class:: classref-method

``bool`` **_has_failed**\ (\ ) :ref:`🔗<class_StagTest_private_method__has_failed>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__format_assertion_message:

.. rst-class:: classref-method

``Variant`` **_format_assertion_message**\ (\ message\: ``String``\ ) :ref:`🔗<class_StagTest_private_method__format_assertion_message>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__format_assertion_value:

.. rst-class:: classref-method

``String`` **_format_assertion_value**\ (\ val\: ``Variant``\ ) :ref:`🔗<class_StagTest_private_method__format_assertion_value>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__format_duration:

.. rst-class:: classref-method

``String`` **_format_duration**\ (\ t\: ``float``\ ) :ref:`🔗<class_StagTest_private_method__format_duration>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__add_report:

.. rst-class:: classref-method

|void| **_add_report**\ (\ reports_list\: ``Dictionary``, new_report\: ``Variant``, label\: ``String``\ ) :ref:`🔗<class_StagTest_private_method__add_report>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__output_reports:

.. rst-class:: classref-method

|void| **_output_reports**\ (\ ) :ref:`🔗<class_StagTest_private_method__output_reports>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__ensure_directory:

.. rst-class:: classref-method

``int`` **_ensure_directory**\ (\ filepath\: ``String``\ ) :ref:`🔗<class_StagTest_private_method__ensure_directory>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__quit_default:

.. rst-class:: classref-method

|void| **_quit_default**\ (\ status\: ``int``\ ) :ref:`🔗<class_StagTest_private_method__quit_default>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__process:

.. rst-class:: classref-method

|void| **_process**\ (\ _delta\: ``float``\ ) :ref:`🔗<class_StagTest_private_method__process>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__physics_process:

.. rst-class:: classref-method

|void| **_physics_process**\ (\ _delta\: ``float``\ ) :ref:`🔗<class_StagTest_private_method__physics_process>`

.. 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>`__!

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

----

.. _class_StagTest_private_method__catch_error:

.. rst-class:: classref-method

|void| **_catch_error**\ (\ message\: ``String``\ ) :ref:`🔗<class_StagTest_private_method__catch_error>`

.. 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>`__!

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

----

.. _class_StagTest_method_override_exit_function:

.. rst-class:: classref-method

|void| **override_exit_function**\ (\ new_quit\: ``Callable``\ ) :ref:`🔗<class_StagTest_method_override_exit_function>`

Overrides the runtime exit function, in case the game needs additional teardown steps.

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

----

.. _class_StagTest_method_is_active:

.. rst-class:: classref-method

``bool`` **is_active**\ (\ ) :ref:`🔗<class_StagTest_method_is_active>`

Returns true if StagTest is testing, in case the game needs to avoid certain setup steps.

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

----

.. _class_StagTest_method_path:

.. rst-class:: classref-method

``String`` **path**\ (\ ) :ref:`🔗<class_StagTest_method_path>`

Returns the path of the active test.

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

----

.. _class_StagTest_method_pause:

.. rst-class:: classref-method

|void| **pause**\ (\ paused\: ``bool``\ ) :ref:`🔗<class_StagTest_method_pause>`

Sets the pause of the scene tree.

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

----

.. _class_StagTest_method_time_scale:

.. rst-class:: classref-method

|void| **time_scale**\ (\ new_scale\: ``float`` = _time_scale_base\ ) :ref:`🔗<class_StagTest_method_time_scale>`

Sets the engine time scale.

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

----

.. _class_StagTest_method_teardown:

.. rst-class:: classref-method

|void| **teardown**\ (\ ) :ref:`🔗<class_StagTest_method_teardown>`

Puts the test into Teardown mode. If the test is not skipped or failed during Teardown, it passes.

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

----

.. _class_StagTest_method_skip:

.. rst-class:: classref-method

|void| **skip**\ (\ reason\: ``String``\ ) :ref:`🔗<class_StagTest_method_skip>`

Puts the test into Teardown mode (if not already), skipping the remainder of the test.

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

----

.. _class_StagTest_method_fail:

.. rst-class:: classref-method

|void| **fail**\ (\ reason\: ``String``\ ) :ref:`🔗<class_StagTest_method_fail>`

Puts the test into Teardown mode (if not already), marking the test as failed.

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

----

.. _class_StagTest_method_assert_true:

.. rst-class:: classref-method

|void| **assert_true**\ (\ value\: ``bool``, message\: ``String`` = ""\ ) :ref:`🔗<class_StagTest_method_assert_true>`

Assert that a given boolean is true.

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

----

.. _class_StagTest_method_assert_equal:

.. rst-class:: classref-method

|void| **assert_equal**\ (\ a\: ``Variant``, b\: ``Variant``, message\: ``String`` = ""\ ) :ref:`🔗<class_StagTest_method_assert_equal>`

Assert that two values are equal.

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

----

.. _class_StagTest_method_assert_unequal:

.. rst-class:: classref-method

|void| **assert_unequal**\ (\ a\: ``Variant``, b\: ``Variant``, message\: ``String`` = ""\ ) :ref:`🔗<class_StagTest_method_assert_unequal>`

Assert that two values are NOT equal.

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

----

.. _class_StagTest_method_assert_valid:

.. rst-class:: classref-method

|void| **assert_valid**\ (\ a\: ``Object``, message\: ``String`` = ""\ ) :ref:`🔗<class_StagTest_method_assert_valid>`

Assert that the given instance is valid.

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

----

.. _class_StagTest_method_assert_approx_equal:

.. rst-class:: classref-method

|void| **assert_approx_equal**\ (\ a\: ``Variant``, b\: ``Variant``, message\: ``String`` = ""\ ) :ref:`🔗<class_StagTest_method_assert_approx_equal>`

Assert that two values are equal within an epsilon value, that scales with magnitude.

\ **Note**: to use a specific delta threshold value, use ``StagTest.assert_in_delta(...)`` instead.

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

----

.. _class_StagTest_method_assert_in_delta:

.. rst-class:: classref-method

|void| **assert_in_delta**\ (\ a\: ``Variant``, b\: ``Variant``, delta\: ``float`` = 1e-05, message\: ``String`` = ""\ ) :ref:`🔗<class_StagTest_method_assert_in_delta>`

Assert that two values are equal, within a threshold amount. Use ``StagTest.assert_approx_equal()`` if the delta must scale with magnitude.



For floating-point vectors, the overall distance between vectors is compared. For integer vectors, Manhattan distance is used instead.

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

----

.. _class_StagTest_method_signal_expector:

.. rst-class:: classref-method

:ref:`StagTest.SignalExpector<class_StagTest_SignalExpector>` **signal_expector**\ (\ emitter\: ``Signal``, message\: ``String`` = ""\ ) :ref:`🔗<class_StagTest_method_signal_expector>`

Creates a :ref:`StagTest.SignalExpector<class_StagTest_SignalExpector>` from the given signal, which can be used for further assertions. The :ref:`StagTest.SignalExpector<class_StagTest_SignalExpector>` is thread-safe. Fails the test if the signal is null, or if the signal could not be connected.

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

----

.. _class_StagTest_method_tick_timer_process:

.. rst-class:: classref-method

``Signal`` **tick_timer_process**\ (\ ticks\: ``int``\ ) :ref:`🔗<class_StagTest_method_tick_timer_process>`

Returns a signal that emits after the given amount of process ticks. If ``ticks`` is less than or equal to zero, the signal emits on the next process tick. 

::

    await StagTest.tick_timer_process(10) # Wait 10 ticks
    # Resumes coroutine at the very beginning of tick 10 before anything else processes
    StagTest.assert_equal(10, process_ticks_stagtest, "awaited 10 process ticks")
    StagTest.assert_equal(9, process_ticks_node, "nodes are just about to process tick 10")

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

----

.. _class_StagTest_method_tick_timer_physics_process:

.. rst-class:: classref-method

``Signal`` **tick_timer_physics_process**\ (\ ticks\: ``int``\ ) :ref:`🔗<class_StagTest_method_tick_timer_physics_process>`

Returns a signal that emits after the given amount of physics process ticks. If ``ticks`` is less than or equal to zero, the signal emits on the next physics tick. 

::

    await StagTest.tick_timer_physics_process(10) # Wait 10 ticks
    # Resumes coroutine at the very beginning of tick 10 before anything else processes
    StagTest.assert_equal(10, physics_ticks_stagtest, "awaited 10 process ticks")
    StagTest.assert_equal(9, physics_ticks_node, "nodes are just about to process tick 10")

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

----

.. _class_StagTest_method_benchmark:

.. rst-class:: classref-method

:ref:`StagTest.BenchmarkResult<class_StagTest_BenchmarkResult>` **benchmark**\ (\ f\: ``Callable``, count\: ``int``, label\: ``String``, timeout\: ``float`` = -1.0\ ) :ref:`🔗<class_StagTest_method_benchmark>`

**Experimental:** This method may be changed or removed in future versions.

Performs a timing benchmark of the Callable (with no arguments) the specified number of times, returning an analysis.

If timeout is greater than zero, forcibly stops benchmark after X many seconds. If a test is skipped or failed during the benchmark, the benchmark exits without completing all iterations.

Results are always in microseconds, unless otherwise specified.

Use the ``--bench`` flag when running to output benchmark results.



\ **Note**: Requires the compiled Rust backend.

.. |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.)`