.. 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/docs/gdscript/jam_launch/JamError.xml.

.. _class_JamError:

JamError
========

**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

A utility class for storing error states with descriptive strings. Useful as a function return value.

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

Properties
----------

.. table::
   :widths: auto

   +-----------------------------+-----------------------------------------------------+-----------+
   | :ref:`bool<class_bool>`     | :ref:`errored<class_JamError_property_errored>`     | ``false`` |
   +-----------------------------+-----------------------------------------------------+-----------+
   | :ref:`String<class_String>` | :ref:`error_msg<class_JamError_property_error_msg>` | ``""``    |
   +-----------------------------+-----------------------------------------------------+-----------+

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

Methods
-------

.. table::
   :widths: auto

   +---------------------------------+--------------------------------------------------------------------------------------------+
   | :ref:`JamError<class_JamError>` | :ref:`ok<class_JamError_method_ok>` **(** **)** |static|                                   |
   +---------------------------------+--------------------------------------------------------------------------------------------+
   | :ref:`JamError<class_JamError>` | :ref:`err<class_JamError_method_err>` **(** :ref:`String<class_String>` msg **)** |static| |
   +---------------------------------+--------------------------------------------------------------------------------------------+

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

----

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

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

.. _class_JamError_property_errored:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **errored** = ``false``

.. container:: contribute

	There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

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

----

.. _class_JamError_property_error_msg:

.. rst-class:: classref-property

:ref:`String<class_String>` **error_msg** = ``""``

.. container:: contribute

	There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

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

----

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

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

.. _class_JamError_method_ok:

.. rst-class:: classref-method

:ref:`JamError<class_JamError>` **ok** **(** **)** |static|

.. container:: contribute

	There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

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

----

.. _class_JamError_method_err:

.. rst-class:: classref-method

:ref:`JamError<class_JamError>` **err** **(** :ref:`String<class_String>` msg **)** |static|

.. container:: contribute

	There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

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