285 lines
14 KiB
ReStructuredText
285 lines
14 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from GUT Plugin sources.
|
|
.. Generator: documentation/godot_make_rst.py.
|
|
.. _class_GutTrackedError:
|
|
|
|
GutTrackedError
|
|
===============
|
|
|
|
**Inherits:** `RefCounted <https://docs.godotengine.org/en/stable/classes/class_refcounted.html>`_
|
|
|
|
This contains all the information provided by Godot about an error. This is also used to represent a GUT error. See `Logger <https://docs.godotengine.org/en/stable/classes/class_logger.html>`_ for additional information about properties. Some properties are not populated for GUT errors.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+--------------------------------------------------------------------------------+--------------------------------------------------------------------+------------+
|
|
| `Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ | :ref:`backtrace<class_GutTrackedError_property_backtrace>` | ``[]`` |
|
|
+--------------------------------------------------------------------------------+--------------------------------------------------------------------+------------+
|
|
| `Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ | :ref:`code<class_GutTrackedError_property_code>` | ``"NONE"`` |
|
|
+--------------------------------------------------------------------------------+--------------------------------------------------------------------+------------+
|
|
| `Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ | :ref:`rationale<class_GutTrackedError_property_rationale>` | ``"NONE"`` |
|
|
+--------------------------------------------------------------------------------+--------------------------------------------------------------------+------------+
|
|
| `Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ | :ref:`error_type<class_GutTrackedError_property_error_type>` | ``-1`` |
|
|
+--------------------------------------------------------------------------------+--------------------------------------------------------------------+------------+
|
|
| `Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ | :ref:`editor_notify<class_GutTrackedError_property_editor_notify>` | ``false`` |
|
|
+--------------------------------------------------------------------------------+--------------------------------------------------------------------+------------+
|
|
| `Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ | :ref:`file<class_GutTrackedError_property_file>` | ``"NONE"`` |
|
|
+--------------------------------------------------------------------------------+--------------------------------------------------------------------+------------+
|
|
| `Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ | :ref:`function<class_GutTrackedError_property_function>` | ``"NONE"`` |
|
|
+--------------------------------------------------------------------------------+--------------------------------------------------------------------+------------+
|
|
| `Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ | :ref:`line<class_GutTrackedError_property_line>` | ``-1`` |
|
|
+--------------------------------------------------------------------------------+--------------------------------------------------------------------+------------+
|
|
| `Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ | :ref:`handled<class_GutTrackedError_property_handled>` | ``false`` |
|
|
+--------------------------------------------------------------------------------+--------------------------------------------------------------------+------------+
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Methods
|
|
-------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
|
|
| `Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ | :ref:`contains_text<class_GutTrackedError_method_contains_text>`\ (\ text\ ) |
|
|
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
|
|
| `Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ | :ref:`get_error_type_name<class_GutTrackedError_method_get_error_type_name>`\ (\ ) |
|
|
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
|
|
| `Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ | :ref:`is_engine_error<class_GutTrackedError_method_is_engine_error>`\ (\ ) |
|
|
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
|
|
| `Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ | :ref:`is_gut_error<class_GutTrackedError_method_is_gut_error>`\ (\ ) |
|
|
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
|
|
| `Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ | :ref:`is_push_error<class_GutTrackedError_method_is_push_error>`\ (\ ) |
|
|
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
|
|
| `Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ | :ref:`is_push_warning<class_GutTrackedError_method_is_push_warning>`\ (\ ) |
|
|
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
|
|
| `String <https://docs.godotengine.org/en/stable/classes/class_string.html>`_ | :ref:`to_s<class_GutTrackedError_method_to_s>`\ (\ ) |
|
|
+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_GutTrackedError_property_backtrace:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
`Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ **backtrace** = ``[]`` :ref:`🔗<class_GutTrackedError_property_backtrace>`
|
|
|
|
This will be an ``Array[ScriptBacktrace]`` for engine/push errors. This will the result of ``get_stack`` for GUT errors.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_GutTrackedError_property_code:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
`Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ **code** = ``"NONE"`` :ref:`🔗<class_GutTrackedError_property_code>`
|
|
|
|
Usually the description
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_GutTrackedError_property_rationale:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
`Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ **rationale** = ``"NONE"`` :ref:`🔗<class_GutTrackedError_property_rationale>`
|
|
|
|
.. container:: contribute
|
|
|
|
No description
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_GutTrackedError_property_error_type:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
`Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ **error_type** = ``-1`` :ref:`🔗<class_GutTrackedError_property_error_type>`
|
|
|
|
`Logger.ErrorType <https://docs.godotengine.org/en/stable/classes/class_logger.html>`_ value or, for GUT errors, this will be ``GutUtils.GUT_ERROR_TYPE``.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_GutTrackedError_property_editor_notify:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
`Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ **editor_notify** = ``false`` :ref:`🔗<class_GutTrackedError_property_editor_notify>`
|
|
|
|
.. container:: contribute
|
|
|
|
No description
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_GutTrackedError_property_file:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
`Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ **file** = ``"NONE"`` :ref:`🔗<class_GutTrackedError_property_file>`
|
|
|
|
The full path to the file where the error occurred.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_GutTrackedError_property_function:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
`Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ **function** = ``"NONE"`` :ref:`🔗<class_GutTrackedError_property_function>`
|
|
|
|
The function name in :ref:`file<class_GutTrackedError_property_file>` where the error occurred.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_GutTrackedError_property_line:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
`Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ **line** = ``-1`` :ref:`🔗<class_GutTrackedError_property_line>`
|
|
|
|
The line number in :ref:`file<class_GutTrackedError_property_file>`
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_GutTrackedError_property_handled:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
`Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ **handled** = ``false`` :ref:`🔗<class_GutTrackedError_property_handled>`
|
|
|
|
Used by GUT to flag errors as being handled. This is set by various asserts or can be set in a test. When set to ``true`` GUT will ignore it when determining if an unexpected error occurred during the execution of the test. Setting this value prior to performing any of the error related asserts may have unexpected results. It is recommended you either set this manually or use the error asserts.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_GutTrackedError_method_to_s:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
`String <https://docs.godotengine.org/en/stable/classes/class_string.html>`_ **to_s**\ (\ ) :ref:`🔗<class_GutTrackedError_method_to_s>`
|
|
|
|
_to_string that is not _to_string.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_GutTrackedError_method_is_push_error:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
`Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ **is_push_error**\ (\ ) :ref:`🔗<class_GutTrackedError_method_is_push_error>`
|
|
|
|
Returns ``true`` if the error is a push_error.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_GutTrackedError_method_is_engine_error:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
`Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ **is_engine_error**\ (\ ) :ref:`🔗<class_GutTrackedError_method_is_engine_error>`
|
|
|
|
Returns ``true`` if the error is an engine error. This includes all errors that pass through the `Logger <https://docs.godotengine.org/en/stable/classes/class_logger.html>`_ that do not originate from the ``push_error`` function.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_GutTrackedError_method_is_push_warning:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
`Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ **is_push_warning**\ (\ ) :ref:`🔗<class_GutTrackedError_method_is_push_warning>`
|
|
|
|
.. container:: contribute
|
|
|
|
No description
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_GutTrackedError_method_is_gut_error:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
`Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ **is_gut_error**\ (\ ) :ref:`🔗<class_GutTrackedError_method_is_gut_error>`
|
|
|
|
Returns ``true`` if the error is a GUT error. Some fields may not be populated for GUT errors.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_GutTrackedError_method_contains_text:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
`Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ **contains_text**\ (\ text\ ) :ref:`🔗<class_GutTrackedError_method_contains_text>`
|
|
|
|
.. container:: contribute
|
|
|
|
No description
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_GutTrackedError_method_get_error_type_name:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
`Variant <https://docs.godotengine.org/en/stable/classes/class_variant.html>`_ **get_error_type_name**\ (\ ) :ref:`🔗<class_GutTrackedError_method_get_error_type_name>`
|
|
|
|
For display purposes only, the actual value returned may change over time. This returns a name for the error_type as far as this class is concerned. Use the various ``is_`` methods to check if an error is a certain type.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |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.)`
|