godot-docs/classes/[email protected]

: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/doc/classes/@GlobalScope.xml.

.. _class_@GlobalScope:

@GlobalScope
============

Global scope constants and functions.

.. rst-class:: classref-introduction-group

Description
-----------

A list of global scope enumerated constants and built-in functions. This is all that resides in the globals, constants regarding error codes, keycodes, property hints, etc.

Singletons are also documented here, since they can be accessed from anywhere.

For the entries related to GDScript which can be accessed in any script see :ref:`@GDScript<class_@GDScript>`.

.. note::

	There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information.

.. rst-class:: classref-introduction-group

Tutorials
---------

- :doc:`Random number generation <../tutorials/math/random_number_generation>`

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

Properties
----------

.. table::
   :widths: auto

   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`AudioServer<class_AudioServer>`                         | :ref:`AudioServer<class_@GlobalScope_property_AudioServer>`                         |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`CameraServer<class_CameraServer>`                       | :ref:`CameraServer<class_@GlobalScope_property_CameraServer>`                       |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`ClassDB<class_ClassDB>`                                 | :ref:`ClassDB<class_@GlobalScope_property_ClassDB>`                                 |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`DisplayServer<class_DisplayServer>`                     | :ref:`DisplayServer<class_@GlobalScope_property_DisplayServer>`                     |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`EditorInterface<class_EditorInterface>`                 | :ref:`EditorInterface<class_@GlobalScope_property_EditorInterface>`                 |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`Engine<class_Engine>`                                   | :ref:`Engine<class_@GlobalScope_property_Engine>`                                   |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`EngineDebugger<class_EngineDebugger>`                   | :ref:`EngineDebugger<class_@GlobalScope_property_EngineDebugger>`                   |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`GDExtensionManager<class_GDExtensionManager>`           | :ref:`GDExtensionManager<class_@GlobalScope_property_GDExtensionManager>`           |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`Geometry2D<class_Geometry2D>`                           | :ref:`Geometry2D<class_@GlobalScope_property_Geometry2D>`                           |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`Geometry3D<class_Geometry3D>`                           | :ref:`Geometry3D<class_@GlobalScope_property_Geometry3D>`                           |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`GodotSharp<class_GodotSharp>`                           | :ref:`GodotSharp<class_@GlobalScope_property_GodotSharp>`                           |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`IP<class_IP>`                                           | :ref:`IP<class_@GlobalScope_property_IP>`                                           |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`Input<class_Input>`                                     | :ref:`Input<class_@GlobalScope_property_Input>`                                     |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`InputMap<class_InputMap>`                               | :ref:`InputMap<class_@GlobalScope_property_InputMap>`                               |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`JavaClassWrapper<class_JavaClassWrapper>`               | :ref:`JavaClassWrapper<class_@GlobalScope_property_JavaClassWrapper>`               |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`JavaScriptBridge<class_JavaScriptBridge>`               | :ref:`JavaScriptBridge<class_@GlobalScope_property_JavaScriptBridge>`               |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`Marshalls<class_Marshalls>`                             | :ref:`Marshalls<class_@GlobalScope_property_Marshalls>`                             |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`NavigationMeshGenerator<class_NavigationMeshGenerator>` | :ref:`NavigationMeshGenerator<class_@GlobalScope_property_NavigationMeshGenerator>` |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`NavigationServer2D<class_NavigationServer2D>`           | :ref:`NavigationServer2D<class_@GlobalScope_property_NavigationServer2D>`           |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`NavigationServer3D<class_NavigationServer3D>`           | :ref:`NavigationServer3D<class_@GlobalScope_property_NavigationServer3D>`           |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`OS<class_OS>`                                           | :ref:`OS<class_@GlobalScope_property_OS>`                                           |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`Performance<class_Performance>`                         | :ref:`Performance<class_@GlobalScope_property_Performance>`                         |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`PhysicsServer2D<class_PhysicsServer2D>`                 | :ref:`PhysicsServer2D<class_@GlobalScope_property_PhysicsServer2D>`                 |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`PhysicsServer2DManager<class_PhysicsServer2DManager>`   | :ref:`PhysicsServer2DManager<class_@GlobalScope_property_PhysicsServer2DManager>`   |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`PhysicsServer3D<class_PhysicsServer3D>`                 | :ref:`PhysicsServer3D<class_@GlobalScope_property_PhysicsServer3D>`                 |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`PhysicsServer3DManager<class_PhysicsServer3DManager>`   | :ref:`PhysicsServer3DManager<class_@GlobalScope_property_PhysicsServer3DManager>`   |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`ProjectSettings<class_ProjectSettings>`                 | :ref:`ProjectSettings<class_@GlobalScope_property_ProjectSettings>`                 |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`RenderingServer<class_RenderingServer>`                 | :ref:`RenderingServer<class_@GlobalScope_property_RenderingServer>`                 |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`ResourceLoader<class_ResourceLoader>`                   | :ref:`ResourceLoader<class_@GlobalScope_property_ResourceLoader>`                   |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`ResourceSaver<class_ResourceSaver>`                     | :ref:`ResourceSaver<class_@GlobalScope_property_ResourceSaver>`                     |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`ResourceUID<class_ResourceUID>`                         | :ref:`ResourceUID<class_@GlobalScope_property_ResourceUID>`                         |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`TextServerManager<class_TextServerManager>`             | :ref:`TextServerManager<class_@GlobalScope_property_TextServerManager>`             |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`ThemeDB<class_ThemeDB>`                                 | :ref:`ThemeDB<class_@GlobalScope_property_ThemeDB>`                                 |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`Time<class_Time>`                                       | :ref:`Time<class_@GlobalScope_property_Time>`                                       |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`TranslationServer<class_TranslationServer>`             | :ref:`TranslationServer<class_@GlobalScope_property_TranslationServer>`             |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`WorkerThreadPool<class_WorkerThreadPool>`               | :ref:`WorkerThreadPool<class_@GlobalScope_property_WorkerThreadPool>`               |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`XRServer<class_XRServer>`                               | :ref:`XRServer<class_@GlobalScope_property_XRServer>`                               |
   +---------------------------------------------------------------+-------------------------------------------------------------------------------------+

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

Methods
-------

.. table::
   :widths: auto

   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Variant<class_Variant>`                   | :ref:`abs<class_@GlobalScope_method_abs>` **(** :ref:`Variant<class_Variant>` x **)**                                                                                                                                                                                                                                                                                          |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`absf<class_@GlobalScope_method_absf>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                           | :ref:`absi<class_@GlobalScope_method_absi>` **(** :ref:`int<class_int>` x **)**                                                                                                                                                                                                                                                                                                |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`acos<class_@GlobalScope_method_acos>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`acosh<class_@GlobalScope_method_acosh>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                          |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`asin<class_@GlobalScope_method_asin>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`asinh<class_@GlobalScope_method_asinh>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                          |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`atan<class_@GlobalScope_method_atan>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`atan2<class_@GlobalScope_method_atan2>` **(** :ref:`float<class_float>` y, :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                             |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`atanh<class_@GlobalScope_method_atanh>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                          |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`bezier_derivative<class_@GlobalScope_method_bezier_derivative>` **(** :ref:`float<class_float>` start, :ref:`float<class_float>` control_1, :ref:`float<class_float>` control_2, :ref:`float<class_float>` end, :ref:`float<class_float>` t **)**                                                                                                                        |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`bezier_interpolate<class_@GlobalScope_method_bezier_interpolate>` **(** :ref:`float<class_float>` start, :ref:`float<class_float>` control_1, :ref:`float<class_float>` control_2, :ref:`float<class_float>` end, :ref:`float<class_float>` t **)**                                                                                                                      |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Variant<class_Variant>`                   | :ref:`bytes_to_var<class_@GlobalScope_method_bytes_to_var>` **(** :ref:`PackedByteArray<class_PackedByteArray>` bytes **)**                                                                                                                                                                                                                                                    |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Variant<class_Variant>`                   | :ref:`bytes_to_var_with_objects<class_@GlobalScope_method_bytes_to_var_with_objects>` **(** :ref:`PackedByteArray<class_PackedByteArray>` bytes **)**                                                                                                                                                                                                                          |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Variant<class_Variant>`                   | :ref:`ceil<class_@GlobalScope_method_ceil>` **(** :ref:`Variant<class_Variant>` x **)**                                                                                                                                                                                                                                                                                        |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`ceilf<class_@GlobalScope_method_ceilf>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                          |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                           | :ref:`ceili<class_@GlobalScope_method_ceili>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                          |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Variant<class_Variant>`                   | :ref:`clamp<class_@GlobalScope_method_clamp>` **(** :ref:`Variant<class_Variant>` value, :ref:`Variant<class_Variant>` min, :ref:`Variant<class_Variant>` max **)**                                                                                                                                                                                                            |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`clampf<class_@GlobalScope_method_clampf>` **(** :ref:`float<class_float>` value, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)**                                                                                                                                                                                                                      |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                           | :ref:`clampi<class_@GlobalScope_method_clampi>` **(** :ref:`int<class_int>` value, :ref:`int<class_int>` min, :ref:`int<class_int>` max **)**                                                                                                                                                                                                                                  |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`cos<class_@GlobalScope_method_cos>` **(** :ref:`float<class_float>` angle_rad **)**                                                                                                                                                                                                                                                                                      |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`cosh<class_@GlobalScope_method_cosh>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`cubic_interpolate<class_@GlobalScope_method_cubic_interpolate>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` pre, :ref:`float<class_float>` post, :ref:`float<class_float>` weight **)**                                                                                                                                |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`cubic_interpolate_angle<class_@GlobalScope_method_cubic_interpolate_angle>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` pre, :ref:`float<class_float>` post, :ref:`float<class_float>` weight **)**                                                                                                                    |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`cubic_interpolate_angle_in_time<class_@GlobalScope_method_cubic_interpolate_angle_in_time>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` pre, :ref:`float<class_float>` post, :ref:`float<class_float>` weight, :ref:`float<class_float>` to_t, :ref:`float<class_float>` pre_t, :ref:`float<class_float>` post_t **)** |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`cubic_interpolate_in_time<class_@GlobalScope_method_cubic_interpolate_in_time>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` pre, :ref:`float<class_float>` post, :ref:`float<class_float>` weight, :ref:`float<class_float>` to_t, :ref:`float<class_float>` pre_t, :ref:`float<class_float>` post_t **)**             |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`db_to_linear<class_@GlobalScope_method_db_to_linear>` **(** :ref:`float<class_float>` db **)**                                                                                                                                                                                                                                                                           |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`deg_to_rad<class_@GlobalScope_method_deg_to_rad>` **(** :ref:`float<class_float>` deg **)**                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`ease<class_@GlobalScope_method_ease>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` curve **)**                                                                                                                                                                                                                                                           |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                     | :ref:`error_string<class_@GlobalScope_method_error_string>` **(** :ref:`int<class_int>` error **)**                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`exp<class_@GlobalScope_method_exp>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Variant<class_Variant>`                   | :ref:`floor<class_@GlobalScope_method_floor>` **(** :ref:`Variant<class_Variant>` x **)**                                                                                                                                                                                                                                                                                      |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`floorf<class_@GlobalScope_method_floorf>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                        |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                           | :ref:`floori<class_@GlobalScope_method_floori>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                        |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`fmod<class_@GlobalScope_method_fmod>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)**                                                                                                                                                                                                                                                               |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`fposmod<class_@GlobalScope_method_fposmod>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)**                                                                                                                                                                                                                                                         |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                           | :ref:`hash<class_@GlobalScope_method_hash>` **(** :ref:`Variant<class_Variant>` variable **)**                                                                                                                                                                                                                                                                                 |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Object<class_Object>`                     | :ref:`instance_from_id<class_@GlobalScope_method_instance_from_id>` **(** :ref:`int<class_int>` instance_id **)**                                                                                                                                                                                                                                                              |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`inverse_lerp<class_@GlobalScope_method_inverse_lerp>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` weight **)**                                                                                                                                                                                                         |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                         | :ref:`is_equal_approx<class_@GlobalScope_method_is_equal_approx>` **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)**                                                                                                                                                                                                                                         |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                         | :ref:`is_finite<class_@GlobalScope_method_is_finite>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                  |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                         | :ref:`is_inf<class_@GlobalScope_method_is_inf>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                        |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                         | :ref:`is_instance_id_valid<class_@GlobalScope_method_is_instance_id_valid>` **(** :ref:`int<class_int>` id **)**                                                                                                                                                                                                                                                               |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                         | :ref:`is_instance_valid<class_@GlobalScope_method_is_instance_valid>` **(** :ref:`Variant<class_Variant>` instance **)**                                                                                                                                                                                                                                                       |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                         | :ref:`is_nan<class_@GlobalScope_method_is_nan>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                        |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                         | :ref:`is_same<class_@GlobalScope_method_is_same>` **(** :ref:`Variant<class_Variant>` a, :ref:`Variant<class_Variant>` b **)**                                                                                                                                                                                                                                                 |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                         | :ref:`is_zero_approx<class_@GlobalScope_method_is_zero_approx>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                        |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Variant<class_Variant>`                   | :ref:`lerp<class_@GlobalScope_method_lerp>` **(** :ref:`Variant<class_Variant>` from, :ref:`Variant<class_Variant>` to, :ref:`Variant<class_Variant>` weight **)**                                                                                                                                                                                                             |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`lerp_angle<class_@GlobalScope_method_lerp_angle>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` weight **)**                                                                                                                                                                                                             |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`lerpf<class_@GlobalScope_method_lerpf>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` weight **)**                                                                                                                                                                                                                       |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`linear_to_db<class_@GlobalScope_method_linear_to_db>` **(** :ref:`float<class_float>` lin **)**                                                                                                                                                                                                                                                                          |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`log<class_@GlobalScope_method_log>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Variant<class_Variant>`                   | :ref:`max<class_@GlobalScope_method_max>` **(** ... **)** |vararg|                                                                                                                                                                                                                                                                                                             |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`maxf<class_@GlobalScope_method_maxf>` **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)**                                                                                                                                                                                                                                                               |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                           | :ref:`maxi<class_@GlobalScope_method_maxi>` **(** :ref:`int<class_int>` a, :ref:`int<class_int>` b **)**                                                                                                                                                                                                                                                                       |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Variant<class_Variant>`                   | :ref:`min<class_@GlobalScope_method_min>` **(** ... **)** |vararg|                                                                                                                                                                                                                                                                                                             |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`minf<class_@GlobalScope_method_minf>` **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)**                                                                                                                                                                                                                                                               |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                           | :ref:`mini<class_@GlobalScope_method_mini>` **(** :ref:`int<class_int>` a, :ref:`int<class_int>` b **)**                                                                                                                                                                                                                                                                       |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`move_toward<class_@GlobalScope_method_move_toward>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` delta **)**                                                                                                                                                                                                            |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                           | :ref:`nearest_po2<class_@GlobalScope_method_nearest_po2>` **(** :ref:`int<class_int>` value **)**                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`pingpong<class_@GlobalScope_method_pingpong>` **(** :ref:`float<class_float>` value, :ref:`float<class_float>` length **)**                                                                                                                                                                                                                                              |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                           | :ref:`posmod<class_@GlobalScope_method_posmod>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y **)**                                                                                                                                                                                                                                                                   |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`pow<class_@GlobalScope_method_pow>` **(** :ref:`float<class_float>` base, :ref:`float<class_float>` exp **)**                                                                                                                                                                                                                                                            |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                            | :ref:`print<class_@GlobalScope_method_print>` **(** ... **)** |vararg|                                                                                                                                                                                                                                                                                                         |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                            | :ref:`print_rich<class_@GlobalScope_method_print_rich>` **(** ... **)** |vararg|                                                                                                                                                                                                                                                                                               |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                            | :ref:`print_verbose<class_@GlobalScope_method_print_verbose>` **(** ... **)** |vararg|                                                                                                                                                                                                                                                                                         |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                            | :ref:`printerr<class_@GlobalScope_method_printerr>` **(** ... **)** |vararg|                                                                                                                                                                                                                                                                                                   |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                            | :ref:`printraw<class_@GlobalScope_method_printraw>` **(** ... **)** |vararg|                                                                                                                                                                                                                                                                                                   |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                            | :ref:`prints<class_@GlobalScope_method_prints>` **(** ... **)** |vararg|                                                                                                                                                                                                                                                                                                       |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                            | :ref:`printt<class_@GlobalScope_method_printt>` **(** ... **)** |vararg|                                                                                                                                                                                                                                                                                                       |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                            | :ref:`push_error<class_@GlobalScope_method_push_error>` **(** ... **)** |vararg|                                                                                                                                                                                                                                                                                               |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                            | :ref:`push_warning<class_@GlobalScope_method_push_warning>` **(** ... **)** |vararg|                                                                                                                                                                                                                                                                                           |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`rad_to_deg<class_@GlobalScope_method_rad_to_deg>` **(** :ref:`float<class_float>` rad **)**                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`rand_from_seed<class_@GlobalScope_method_rand_from_seed>` **(** :ref:`int<class_int>` seed **)**                                                                                                                                                                                                                                                                         |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`randf<class_@GlobalScope_method_randf>` **(** **)**                                                                                                                                                                                                                                                                                                                      |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`randf_range<class_@GlobalScope_method_randf_range>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to **)**                                                                                                                                                                                                                                             |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`randfn<class_@GlobalScope_method_randfn>` **(** :ref:`float<class_float>` mean, :ref:`float<class_float>` deviation **)**                                                                                                                                                                                                                                                |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                           | :ref:`randi<class_@GlobalScope_method_randi>` **(** **)**                                                                                                                                                                                                                                                                                                                      |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                           | :ref:`randi_range<class_@GlobalScope_method_randi_range>` **(** :ref:`int<class_int>` from, :ref:`int<class_int>` to **)**                                                                                                                                                                                                                                                     |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                            | :ref:`randomize<class_@GlobalScope_method_randomize>` **(** **)**                                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`remap<class_@GlobalScope_method_remap>` **(** :ref:`float<class_float>` value, :ref:`float<class_float>` istart, :ref:`float<class_float>` istop, :ref:`float<class_float>` ostart, :ref:`float<class_float>` ostop **)**                                                                                                                                                |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                           | :ref:`rid_allocate_id<class_@GlobalScope_method_rid_allocate_id>` **(** **)**                                                                                                                                                                                                                                                                                                  |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`RID<class_RID>`                           | :ref:`rid_from_int64<class_@GlobalScope_method_rid_from_int64>` **(** :ref:`int<class_int>` base **)**                                                                                                                                                                                                                                                                         |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Variant<class_Variant>`                   | :ref:`round<class_@GlobalScope_method_round>` **(** :ref:`Variant<class_Variant>` x **)**                                                                                                                                                                                                                                                                                      |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`roundf<class_@GlobalScope_method_roundf>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                        |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                           | :ref:`roundi<class_@GlobalScope_method_roundi>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                        |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                            | :ref:`seed<class_@GlobalScope_method_seed>` **(** :ref:`int<class_int>` base **)**                                                                                                                                                                                                                                                                                             |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Variant<class_Variant>`                   | :ref:`sign<class_@GlobalScope_method_sign>` **(** :ref:`Variant<class_Variant>` x **)**                                                                                                                                                                                                                                                                                        |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`signf<class_@GlobalScope_method_signf>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                          |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                           | :ref:`signi<class_@GlobalScope_method_signi>` **(** :ref:`int<class_int>` x **)**                                                                                                                                                                                                                                                                                              |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`sin<class_@GlobalScope_method_sin>` **(** :ref:`float<class_float>` angle_rad **)**                                                                                                                                                                                                                                                                                      |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`sinh<class_@GlobalScope_method_sinh>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`smoothstep<class_@GlobalScope_method_smoothstep>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` x **)**                                                                                                                                                                                                                  |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Variant<class_Variant>`                   | :ref:`snapped<class_@GlobalScope_method_snapped>` **(** :ref:`Variant<class_Variant>` x, :ref:`Variant<class_Variant>` step **)**                                                                                                                                                                                                                                              |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`snappedf<class_@GlobalScope_method_snappedf>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` step **)**                                                                                                                                                                                                                                                    |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                           | :ref:`snappedi<class_@GlobalScope_method_snappedi>` **(** :ref:`float<class_float>` x, :ref:`int<class_int>` step **)**                                                                                                                                                                                                                                                        |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`sqrt<class_@GlobalScope_method_sqrt>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                           | :ref:`step_decimals<class_@GlobalScope_method_step_decimals>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                          |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                     | :ref:`str<class_@GlobalScope_method_str>` **(** ... **)** |vararg|                                                                                                                                                                                                                                                                                                             |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Variant<class_Variant>`                   | :ref:`str_to_var<class_@GlobalScope_method_str_to_var>` **(** :ref:`String<class_String>` string **)**                                                                                                                                                                                                                                                                         |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`tan<class_@GlobalScope_method_tan>` **(** :ref:`float<class_float>` angle_rad **)**                                                                                                                                                                                                                                                                                      |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`tanh<class_@GlobalScope_method_tanh>` **(** :ref:`float<class_float>` x **)**                                                                                                                                                                                                                                                                                            |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                           | :ref:`typeof<class_@GlobalScope_method_typeof>` **(** :ref:`Variant<class_Variant>` variable **)**                                                                                                                                                                                                                                                                             |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedByteArray<class_PackedByteArray>`   | :ref:`var_to_bytes<class_@GlobalScope_method_var_to_bytes>` **(** :ref:`Variant<class_Variant>` variable **)**                                                                                                                                                                                                                                                                 |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedByteArray<class_PackedByteArray>`   | :ref:`var_to_bytes_with_objects<class_@GlobalScope_method_var_to_bytes_with_objects>` **(** :ref:`Variant<class_Variant>` variable **)**                                                                                                                                                                                                                                       |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                     | :ref:`var_to_str<class_@GlobalScope_method_var_to_str>` **(** :ref:`Variant<class_Variant>` variable **)**                                                                                                                                                                                                                                                                     |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Variant<class_Variant>`                   | :ref:`weakref<class_@GlobalScope_method_weakref>` **(** :ref:`Variant<class_Variant>` obj **)**                                                                                                                                                                                                                                                                                |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Variant<class_Variant>`                   | :ref:`wrap<class_@GlobalScope_method_wrap>` **(** :ref:`Variant<class_Variant>` value, :ref:`Variant<class_Variant>` min, :ref:`Variant<class_Variant>` max **)**                                                                                                                                                                                                              |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                       | :ref:`wrapf<class_@GlobalScope_method_wrapf>` **(** :ref:`float<class_float>` value, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)**                                                                                                                                                                                                                        |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                           | :ref:`wrapi<class_@GlobalScope_method_wrapi>` **(** :ref:`int<class_int>` value, :ref:`int<class_int>` min, :ref:`int<class_int>` max **)**                                                                                                                                                                                                                                    |
   +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

----

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

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

.. _enum_@GlobalScope_Side:

.. rst-class:: classref-enumeration

enum **Side**:

.. _class_@GlobalScope_constant_SIDE_LEFT:

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

:ref:`Side<enum_@GlobalScope_Side>` **SIDE_LEFT** = ``0``

Left side, usually used for :ref:`Control<class_Control>` or :ref:`StyleBox<class_StyleBox>`-derived classes.

.. _class_@GlobalScope_constant_SIDE_TOP:

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

:ref:`Side<enum_@GlobalScope_Side>` **SIDE_TOP** = ``1``

Top side, usually used for :ref:`Control<class_Control>` or :ref:`StyleBox<class_StyleBox>`-derived classes.

.. _class_@GlobalScope_constant_SIDE_RIGHT:

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

:ref:`Side<enum_@GlobalScope_Side>` **SIDE_RIGHT** = ``2``

Right side, usually used for :ref:`Control<class_Control>` or :ref:`StyleBox<class_StyleBox>`-derived classes.

.. _class_@GlobalScope_constant_SIDE_BOTTOM:

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

:ref:`Side<enum_@GlobalScope_Side>` **SIDE_BOTTOM** = ``3``

Bottom side, usually used for :ref:`Control<class_Control>` or :ref:`StyleBox<class_StyleBox>`-derived classes.

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

----

.. _enum_@GlobalScope_Corner:

.. rst-class:: classref-enumeration

enum **Corner**:

.. _class_@GlobalScope_constant_CORNER_TOP_LEFT:

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

:ref:`Corner<enum_@GlobalScope_Corner>` **CORNER_TOP_LEFT** = ``0``

Top-left corner.

.. _class_@GlobalScope_constant_CORNER_TOP_RIGHT:

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

:ref:`Corner<enum_@GlobalScope_Corner>` **CORNER_TOP_RIGHT** = ``1``

Top-right corner.

.. _class_@GlobalScope_constant_CORNER_BOTTOM_RIGHT:

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

:ref:`Corner<enum_@GlobalScope_Corner>` **CORNER_BOTTOM_RIGHT** = ``2``

Bottom-right corner.

.. _class_@GlobalScope_constant_CORNER_BOTTOM_LEFT:

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

:ref:`Corner<enum_@GlobalScope_Corner>` **CORNER_BOTTOM_LEFT** = ``3``

Bottom-left corner.

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

----

.. _enum_@GlobalScope_Orientation:

.. rst-class:: classref-enumeration

enum **Orientation**:

.. _class_@GlobalScope_constant_VERTICAL:

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

:ref:`Orientation<enum_@GlobalScope_Orientation>` **VERTICAL** = ``1``

General vertical alignment, usually used for :ref:`Separator<class_Separator>`, :ref:`ScrollBar<class_ScrollBar>`, :ref:`Slider<class_Slider>`, etc.

.. _class_@GlobalScope_constant_HORIZONTAL:

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

:ref:`Orientation<enum_@GlobalScope_Orientation>` **HORIZONTAL** = ``0``

General horizontal alignment, usually used for :ref:`Separator<class_Separator>`, :ref:`ScrollBar<class_ScrollBar>`, :ref:`Slider<class_Slider>`, etc.

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

----

.. _enum_@GlobalScope_ClockDirection:

.. rst-class:: classref-enumeration

enum **ClockDirection**:

.. _class_@GlobalScope_constant_CLOCKWISE:

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

:ref:`ClockDirection<enum_@GlobalScope_ClockDirection>` **CLOCKWISE** = ``0``

Clockwise rotation. Used by some methods (e.g. :ref:`Image.rotate_90<class_Image_method_rotate_90>`).

.. _class_@GlobalScope_constant_COUNTERCLOCKWISE:

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

:ref:`ClockDirection<enum_@GlobalScope_ClockDirection>` **COUNTERCLOCKWISE** = ``1``

Counter-clockwise rotation. Used by some methods (e.g. :ref:`Image.rotate_90<class_Image_method_rotate_90>`).

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

----

.. _enum_@GlobalScope_HorizontalAlignment:

.. rst-class:: classref-enumeration

enum **HorizontalAlignment**:

.. _class_@GlobalScope_constant_HORIZONTAL_ALIGNMENT_LEFT:

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

:ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` **HORIZONTAL_ALIGNMENT_LEFT** = ``0``

Horizontal left alignment, usually for text-derived classes.

.. _class_@GlobalScope_constant_HORIZONTAL_ALIGNMENT_CENTER:

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

:ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` **HORIZONTAL_ALIGNMENT_CENTER** = ``1``

Horizontal center alignment, usually for text-derived classes.

.. _class_@GlobalScope_constant_HORIZONTAL_ALIGNMENT_RIGHT:

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

:ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` **HORIZONTAL_ALIGNMENT_RIGHT** = ``2``

Horizontal right alignment, usually for text-derived classes.

.. _class_@GlobalScope_constant_HORIZONTAL_ALIGNMENT_FILL:

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

:ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` **HORIZONTAL_ALIGNMENT_FILL** = ``3``

Expand row to fit width, usually for text-derived classes.

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

----

.. _enum_@GlobalScope_VerticalAlignment:

.. rst-class:: classref-enumeration

enum **VerticalAlignment**:

.. _class_@GlobalScope_constant_VERTICAL_ALIGNMENT_TOP:

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

:ref:`VerticalAlignment<enum_@GlobalScope_VerticalAlignment>` **VERTICAL_ALIGNMENT_TOP** = ``0``

Vertical top alignment, usually for text-derived classes.

.. _class_@GlobalScope_constant_VERTICAL_ALIGNMENT_CENTER:

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

:ref:`VerticalAlignment<enum_@GlobalScope_VerticalAlignment>` **VERTICAL_ALIGNMENT_CENTER** = ``1``

Vertical center alignment, usually for text-derived classes.

.. _class_@GlobalScope_constant_VERTICAL_ALIGNMENT_BOTTOM:

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

:ref:`VerticalAlignment<enum_@GlobalScope_VerticalAlignment>` **VERTICAL_ALIGNMENT_BOTTOM** = ``2``

Vertical bottom alignment, usually for text-derived classes.

.. _class_@GlobalScope_constant_VERTICAL_ALIGNMENT_FILL:

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

:ref:`VerticalAlignment<enum_@GlobalScope_VerticalAlignment>` **VERTICAL_ALIGNMENT_FILL** = ``3``

Expand rows to fit height, usually for text-derived classes.

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

----

.. _enum_@GlobalScope_InlineAlignment:

.. rst-class:: classref-enumeration

enum **InlineAlignment**:

.. _class_@GlobalScope_constant_INLINE_ALIGNMENT_TOP_TO:

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

:ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` **INLINE_ALIGNMENT_TOP_TO** = ``0``

Aligns the top of the inline object (e.g. image, table) to the position of the text specified by ``INLINE_ALIGNMENT_TO_*`` constant.

.. _class_@GlobalScope_constant_INLINE_ALIGNMENT_CENTER_TO:

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

:ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` **INLINE_ALIGNMENT_CENTER_TO** = ``1``

Aligns the center of the inline object (e.g. image, table) to the position of the text specified by ``INLINE_ALIGNMENT_TO_*`` constant.

.. _class_@GlobalScope_constant_INLINE_ALIGNMENT_BASELINE_TO:

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

:ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` **INLINE_ALIGNMENT_BASELINE_TO** = ``3``

Aligns the baseline (user defined) of the inline object (e.g. image, table) to the position of the text specified by ``INLINE_ALIGNMENT_TO_*`` constant.

.. _class_@GlobalScope_constant_INLINE_ALIGNMENT_BOTTOM_TO:

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

:ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` **INLINE_ALIGNMENT_BOTTOM_TO** = ``2``

Aligns the bottom of the inline object (e.g. image, table) to the position of the text specified by ``INLINE_ALIGNMENT_TO_*`` constant.

.. _class_@GlobalScope_constant_INLINE_ALIGNMENT_TO_TOP:

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

:ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` **INLINE_ALIGNMENT_TO_TOP** = ``0``

Aligns the position of the inline object (e.g. image, table) specified by ``INLINE_ALIGNMENT_*_TO`` constant to the top of the text.

.. _class_@GlobalScope_constant_INLINE_ALIGNMENT_TO_CENTER:

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

:ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` **INLINE_ALIGNMENT_TO_CENTER** = ``4``

Aligns the position of the inline object (e.g. image, table) specified by ``INLINE_ALIGNMENT_*_TO`` constant to the center of the text.

.. _class_@GlobalScope_constant_INLINE_ALIGNMENT_TO_BASELINE:

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

:ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` **INLINE_ALIGNMENT_TO_BASELINE** = ``8``

Aligns the position of the inline object (e.g. image, table) specified by ``INLINE_ALIGNMENT_*_TO`` constant to the baseline of the text.

.. _class_@GlobalScope_constant_INLINE_ALIGNMENT_TO_BOTTOM:

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

:ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` **INLINE_ALIGNMENT_TO_BOTTOM** = ``12``

Aligns inline object (e.g. image, table) to the bottom of the text.

.. _class_@GlobalScope_constant_INLINE_ALIGNMENT_TOP:

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

:ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` **INLINE_ALIGNMENT_TOP** = ``0``

Aligns top of the inline object (e.g. image, table) to the top of the text. Equivalent to ``INLINE_ALIGNMENT_TOP_TO | INLINE_ALIGNMENT_TO_TOP``.

.. _class_@GlobalScope_constant_INLINE_ALIGNMENT_CENTER:

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

:ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` **INLINE_ALIGNMENT_CENTER** = ``5``

Aligns center of the inline object (e.g. image, table) to the center of the text. Equivalent to ``INLINE_ALIGNMENT_CENTER_TO | INLINE_ALIGNMENT_TO_CENTER``.

.. _class_@GlobalScope_constant_INLINE_ALIGNMENT_BOTTOM:

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

:ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` **INLINE_ALIGNMENT_BOTTOM** = ``14``

Aligns bottom of the inline object (e.g. image, table) to the bottom of the text. Equivalent to ``INLINE_ALIGNMENT_BOTTOM_TO | INLINE_ALIGNMENT_TO_BOTTOM``.

.. _class_@GlobalScope_constant_INLINE_ALIGNMENT_IMAGE_MASK:

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

:ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` **INLINE_ALIGNMENT_IMAGE_MASK** = ``3``

A bit mask for ``INLINE_ALIGNMENT_*_TO`` alignment constants.

.. _class_@GlobalScope_constant_INLINE_ALIGNMENT_TEXT_MASK:

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

:ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` **INLINE_ALIGNMENT_TEXT_MASK** = ``12``

A bit mask for ``INLINE_ALIGNMENT_TO_*`` alignment constants.

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

----

.. _enum_@GlobalScope_EulerOrder:

.. rst-class:: classref-enumeration

enum **EulerOrder**:

.. _class_@GlobalScope_constant_EULER_ORDER_XYZ:

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

:ref:`EulerOrder<enum_@GlobalScope_EulerOrder>` **EULER_ORDER_XYZ** = ``0``

Specifies that Euler angles should be in XYZ order. When composing, the order is X, Y, Z. When decomposing, the order is reversed, first Z, then Y, and X last.

.. _class_@GlobalScope_constant_EULER_ORDER_XZY:

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

:ref:`EulerOrder<enum_@GlobalScope_EulerOrder>` **EULER_ORDER_XZY** = ``1``

Specifies that Euler angles should be in XZY order. When composing, the order is X, Z, Y. When decomposing, the order is reversed, first Y, then Z, and X last.

.. _class_@GlobalScope_constant_EULER_ORDER_YXZ:

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

:ref:`EulerOrder<enum_@GlobalScope_EulerOrder>` **EULER_ORDER_YXZ** = ``2``

Specifies that Euler angles should be in YXZ order. When composing, the order is Y, X, Z. When decomposing, the order is reversed, first Z, then X, and Y last.

.. _class_@GlobalScope_constant_EULER_ORDER_YZX:

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

:ref:`EulerOrder<enum_@GlobalScope_EulerOrder>` **EULER_ORDER_YZX** = ``3``

Specifies that Euler angles should be in YZX order. When composing, the order is Y, Z, X. When decomposing, the order is reversed, first X, then Z, and Y last.

.. _class_@GlobalScope_constant_EULER_ORDER_ZXY:

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

:ref:`EulerOrder<enum_@GlobalScope_EulerOrder>` **EULER_ORDER_ZXY** = ``4``

Specifies that Euler angles should be in ZXY order. When composing, the order is Z, X, Y. When decomposing, the order is reversed, first Y, then X, and Z last.

.. _class_@GlobalScope_constant_EULER_ORDER_ZYX:

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

:ref:`EulerOrder<enum_@GlobalScope_EulerOrder>` **EULER_ORDER_ZYX** = ``5``

Specifies that Euler angles should be in ZYX order. When composing, the order is Z, Y, X. When decomposing, the order is reversed, first X, then Y, and Z last.

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

----

.. _enum_@GlobalScope_Key:

.. rst-class:: classref-enumeration

enum **Key**:

.. _class_@GlobalScope_constant_KEY_NONE:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_NONE** = ``0``

Enum value which doesn't correspond to any key. This is used to initialize :ref:`Key<enum_@GlobalScope_Key>` properties with a generic state.

.. _class_@GlobalScope_constant_KEY_SPECIAL:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_SPECIAL** = ``4194304``

Keycodes with this bit applied are non-printable.

.. _class_@GlobalScope_constant_KEY_ESCAPE:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_ESCAPE** = ``4194305``

Escape key.

.. _class_@GlobalScope_constant_KEY_TAB:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_TAB** = ``4194306``

Tab key.

.. _class_@GlobalScope_constant_KEY_BACKTAB:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_BACKTAB** = ``4194307``

Shift + Tab key.

.. _class_@GlobalScope_constant_KEY_BACKSPACE:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_BACKSPACE** = ``4194308``

Backspace key.

.. _class_@GlobalScope_constant_KEY_ENTER:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_ENTER** = ``4194309``

Return key (on the main keyboard).

.. _class_@GlobalScope_constant_KEY_KP_ENTER:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_KP_ENTER** = ``4194310``

Enter key on the numeric keypad.

.. _class_@GlobalScope_constant_KEY_INSERT:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_INSERT** = ``4194311``

Insert key.

.. _class_@GlobalScope_constant_KEY_DELETE:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_DELETE** = ``4194312``

Delete key.

.. _class_@GlobalScope_constant_KEY_PAUSE:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_PAUSE** = ``4194313``

Pause key.

.. _class_@GlobalScope_constant_KEY_PRINT:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_PRINT** = ``4194314``

Print Screen key.

.. _class_@GlobalScope_constant_KEY_SYSREQ:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_SYSREQ** = ``4194315``

System Request key.

.. _class_@GlobalScope_constant_KEY_CLEAR:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_CLEAR** = ``4194316``

Clear key.

.. _class_@GlobalScope_constant_KEY_HOME:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_HOME** = ``4194317``

Home key.

.. _class_@GlobalScope_constant_KEY_END:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_END** = ``4194318``

End key.

.. _class_@GlobalScope_constant_KEY_LEFT:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_LEFT** = ``4194319``

Left arrow key.

.. _class_@GlobalScope_constant_KEY_UP:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_UP** = ``4194320``

Up arrow key.

.. _class_@GlobalScope_constant_KEY_RIGHT:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_RIGHT** = ``4194321``

Right arrow key.

.. _class_@GlobalScope_constant_KEY_DOWN:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_DOWN** = ``4194322``

Down arrow key.

.. _class_@GlobalScope_constant_KEY_PAGEUP:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_PAGEUP** = ``4194323``

Page Up key.

.. _class_@GlobalScope_constant_KEY_PAGEDOWN:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_PAGEDOWN** = ``4194324``

Page Down key.

.. _class_@GlobalScope_constant_KEY_SHIFT:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_SHIFT** = ``4194325``

Shift key.

.. _class_@GlobalScope_constant_KEY_CTRL:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_CTRL** = ``4194326``

Control key.

.. _class_@GlobalScope_constant_KEY_META:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_META** = ``4194327``

Meta key.

.. _class_@GlobalScope_constant_KEY_ALT:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_ALT** = ``4194328``

Alt key.

.. _class_@GlobalScope_constant_KEY_CAPSLOCK:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_CAPSLOCK** = ``4194329``

Caps Lock key.

.. _class_@GlobalScope_constant_KEY_NUMLOCK:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_NUMLOCK** = ``4194330``

Num Lock key.

.. _class_@GlobalScope_constant_KEY_SCROLLLOCK:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_SCROLLLOCK** = ``4194331``

Scroll Lock key.

.. _class_@GlobalScope_constant_KEY_F1:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F1** = ``4194332``

F1 key.

.. _class_@GlobalScope_constant_KEY_F2:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F2** = ``4194333``

F2 key.

.. _class_@GlobalScope_constant_KEY_F3:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F3** = ``4194334``

F3 key.

.. _class_@GlobalScope_constant_KEY_F4:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F4** = ``4194335``

F4 key.

.. _class_@GlobalScope_constant_KEY_F5:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F5** = ``4194336``

F5 key.

.. _class_@GlobalScope_constant_KEY_F6:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F6** = ``4194337``

F6 key.

.. _class_@GlobalScope_constant_KEY_F7:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F7** = ``4194338``

F7 key.

.. _class_@GlobalScope_constant_KEY_F8:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F8** = ``4194339``

F8 key.

.. _class_@GlobalScope_constant_KEY_F9:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F9** = ``4194340``

F9 key.

.. _class_@GlobalScope_constant_KEY_F10:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F10** = ``4194341``

F10 key.

.. _class_@GlobalScope_constant_KEY_F11:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F11** = ``4194342``

F11 key.

.. _class_@GlobalScope_constant_KEY_F12:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F12** = ``4194343``

F12 key.

.. _class_@GlobalScope_constant_KEY_F13:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F13** = ``4194344``

F13 key.

.. _class_@GlobalScope_constant_KEY_F14:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F14** = ``4194345``

F14 key.

.. _class_@GlobalScope_constant_KEY_F15:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F15** = ``4194346``

F15 key.

.. _class_@GlobalScope_constant_KEY_F16:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F16** = ``4194347``

F16 key.

.. _class_@GlobalScope_constant_KEY_F17:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F17** = ``4194348``

F17 key.

.. _class_@GlobalScope_constant_KEY_F18:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F18** = ``4194349``

F18 key.

.. _class_@GlobalScope_constant_KEY_F19:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F19** = ``4194350``

F19 key.

.. _class_@GlobalScope_constant_KEY_F20:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F20** = ``4194351``

F20 key.

.. _class_@GlobalScope_constant_KEY_F21:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F21** = ``4194352``

F21 key.

.. _class_@GlobalScope_constant_KEY_F22:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F22** = ``4194353``

F22 key.

.. _class_@GlobalScope_constant_KEY_F23:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F23** = ``4194354``

F23 key.

.. _class_@GlobalScope_constant_KEY_F24:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F24** = ``4194355``

F24 key.

.. _class_@GlobalScope_constant_KEY_F25:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F25** = ``4194356``

F25 key. Only supported on macOS and Linux due to a Windows limitation.

.. _class_@GlobalScope_constant_KEY_F26:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F26** = ``4194357``

F26 key. Only supported on macOS and Linux due to a Windows limitation.

.. _class_@GlobalScope_constant_KEY_F27:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F27** = ``4194358``

F27 key. Only supported on macOS and Linux due to a Windows limitation.

.. _class_@GlobalScope_constant_KEY_F28:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F28** = ``4194359``

F28 key. Only supported on macOS and Linux due to a Windows limitation.

.. _class_@GlobalScope_constant_KEY_F29:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F29** = ``4194360``

F29 key. Only supported on macOS and Linux due to a Windows limitation.

.. _class_@GlobalScope_constant_KEY_F30:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F30** = ``4194361``

F30 key. Only supported on macOS and Linux due to a Windows limitation.

.. _class_@GlobalScope_constant_KEY_F31:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F31** = ``4194362``

F31 key. Only supported on macOS and Linux due to a Windows limitation.

.. _class_@GlobalScope_constant_KEY_F32:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F32** = ``4194363``

F32 key. Only supported on macOS and Linux due to a Windows limitation.

.. _class_@GlobalScope_constant_KEY_F33:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F33** = ``4194364``

F33 key. Only supported on macOS and Linux due to a Windows limitation.

.. _class_@GlobalScope_constant_KEY_F34:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F34** = ``4194365``

F34 key. Only supported on macOS and Linux due to a Windows limitation.

.. _class_@GlobalScope_constant_KEY_F35:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F35** = ``4194366``

F35 key. Only supported on macOS and Linux due to a Windows limitation.

.. _class_@GlobalScope_constant_KEY_KP_MULTIPLY:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_KP_MULTIPLY** = ``4194433``

Multiply (\*) key on the numeric keypad.

.. _class_@GlobalScope_constant_KEY_KP_DIVIDE:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_KP_DIVIDE** = ``4194434``

Divide (/) key on the numeric keypad.

.. _class_@GlobalScope_constant_KEY_KP_SUBTRACT:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_KP_SUBTRACT** = ``4194435``

Subtract (-) key on the numeric keypad.

.. _class_@GlobalScope_constant_KEY_KP_PERIOD:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_KP_PERIOD** = ``4194436``

Period (.) key on the numeric keypad.

.. _class_@GlobalScope_constant_KEY_KP_ADD:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_KP_ADD** = ``4194437``

Add (+) key on the numeric keypad.

.. _class_@GlobalScope_constant_KEY_KP_0:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_KP_0** = ``4194438``

Number 0 on the numeric keypad.

.. _class_@GlobalScope_constant_KEY_KP_1:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_KP_1** = ``4194439``

Number 1 on the numeric keypad.

.. _class_@GlobalScope_constant_KEY_KP_2:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_KP_2** = ``4194440``

Number 2 on the numeric keypad.

.. _class_@GlobalScope_constant_KEY_KP_3:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_KP_3** = ``4194441``

Number 3 on the numeric keypad.

.. _class_@GlobalScope_constant_KEY_KP_4:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_KP_4** = ``4194442``

Number 4 on the numeric keypad.

.. _class_@GlobalScope_constant_KEY_KP_5:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_KP_5** = ``4194443``

Number 5 on the numeric keypad.

.. _class_@GlobalScope_constant_KEY_KP_6:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_KP_6** = ``4194444``

Number 6 on the numeric keypad.

.. _class_@GlobalScope_constant_KEY_KP_7:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_KP_7** = ``4194445``

Number 7 on the numeric keypad.

.. _class_@GlobalScope_constant_KEY_KP_8:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_KP_8** = ``4194446``

Number 8 on the numeric keypad.

.. _class_@GlobalScope_constant_KEY_KP_9:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_KP_9** = ``4194447``

Number 9 on the numeric keypad.

.. _class_@GlobalScope_constant_KEY_MENU:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_MENU** = ``4194370``

Context menu key.

.. _class_@GlobalScope_constant_KEY_HYPER:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_HYPER** = ``4194371``

Hyper key. (On Linux/X11 only).

.. _class_@GlobalScope_constant_KEY_HELP:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_HELP** = ``4194373``

Help key.

.. _class_@GlobalScope_constant_KEY_BACK:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_BACK** = ``4194376``

Media back key. Not to be confused with the Back button on an Android device.

.. _class_@GlobalScope_constant_KEY_FORWARD:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_FORWARD** = ``4194377``

Media forward key.

.. _class_@GlobalScope_constant_KEY_STOP:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_STOP** = ``4194378``

Media stop key.

.. _class_@GlobalScope_constant_KEY_REFRESH:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_REFRESH** = ``4194379``

Media refresh key.

.. _class_@GlobalScope_constant_KEY_VOLUMEDOWN:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_VOLUMEDOWN** = ``4194380``

Volume down key.

.. _class_@GlobalScope_constant_KEY_VOLUMEMUTE:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_VOLUMEMUTE** = ``4194381``

Mute volume key.

.. _class_@GlobalScope_constant_KEY_VOLUMEUP:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_VOLUMEUP** = ``4194382``

Volume up key.

.. _class_@GlobalScope_constant_KEY_MEDIAPLAY:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_MEDIAPLAY** = ``4194388``

Media play key.

.. _class_@GlobalScope_constant_KEY_MEDIASTOP:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_MEDIASTOP** = ``4194389``

Media stop key.

.. _class_@GlobalScope_constant_KEY_MEDIAPREVIOUS:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_MEDIAPREVIOUS** = ``4194390``

Previous song key.

.. _class_@GlobalScope_constant_KEY_MEDIANEXT:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_MEDIANEXT** = ``4194391``

Next song key.

.. _class_@GlobalScope_constant_KEY_MEDIARECORD:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_MEDIARECORD** = ``4194392``

Media record key.

.. _class_@GlobalScope_constant_KEY_HOMEPAGE:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_HOMEPAGE** = ``4194393``

Home page key.

.. _class_@GlobalScope_constant_KEY_FAVORITES:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_FAVORITES** = ``4194394``

Favorites key.

.. _class_@GlobalScope_constant_KEY_SEARCH:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_SEARCH** = ``4194395``

Search key.

.. _class_@GlobalScope_constant_KEY_STANDBY:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_STANDBY** = ``4194396``

Standby key.

.. _class_@GlobalScope_constant_KEY_OPENURL:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_OPENURL** = ``4194397``

Open URL / Launch Browser key.

.. _class_@GlobalScope_constant_KEY_LAUNCHMAIL:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_LAUNCHMAIL** = ``4194398``

Launch Mail key.

.. _class_@GlobalScope_constant_KEY_LAUNCHMEDIA:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_LAUNCHMEDIA** = ``4194399``

Launch Media key.

.. _class_@GlobalScope_constant_KEY_LAUNCH0:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_LAUNCH0** = ``4194400``

Launch Shortcut 0 key.

.. _class_@GlobalScope_constant_KEY_LAUNCH1:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_LAUNCH1** = ``4194401``

Launch Shortcut 1 key.

.. _class_@GlobalScope_constant_KEY_LAUNCH2:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_LAUNCH2** = ``4194402``

Launch Shortcut 2 key.

.. _class_@GlobalScope_constant_KEY_LAUNCH3:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_LAUNCH3** = ``4194403``

Launch Shortcut 3 key.

.. _class_@GlobalScope_constant_KEY_LAUNCH4:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_LAUNCH4** = ``4194404``

Launch Shortcut 4 key.

.. _class_@GlobalScope_constant_KEY_LAUNCH5:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_LAUNCH5** = ``4194405``

Launch Shortcut 5 key.

.. _class_@GlobalScope_constant_KEY_LAUNCH6:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_LAUNCH6** = ``4194406``

Launch Shortcut 6 key.

.. _class_@GlobalScope_constant_KEY_LAUNCH7:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_LAUNCH7** = ``4194407``

Launch Shortcut 7 key.

.. _class_@GlobalScope_constant_KEY_LAUNCH8:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_LAUNCH8** = ``4194408``

Launch Shortcut 8 key.

.. _class_@GlobalScope_constant_KEY_LAUNCH9:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_LAUNCH9** = ``4194409``

Launch Shortcut 9 key.

.. _class_@GlobalScope_constant_KEY_LAUNCHA:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_LAUNCHA** = ``4194410``

Launch Shortcut A key.

.. _class_@GlobalScope_constant_KEY_LAUNCHB:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_LAUNCHB** = ``4194411``

Launch Shortcut B key.

.. _class_@GlobalScope_constant_KEY_LAUNCHC:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_LAUNCHC** = ``4194412``

Launch Shortcut C key.

.. _class_@GlobalScope_constant_KEY_LAUNCHD:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_LAUNCHD** = ``4194413``

Launch Shortcut D key.

.. _class_@GlobalScope_constant_KEY_LAUNCHE:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_LAUNCHE** = ``4194414``

Launch Shortcut E key.

.. _class_@GlobalScope_constant_KEY_LAUNCHF:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_LAUNCHF** = ``4194415``

Launch Shortcut F key.

.. _class_@GlobalScope_constant_KEY_GLOBE:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_GLOBE** = ``4194416``

"Globe" key on Mac / iPad keyboard.

.. _class_@GlobalScope_constant_KEY_KEYBOARD:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_KEYBOARD** = ``4194417``

"On-screen keyboard" key on iPad keyboard.

.. _class_@GlobalScope_constant_KEY_JIS_EISU:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_JIS_EISU** = ``4194418``

英数 key on Mac keyboard.

.. _class_@GlobalScope_constant_KEY_JIS_KANA:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_JIS_KANA** = ``4194419``

かな key on Mac keyboard.

.. _class_@GlobalScope_constant_KEY_UNKNOWN:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_UNKNOWN** = ``8388607``

Unknown key.

.. _class_@GlobalScope_constant_KEY_SPACE:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_SPACE** = ``32``

Space key.

.. _class_@GlobalScope_constant_KEY_EXCLAM:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_EXCLAM** = ``33``

! key.

.. _class_@GlobalScope_constant_KEY_QUOTEDBL:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_QUOTEDBL** = ``34``

" key.

.. _class_@GlobalScope_constant_KEY_NUMBERSIGN:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_NUMBERSIGN** = ``35``

# key.

.. _class_@GlobalScope_constant_KEY_DOLLAR:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_DOLLAR** = ``36``

$ key.

.. _class_@GlobalScope_constant_KEY_PERCENT:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_PERCENT** = ``37``

% key.

.. _class_@GlobalScope_constant_KEY_AMPERSAND:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_AMPERSAND** = ``38``

& key.

.. _class_@GlobalScope_constant_KEY_APOSTROPHE:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_APOSTROPHE** = ``39``

' key.

.. _class_@GlobalScope_constant_KEY_PARENLEFT:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_PARENLEFT** = ``40``

( key.

.. _class_@GlobalScope_constant_KEY_PARENRIGHT:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_PARENRIGHT** = ``41``

) key.

.. _class_@GlobalScope_constant_KEY_ASTERISK:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_ASTERISK** = ``42``

\* key.

.. _class_@GlobalScope_constant_KEY_PLUS:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_PLUS** = ``43``

+ key.

.. _class_@GlobalScope_constant_KEY_COMMA:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_COMMA** = ``44``

, key.

.. _class_@GlobalScope_constant_KEY_MINUS:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_MINUS** = ``45``

- key.

.. _class_@GlobalScope_constant_KEY_PERIOD:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_PERIOD** = ``46``

. key.

.. _class_@GlobalScope_constant_KEY_SLASH:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_SLASH** = ``47``

/ key.

.. _class_@GlobalScope_constant_KEY_0:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_0** = ``48``

Number 0 key.

.. _class_@GlobalScope_constant_KEY_1:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_1** = ``49``

Number 1 key.

.. _class_@GlobalScope_constant_KEY_2:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_2** = ``50``

Number 2 key.

.. _class_@GlobalScope_constant_KEY_3:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_3** = ``51``

Number 3 key.

.. _class_@GlobalScope_constant_KEY_4:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_4** = ``52``

Number 4 key.

.. _class_@GlobalScope_constant_KEY_5:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_5** = ``53``

Number 5 key.

.. _class_@GlobalScope_constant_KEY_6:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_6** = ``54``

Number 6 key.

.. _class_@GlobalScope_constant_KEY_7:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_7** = ``55``

Number 7 key.

.. _class_@GlobalScope_constant_KEY_8:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_8** = ``56``

Number 8 key.

.. _class_@GlobalScope_constant_KEY_9:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_9** = ``57``

Number 9 key.

.. _class_@GlobalScope_constant_KEY_COLON:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_COLON** = ``58``

: key.

.. _class_@GlobalScope_constant_KEY_SEMICOLON:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_SEMICOLON** = ``59``

; key.

.. _class_@GlobalScope_constant_KEY_LESS:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_LESS** = ``60``

< key.

.. _class_@GlobalScope_constant_KEY_EQUAL:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_EQUAL** = ``61``

= key.

.. _class_@GlobalScope_constant_KEY_GREATER:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_GREATER** = ``62``

> key.

.. _class_@GlobalScope_constant_KEY_QUESTION:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_QUESTION** = ``63``

? key.

.. _class_@GlobalScope_constant_KEY_AT:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_AT** = ``64``

@ key.

.. _class_@GlobalScope_constant_KEY_A:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_A** = ``65``

A key.

.. _class_@GlobalScope_constant_KEY_B:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_B** = ``66``

B key.

.. _class_@GlobalScope_constant_KEY_C:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_C** = ``67``

C key.

.. _class_@GlobalScope_constant_KEY_D:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_D** = ``68``

D key.

.. _class_@GlobalScope_constant_KEY_E:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_E** = ``69``

E key.

.. _class_@GlobalScope_constant_KEY_F:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_F** = ``70``

F key.

.. _class_@GlobalScope_constant_KEY_G:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_G** = ``71``

G key.

.. _class_@GlobalScope_constant_KEY_H:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_H** = ``72``

H key.

.. _class_@GlobalScope_constant_KEY_I:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_I** = ``73``

I key.

.. _class_@GlobalScope_constant_KEY_J:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_J** = ``74``

J key.

.. _class_@GlobalScope_constant_KEY_K:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_K** = ``75``

K key.

.. _class_@GlobalScope_constant_KEY_L:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_L** = ``76``

L key.

.. _class_@GlobalScope_constant_KEY_M:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_M** = ``77``

M key.

.. _class_@GlobalScope_constant_KEY_N:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_N** = ``78``

N key.

.. _class_@GlobalScope_constant_KEY_O:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_O** = ``79``

O key.

.. _class_@GlobalScope_constant_KEY_P:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_P** = ``80``

P key.

.. _class_@GlobalScope_constant_KEY_Q:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_Q** = ``81``

Q key.

.. _class_@GlobalScope_constant_KEY_R:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_R** = ``82``

R key.

.. _class_@GlobalScope_constant_KEY_S:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_S** = ``83``

S key.

.. _class_@GlobalScope_constant_KEY_T:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_T** = ``84``

T key.

.. _class_@GlobalScope_constant_KEY_U:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_U** = ``85``

U key.

.. _class_@GlobalScope_constant_KEY_V:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_V** = ``86``

V key.

.. _class_@GlobalScope_constant_KEY_W:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_W** = ``87``

W key.

.. _class_@GlobalScope_constant_KEY_X:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_X** = ``88``

X key.

.. _class_@GlobalScope_constant_KEY_Y:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_Y** = ``89``

Y key.

.. _class_@GlobalScope_constant_KEY_Z:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_Z** = ``90``

Z key.

.. _class_@GlobalScope_constant_KEY_BRACKETLEFT:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_BRACKETLEFT** = ``91``

[ key.

.. _class_@GlobalScope_constant_KEY_BACKSLASH:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_BACKSLASH** = ``92``

\\ key.

.. _class_@GlobalScope_constant_KEY_BRACKETRIGHT:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_BRACKETRIGHT** = ``93``

] key.

.. _class_@GlobalScope_constant_KEY_ASCIICIRCUM:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_ASCIICIRCUM** = ``94``

^ key.

.. _class_@GlobalScope_constant_KEY_UNDERSCORE:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_UNDERSCORE** = ``95``

\_ key.

.. _class_@GlobalScope_constant_KEY_QUOTELEFT:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_QUOTELEFT** = ``96``

` key.

.. _class_@GlobalScope_constant_KEY_BRACELEFT:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_BRACELEFT** = ``123``

{ key.

.. _class_@GlobalScope_constant_KEY_BAR:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_BAR** = ``124``

| key.

.. _class_@GlobalScope_constant_KEY_BRACERIGHT:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_BRACERIGHT** = ``125``

} key.

.. _class_@GlobalScope_constant_KEY_ASCIITILDE:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_ASCIITILDE** = ``126``

~ key.

.. _class_@GlobalScope_constant_KEY_YEN:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_YEN** = ``165``

¥ key.

.. _class_@GlobalScope_constant_KEY_SECTION:

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

:ref:`Key<enum_@GlobalScope_Key>` **KEY_SECTION** = ``167``

§ key.

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

----

.. _enum_@GlobalScope_KeyModifierMask:

.. rst-class:: classref-enumeration

flags **KeyModifierMask**:

.. _class_@GlobalScope_constant_KEY_CODE_MASK:

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

:ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>` **KEY_CODE_MASK** = ``8388607``

Key Code mask.

.. _class_@GlobalScope_constant_KEY_MODIFIER_MASK:

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

:ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>` **KEY_MODIFIER_MASK** = ``532676608``

Modifier key mask.

.. _class_@GlobalScope_constant_KEY_MASK_CMD_OR_CTRL:

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

:ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>` **KEY_MASK_CMD_OR_CTRL** = ``16777216``

Automatically remapped to :ref:`KEY_META<class_@GlobalScope_constant_KEY_META>` on macOS and :ref:`KEY_CTRL<class_@GlobalScope_constant_KEY_CTRL>` on other platforms, this mask is never set in the actual events, and should be used for key mapping only.

.. _class_@GlobalScope_constant_KEY_MASK_SHIFT:

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

:ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>` **KEY_MASK_SHIFT** = ``33554432``

Shift key mask.

.. _class_@GlobalScope_constant_KEY_MASK_ALT:

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

:ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>` **KEY_MASK_ALT** = ``67108864``

Alt or Option (on macOS) key mask.

.. _class_@GlobalScope_constant_KEY_MASK_META:

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

:ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>` **KEY_MASK_META** = ``134217728``

Command (on macOS) or Meta/Windows key mask.

.. _class_@GlobalScope_constant_KEY_MASK_CTRL:

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

:ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>` **KEY_MASK_CTRL** = ``268435456``

Control key mask.

.. _class_@GlobalScope_constant_KEY_MASK_KPAD:

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

:ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>` **KEY_MASK_KPAD** = ``536870912``

Keypad key mask.

.. _class_@GlobalScope_constant_KEY_MASK_GROUP_SWITCH:

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

:ref:`KeyModifierMask<enum_@GlobalScope_KeyModifierMask>` **KEY_MASK_GROUP_SWITCH** = ``1073741824``

Group Switch key mask.

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

----

.. _enum_@GlobalScope_MouseButton:

.. rst-class:: classref-enumeration

enum **MouseButton**:

.. _class_@GlobalScope_constant_MOUSE_BUTTON_NONE:

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

:ref:`MouseButton<enum_@GlobalScope_MouseButton>` **MOUSE_BUTTON_NONE** = ``0``

Enum value which doesn't correspond to any mouse button. This is used to initialize :ref:`MouseButton<enum_@GlobalScope_MouseButton>` properties with a generic state.

.. _class_@GlobalScope_constant_MOUSE_BUTTON_LEFT:

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

:ref:`MouseButton<enum_@GlobalScope_MouseButton>` **MOUSE_BUTTON_LEFT** = ``1``

Primary mouse button, usually assigned to the left button.

.. _class_@GlobalScope_constant_MOUSE_BUTTON_RIGHT:

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

:ref:`MouseButton<enum_@GlobalScope_MouseButton>` **MOUSE_BUTTON_RIGHT** = ``2``

Secondary mouse button, usually assigned to the right button.

.. _class_@GlobalScope_constant_MOUSE_BUTTON_MIDDLE:

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

:ref:`MouseButton<enum_@GlobalScope_MouseButton>` **MOUSE_BUTTON_MIDDLE** = ``3``

Middle mouse button.

.. _class_@GlobalScope_constant_MOUSE_BUTTON_WHEEL_UP:

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

:ref:`MouseButton<enum_@GlobalScope_MouseButton>` **MOUSE_BUTTON_WHEEL_UP** = ``4``

Mouse wheel scrolling up.

.. _class_@GlobalScope_constant_MOUSE_BUTTON_WHEEL_DOWN:

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

:ref:`MouseButton<enum_@GlobalScope_MouseButton>` **MOUSE_BUTTON_WHEEL_DOWN** = ``5``

Mouse wheel scrolling down.

.. _class_@GlobalScope_constant_MOUSE_BUTTON_WHEEL_LEFT:

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

:ref:`MouseButton<enum_@GlobalScope_MouseButton>` **MOUSE_BUTTON_WHEEL_LEFT** = ``6``

Mouse wheel left button (only present on some mice).

.. _class_@GlobalScope_constant_MOUSE_BUTTON_WHEEL_RIGHT:

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

:ref:`MouseButton<enum_@GlobalScope_MouseButton>` **MOUSE_BUTTON_WHEEL_RIGHT** = ``7``

Mouse wheel right button (only present on some mice).

.. _class_@GlobalScope_constant_MOUSE_BUTTON_XBUTTON1:

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

:ref:`MouseButton<enum_@GlobalScope_MouseButton>` **MOUSE_BUTTON_XBUTTON1** = ``8``

Extra mouse button 1. This is sometimes present, usually to the sides of the mouse.

.. _class_@GlobalScope_constant_MOUSE_BUTTON_XBUTTON2:

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

:ref:`MouseButton<enum_@GlobalScope_MouseButton>` **MOUSE_BUTTON_XBUTTON2** = ``9``

Extra mouse button 2. This is sometimes present, usually to the sides of the mouse.

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

----

.. _enum_@GlobalScope_MouseButtonMask:

.. rst-class:: classref-enumeration

flags **MouseButtonMask**:

.. _class_@GlobalScope_constant_MOUSE_BUTTON_MASK_LEFT:

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

:ref:`MouseButtonMask<enum_@GlobalScope_MouseButtonMask>` **MOUSE_BUTTON_MASK_LEFT** = ``1``

Primary mouse button mask, usually for the left button.

.. _class_@GlobalScope_constant_MOUSE_BUTTON_MASK_RIGHT:

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

:ref:`MouseButtonMask<enum_@GlobalScope_MouseButtonMask>` **MOUSE_BUTTON_MASK_RIGHT** = ``2``

Secondary mouse button mask, usually for the right button.

.. _class_@GlobalScope_constant_MOUSE_BUTTON_MASK_MIDDLE:

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

:ref:`MouseButtonMask<enum_@GlobalScope_MouseButtonMask>` **MOUSE_BUTTON_MASK_MIDDLE** = ``4``

Middle mouse button mask.

.. _class_@GlobalScope_constant_MOUSE_BUTTON_MASK_MB_XBUTTON1:

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

:ref:`MouseButtonMask<enum_@GlobalScope_MouseButtonMask>` **MOUSE_BUTTON_MASK_MB_XBUTTON1** = ``128``

Extra mouse button 1 mask.

.. _class_@GlobalScope_constant_MOUSE_BUTTON_MASK_MB_XBUTTON2:

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

:ref:`MouseButtonMask<enum_@GlobalScope_MouseButtonMask>` **MOUSE_BUTTON_MASK_MB_XBUTTON2** = ``256``

Extra mouse button 2 mask.

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

----

.. _enum_@GlobalScope_JoyButton:

.. rst-class:: classref-enumeration

enum **JoyButton**:

.. _class_@GlobalScope_constant_JOY_BUTTON_INVALID:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_INVALID** = ``-1``

An invalid game controller button.

.. _class_@GlobalScope_constant_JOY_BUTTON_A:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_A** = ``0``

Game controller SDL button A. Corresponds to the bottom action button: Sony Cross, Xbox A, Nintendo B.

.. _class_@GlobalScope_constant_JOY_BUTTON_B:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_B** = ``1``

Game controller SDL button B. Corresponds to the right action button: Sony Circle, Xbox B, Nintendo A.

.. _class_@GlobalScope_constant_JOY_BUTTON_X:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_X** = ``2``

Game controller SDL button X. Corresponds to the left action button: Sony Square, Xbox X, Nintendo Y.

.. _class_@GlobalScope_constant_JOY_BUTTON_Y:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_Y** = ``3``

Game controller SDL button Y. Corresponds to the top action button: Sony Triangle, Xbox Y, Nintendo X.

.. _class_@GlobalScope_constant_JOY_BUTTON_BACK:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_BACK** = ``4``

Game controller SDL back button. Corresponds to the Sony Select, Xbox Back, Nintendo - button.

.. _class_@GlobalScope_constant_JOY_BUTTON_GUIDE:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_GUIDE** = ``5``

Game controller SDL guide button. Corresponds to the Sony PS, Xbox Home button.

.. _class_@GlobalScope_constant_JOY_BUTTON_START:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_START** = ``6``

Game controller SDL start button. Corresponds to the Nintendo + button.

.. _class_@GlobalScope_constant_JOY_BUTTON_LEFT_STICK:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_LEFT_STICK** = ``7``

Game controller SDL left stick button. Corresponds to the Sony L3, Xbox L/LS button.

.. _class_@GlobalScope_constant_JOY_BUTTON_RIGHT_STICK:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_RIGHT_STICK** = ``8``

Game controller SDL right stick button. Corresponds to the Sony R3, Xbox R/RS button.

.. _class_@GlobalScope_constant_JOY_BUTTON_LEFT_SHOULDER:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_LEFT_SHOULDER** = ``9``

Game controller SDL left shoulder button. Corresponds to the Sony L1, Xbox LB button.

.. _class_@GlobalScope_constant_JOY_BUTTON_RIGHT_SHOULDER:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_RIGHT_SHOULDER** = ``10``

Game controller SDL right shoulder button. Corresponds to the Sony R1, Xbox RB button.

.. _class_@GlobalScope_constant_JOY_BUTTON_DPAD_UP:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_DPAD_UP** = ``11``

Game controller D-pad up button.

.. _class_@GlobalScope_constant_JOY_BUTTON_DPAD_DOWN:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_DPAD_DOWN** = ``12``

Game controller D-pad down button.

.. _class_@GlobalScope_constant_JOY_BUTTON_DPAD_LEFT:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_DPAD_LEFT** = ``13``

Game controller D-pad left button.

.. _class_@GlobalScope_constant_JOY_BUTTON_DPAD_RIGHT:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_DPAD_RIGHT** = ``14``

Game controller D-pad right button.

.. _class_@GlobalScope_constant_JOY_BUTTON_MISC1:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_MISC1** = ``15``

Game controller SDL miscellaneous button. Corresponds to Xbox share button, PS5 microphone button, Nintendo Switch capture button.

.. _class_@GlobalScope_constant_JOY_BUTTON_PADDLE1:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_PADDLE1** = ``16``

Game controller SDL paddle 1 button.

.. _class_@GlobalScope_constant_JOY_BUTTON_PADDLE2:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_PADDLE2** = ``17``

Game controller SDL paddle 2 button.

.. _class_@GlobalScope_constant_JOY_BUTTON_PADDLE3:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_PADDLE3** = ``18``

Game controller SDL paddle 3 button.

.. _class_@GlobalScope_constant_JOY_BUTTON_PADDLE4:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_PADDLE4** = ``19``

Game controller SDL paddle 4 button.

.. _class_@GlobalScope_constant_JOY_BUTTON_TOUCHPAD:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_TOUCHPAD** = ``20``

Game controller SDL touchpad button.

.. _class_@GlobalScope_constant_JOY_BUTTON_SDL_MAX:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_SDL_MAX** = ``21``

The number of SDL game controller buttons.

.. _class_@GlobalScope_constant_JOY_BUTTON_MAX:

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

:ref:`JoyButton<enum_@GlobalScope_JoyButton>` **JOY_BUTTON_MAX** = ``128``

The maximum number of game controller buttons supported by the engine. The actual limit may be lower on specific platforms:

- **Android:** Up to 36 buttons.

- **Linux:** Up to 80 buttons.

- **Windows** and **macOS:** Up to 128 buttons.

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

----

.. _enum_@GlobalScope_JoyAxis:

.. rst-class:: classref-enumeration

enum **JoyAxis**:

.. _class_@GlobalScope_constant_JOY_AXIS_INVALID:

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

:ref:`JoyAxis<enum_@GlobalScope_JoyAxis>` **JOY_AXIS_INVALID** = ``-1``

An invalid game controller axis.

.. _class_@GlobalScope_constant_JOY_AXIS_LEFT_X:

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

:ref:`JoyAxis<enum_@GlobalScope_JoyAxis>` **JOY_AXIS_LEFT_X** = ``0``

Game controller left joystick x-axis.

.. _class_@GlobalScope_constant_JOY_AXIS_LEFT_Y:

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

:ref:`JoyAxis<enum_@GlobalScope_JoyAxis>` **JOY_AXIS_LEFT_Y** = ``1``

Game controller left joystick y-axis.

.. _class_@GlobalScope_constant_JOY_AXIS_RIGHT_X:

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

:ref:`JoyAxis<enum_@GlobalScope_JoyAxis>` **JOY_AXIS_RIGHT_X** = ``2``

Game controller right joystick x-axis.

.. _class_@GlobalScope_constant_JOY_AXIS_RIGHT_Y:

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

:ref:`JoyAxis<enum_@GlobalScope_JoyAxis>` **JOY_AXIS_RIGHT_Y** = ``3``

Game controller right joystick y-axis.

.. _class_@GlobalScope_constant_JOY_AXIS_TRIGGER_LEFT:

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

:ref:`JoyAxis<enum_@GlobalScope_JoyAxis>` **JOY_AXIS_TRIGGER_LEFT** = ``4``

Game controller left trigger axis.

.. _class_@GlobalScope_constant_JOY_AXIS_TRIGGER_RIGHT:

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

:ref:`JoyAxis<enum_@GlobalScope_JoyAxis>` **JOY_AXIS_TRIGGER_RIGHT** = ``5``

Game controller right trigger axis.

.. _class_@GlobalScope_constant_JOY_AXIS_SDL_MAX:

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

:ref:`JoyAxis<enum_@GlobalScope_JoyAxis>` **JOY_AXIS_SDL_MAX** = ``6``

The number of SDL game controller axes.

.. _class_@GlobalScope_constant_JOY_AXIS_MAX:

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

:ref:`JoyAxis<enum_@GlobalScope_JoyAxis>` **JOY_AXIS_MAX** = ``10``

The maximum number of game controller axes: OpenVR supports up to 5 Joysticks making a total of 10 axes.

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

----

.. _enum_@GlobalScope_MIDIMessage:

.. rst-class:: classref-enumeration

enum **MIDIMessage**:

.. _class_@GlobalScope_constant_MIDI_MESSAGE_NONE:

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

:ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` **MIDI_MESSAGE_NONE** = ``0``

Enum value which doesn't correspond to any MIDI message. This is used to initialize :ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` properties with a generic state.

.. _class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_OFF:

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

:ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` **MIDI_MESSAGE_NOTE_OFF** = ``8``

MIDI note OFF message. Not all MIDI devices send this event; some send :ref:`MIDI_MESSAGE_NOTE_ON<class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_ON>` with zero velocity instead. See the documentation of :ref:`InputEventMIDI<class_InputEventMIDI>` for information of how to use MIDI inputs.

.. _class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_ON:

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

:ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` **MIDI_MESSAGE_NOTE_ON** = ``9``

MIDI note ON message. Some MIDI devices send this event with velocity zero instead of :ref:`MIDI_MESSAGE_NOTE_OFF<class_@GlobalScope_constant_MIDI_MESSAGE_NOTE_OFF>`, but implementations vary. See the documentation of :ref:`InputEventMIDI<class_InputEventMIDI>` for information of how to use MIDI inputs.

.. _class_@GlobalScope_constant_MIDI_MESSAGE_AFTERTOUCH:

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

:ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` **MIDI_MESSAGE_AFTERTOUCH** = ``10``

MIDI aftertouch message. This message is most often sent by pressing down on the key after it "bottoms out".

.. _class_@GlobalScope_constant_MIDI_MESSAGE_CONTROL_CHANGE:

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

:ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` **MIDI_MESSAGE_CONTROL_CHANGE** = ``11``

MIDI control change message. This message is sent when a controller value changes. Controllers include devices such as pedals and levers.

.. _class_@GlobalScope_constant_MIDI_MESSAGE_PROGRAM_CHANGE:

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

:ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` **MIDI_MESSAGE_PROGRAM_CHANGE** = ``12``

MIDI program change message. This message sent when the program patch number changes.

.. _class_@GlobalScope_constant_MIDI_MESSAGE_CHANNEL_PRESSURE:

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

:ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` **MIDI_MESSAGE_CHANNEL_PRESSURE** = ``13``

MIDI channel pressure message. This message is most often sent by pressing down on the key after it "bottoms out". This message is different from polyphonic after-touch as it indicates the highest pressure across all keys.

.. _class_@GlobalScope_constant_MIDI_MESSAGE_PITCH_BEND:

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

:ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` **MIDI_MESSAGE_PITCH_BEND** = ``14``

MIDI pitch bend message. This message is sent to indicate a change in the pitch bender (wheel or lever, typically).

.. _class_@GlobalScope_constant_MIDI_MESSAGE_SYSTEM_EXCLUSIVE:

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

:ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` **MIDI_MESSAGE_SYSTEM_EXCLUSIVE** = ``240``

MIDI system exclusive message. This has behavior exclusive to the device you're receiving input from. Getting this data is not implemented in Godot.

.. _class_@GlobalScope_constant_MIDI_MESSAGE_QUARTER_FRAME:

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

:ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` **MIDI_MESSAGE_QUARTER_FRAME** = ``241``

MIDI quarter frame message. Contains timing information that is used to synchronize MIDI devices. Getting this data is not implemented in Godot.

.. _class_@GlobalScope_constant_MIDI_MESSAGE_SONG_POSITION_POINTER:

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

:ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` **MIDI_MESSAGE_SONG_POSITION_POINTER** = ``242``

MIDI song position pointer message. Gives the number of 16th notes since the start of the song. Getting this data is not implemented in Godot.

.. _class_@GlobalScope_constant_MIDI_MESSAGE_SONG_SELECT:

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

:ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` **MIDI_MESSAGE_SONG_SELECT** = ``243``

MIDI song select message. Specifies which sequence or song is to be played. Getting this data is not implemented in Godot.

.. _class_@GlobalScope_constant_MIDI_MESSAGE_TUNE_REQUEST:

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

:ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` **MIDI_MESSAGE_TUNE_REQUEST** = ``246``

MIDI tune request message. Upon receiving a tune request, all analog synthesizers should tune their oscillators.

.. _class_@GlobalScope_constant_MIDI_MESSAGE_TIMING_CLOCK:

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

:ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` **MIDI_MESSAGE_TIMING_CLOCK** = ``248``

MIDI timing clock message. Sent 24 times per quarter note when synchronization is required.

.. _class_@GlobalScope_constant_MIDI_MESSAGE_START:

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

:ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` **MIDI_MESSAGE_START** = ``250``

MIDI start message. Start the current sequence playing. This message will be followed with Timing Clocks.

.. _class_@GlobalScope_constant_MIDI_MESSAGE_CONTINUE:

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

:ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` **MIDI_MESSAGE_CONTINUE** = ``251``

MIDI continue message. Continue at the point the sequence was stopped.

.. _class_@GlobalScope_constant_MIDI_MESSAGE_STOP:

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

:ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` **MIDI_MESSAGE_STOP** = ``252``

MIDI stop message. Stop the current sequence.

.. _class_@GlobalScope_constant_MIDI_MESSAGE_ACTIVE_SENSING:

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

:ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` **MIDI_MESSAGE_ACTIVE_SENSING** = ``254``

MIDI active sensing message. This message is intended to be sent repeatedly to tell the receiver that a connection is alive.

.. _class_@GlobalScope_constant_MIDI_MESSAGE_SYSTEM_RESET:

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

:ref:`MIDIMessage<enum_@GlobalScope_MIDIMessage>` **MIDI_MESSAGE_SYSTEM_RESET** = ``255``

MIDI system reset message. Reset all receivers in the system to power-up status. It should not be sent on power-up itself.

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

----

.. _enum_@GlobalScope_Error:

.. rst-class:: classref-enumeration

enum **Error**:

.. _class_@GlobalScope_constant_OK:

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

:ref:`Error<enum_@GlobalScope_Error>` **OK** = ``0``

Methods that return :ref:`Error<enum_@GlobalScope_Error>` return :ref:`OK<class_@GlobalScope_constant_OK>` when no error occurred.

Since :ref:`OK<class_@GlobalScope_constant_OK>` has value 0, and all other error constants are positive integers, it can also be used in boolean checks.

\ **Example:**\ 

::

    var error = method_that_returns_error()
    if error != OK:
        printerr("Failure!")
    
    # Or, alternatively:
    if error:
        printerr("Still failing!")

\ **Note:** Many functions do not return an error code, but will print error messages to standard output.

.. _class_@GlobalScope_constant_FAILED:

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

:ref:`Error<enum_@GlobalScope_Error>` **FAILED** = ``1``

Generic error.

.. _class_@GlobalScope_constant_ERR_UNAVAILABLE:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_UNAVAILABLE** = ``2``

Unavailable error.

.. _class_@GlobalScope_constant_ERR_UNCONFIGURED:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_UNCONFIGURED** = ``3``

Unconfigured error.

.. _class_@GlobalScope_constant_ERR_UNAUTHORIZED:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_UNAUTHORIZED** = ``4``

Unauthorized error.

.. _class_@GlobalScope_constant_ERR_PARAMETER_RANGE_ERROR:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_PARAMETER_RANGE_ERROR** = ``5``

Parameter range error.

.. _class_@GlobalScope_constant_ERR_OUT_OF_MEMORY:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_OUT_OF_MEMORY** = ``6``

Out of memory (OOM) error.

.. _class_@GlobalScope_constant_ERR_FILE_NOT_FOUND:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_FILE_NOT_FOUND** = ``7``

File: Not found error.

.. _class_@GlobalScope_constant_ERR_FILE_BAD_DRIVE:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_FILE_BAD_DRIVE** = ``8``

File: Bad drive error.

.. _class_@GlobalScope_constant_ERR_FILE_BAD_PATH:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_FILE_BAD_PATH** = ``9``

File: Bad path error.

.. _class_@GlobalScope_constant_ERR_FILE_NO_PERMISSION:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_FILE_NO_PERMISSION** = ``10``

File: No permission error.

.. _class_@GlobalScope_constant_ERR_FILE_ALREADY_IN_USE:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_FILE_ALREADY_IN_USE** = ``11``

File: Already in use error.

.. _class_@GlobalScope_constant_ERR_FILE_CANT_OPEN:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_FILE_CANT_OPEN** = ``12``

File: Can't open error.

.. _class_@GlobalScope_constant_ERR_FILE_CANT_WRITE:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_FILE_CANT_WRITE** = ``13``

File: Can't write error.

.. _class_@GlobalScope_constant_ERR_FILE_CANT_READ:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_FILE_CANT_READ** = ``14``

File: Can't read error.

.. _class_@GlobalScope_constant_ERR_FILE_UNRECOGNIZED:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_FILE_UNRECOGNIZED** = ``15``

File: Unrecognized error.

.. _class_@GlobalScope_constant_ERR_FILE_CORRUPT:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_FILE_CORRUPT** = ``16``

File: Corrupt error.

.. _class_@GlobalScope_constant_ERR_FILE_MISSING_DEPENDENCIES:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_FILE_MISSING_DEPENDENCIES** = ``17``

File: Missing dependencies error.

.. _class_@GlobalScope_constant_ERR_FILE_EOF:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_FILE_EOF** = ``18``

File: End of file (EOF) error.

.. _class_@GlobalScope_constant_ERR_CANT_OPEN:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_CANT_OPEN** = ``19``

Can't open error.

.. _class_@GlobalScope_constant_ERR_CANT_CREATE:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_CANT_CREATE** = ``20``

Can't create error.

.. _class_@GlobalScope_constant_ERR_QUERY_FAILED:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_QUERY_FAILED** = ``21``

Query failed error.

.. _class_@GlobalScope_constant_ERR_ALREADY_IN_USE:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_ALREADY_IN_USE** = ``22``

Already in use error.

.. _class_@GlobalScope_constant_ERR_LOCKED:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_LOCKED** = ``23``

Locked error.

.. _class_@GlobalScope_constant_ERR_TIMEOUT:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_TIMEOUT** = ``24``

Timeout error.

.. _class_@GlobalScope_constant_ERR_CANT_CONNECT:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_CANT_CONNECT** = ``25``

Can't connect error.

.. _class_@GlobalScope_constant_ERR_CANT_RESOLVE:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_CANT_RESOLVE** = ``26``

Can't resolve error.

.. _class_@GlobalScope_constant_ERR_CONNECTION_ERROR:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_CONNECTION_ERROR** = ``27``

Connection error.

.. _class_@GlobalScope_constant_ERR_CANT_ACQUIRE_RESOURCE:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_CANT_ACQUIRE_RESOURCE** = ``28``

Can't acquire resource error.

.. _class_@GlobalScope_constant_ERR_CANT_FORK:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_CANT_FORK** = ``29``

Can't fork process error.

.. _class_@GlobalScope_constant_ERR_INVALID_DATA:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_INVALID_DATA** = ``30``

Invalid data error.

.. _class_@GlobalScope_constant_ERR_INVALID_PARAMETER:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_INVALID_PARAMETER** = ``31``

Invalid parameter error.

.. _class_@GlobalScope_constant_ERR_ALREADY_EXISTS:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_ALREADY_EXISTS** = ``32``

Already exists error.

.. _class_@GlobalScope_constant_ERR_DOES_NOT_EXIST:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_DOES_NOT_EXIST** = ``33``

Does not exist error.

.. _class_@GlobalScope_constant_ERR_DATABASE_CANT_READ:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_DATABASE_CANT_READ** = ``34``

Database: Read error.

.. _class_@GlobalScope_constant_ERR_DATABASE_CANT_WRITE:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_DATABASE_CANT_WRITE** = ``35``

Database: Write error.

.. _class_@GlobalScope_constant_ERR_COMPILATION_FAILED:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_COMPILATION_FAILED** = ``36``

Compilation failed error.

.. _class_@GlobalScope_constant_ERR_METHOD_NOT_FOUND:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_METHOD_NOT_FOUND** = ``37``

Method not found error.

.. _class_@GlobalScope_constant_ERR_LINK_FAILED:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_LINK_FAILED** = ``38``

Linking failed error.

.. _class_@GlobalScope_constant_ERR_SCRIPT_FAILED:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_SCRIPT_FAILED** = ``39``

Script failed error.

.. _class_@GlobalScope_constant_ERR_CYCLIC_LINK:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_CYCLIC_LINK** = ``40``

Cycling link (import cycle) error.

.. _class_@GlobalScope_constant_ERR_INVALID_DECLARATION:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_INVALID_DECLARATION** = ``41``

Invalid declaration error.

.. _class_@GlobalScope_constant_ERR_DUPLICATE_SYMBOL:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_DUPLICATE_SYMBOL** = ``42``

Duplicate symbol error.

.. _class_@GlobalScope_constant_ERR_PARSE_ERROR:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_PARSE_ERROR** = ``43``

Parse error.

.. _class_@GlobalScope_constant_ERR_BUSY:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_BUSY** = ``44``

Busy error.

.. _class_@GlobalScope_constant_ERR_SKIP:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_SKIP** = ``45``

Skip error.

.. _class_@GlobalScope_constant_ERR_HELP:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_HELP** = ``46``

Help error. Used internally when passing ``--version`` or ``--help`` as executable options.

.. _class_@GlobalScope_constant_ERR_BUG:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_BUG** = ``47``

Bug error, caused by an implementation issue in the method.

\ **Note:** If a built-in method returns this code, please open an issue on `the GitHub Issue Tracker <https://github.com/godotengine/godot/issues>`__.

.. _class_@GlobalScope_constant_ERR_PRINTER_ON_FIRE:

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

:ref:`Error<enum_@GlobalScope_Error>` **ERR_PRINTER_ON_FIRE** = ``48``

Printer on fire error (This is an easter egg, no built-in methods return this error code).

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

----

.. _enum_@GlobalScope_PropertyHint:

.. rst-class:: classref-enumeration

enum **PropertyHint**:

.. _class_@GlobalScope_constant_PROPERTY_HINT_NONE:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_NONE** = ``0``

The property has no hint for the editor.

.. _class_@GlobalScope_constant_PROPERTY_HINT_RANGE:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_RANGE** = ``1``

Hints that an :ref:`int<class_int>` or :ref:`float<class_float>` property should be within a range specified via the hint string ``"min,max"`` or ``"min,max,step"``. The hint string can optionally include ``"or_greater"`` and/or ``"or_less"`` to allow manual input going respectively above the max or below the min values.

\ **Example:** ``"-360,360,1,or_greater,or_less"``.

Additionally, other keywords can be included: ``"exp"`` for exponential range editing, ``"radians"`` for editing radian angles in degrees, ``"degrees"`` to hint at an angle and ``"hide_slider"`` to hide the slider.

.. _class_@GlobalScope_constant_PROPERTY_HINT_ENUM:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_ENUM** = ``2``

Hints that an :ref:`int<class_int>` or :ref:`String<class_String>` property is an enumerated value to pick in a list specified via a hint string.

The hint string is a comma separated list of names such as ``"Hello,Something,Else"``. Whitespaces are **not** removed from either end of a name. For integer properties, the first name in the list has value 0, the next 1, and so on. Explicit values can also be specified by appending ``:integer`` to the name, e.g. ``"Zero,One,Three:3,Four,Six:6"``.

.. _class_@GlobalScope_constant_PROPERTY_HINT_ENUM_SUGGESTION:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_ENUM_SUGGESTION** = ``3``

Hints that a :ref:`String<class_String>` property can be an enumerated value to pick in a list specified via a hint string such as ``"Hello,Something,Else"``.

Unlike :ref:`PROPERTY_HINT_ENUM<class_@GlobalScope_constant_PROPERTY_HINT_ENUM>`, a property with this hint still accepts arbitrary values and can be empty. The list of values serves to suggest possible values.

.. _class_@GlobalScope_constant_PROPERTY_HINT_EXP_EASING:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_EXP_EASING** = ``4``

Hints that a :ref:`float<class_float>` property should be edited via an exponential easing function. The hint string can include ``"attenuation"`` to flip the curve horizontally and/or ``"positive_only"`` to exclude in/out easing and limit values to be greater than or equal to zero.

.. _class_@GlobalScope_constant_PROPERTY_HINT_LINK:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_LINK** = ``5``

Hints that a vector property should allow its components to be linked. For example, this allows :ref:`Vector2.x<class_Vector2_property_x>` and :ref:`Vector2.y<class_Vector2_property_y>` to be edited together.

.. _class_@GlobalScope_constant_PROPERTY_HINT_FLAGS:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_FLAGS** = ``6``

Hints that an :ref:`int<class_int>` property is a bitmask with named bit flags.

The hint string is a comma separated list of names such as ``"Bit0,Bit1,Bit2,Bit3"``. Whitespaces are **not** removed from either end of a name. The first name in the list has value 1, the next 2, then 4, 8, 16 and so on. Explicit values can also be specified by appending ``:integer`` to the name, e.g. ``"A:4,B:8,C:16"``. You can also combine several flags (``"A:4,B:8,AB:12,C:16"``).

\ **Note:** A flag value must be at least ``1`` and at most ``2 ** 32 - 1``.

\ **Note:** Unlike :ref:`PROPERTY_HINT_ENUM<class_@GlobalScope_constant_PROPERTY_HINT_ENUM>`, the previous explicit value is not taken into account. For the hint ``"A:16,B,C"``, A is 16, B is 2, C is 4.

.. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_2D_RENDER:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_LAYERS_2D_RENDER** = ``7``

Hints that an :ref:`int<class_int>` property is a bitmask using the optionally named 2D render layers.

.. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_2D_PHYSICS:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_LAYERS_2D_PHYSICS** = ``8``

Hints that an :ref:`int<class_int>` property is a bitmask using the optionally named 2D physics layers.

.. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_2D_NAVIGATION:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_LAYERS_2D_NAVIGATION** = ``9``

Hints that an :ref:`int<class_int>` property is a bitmask using the optionally named 2D navigation layers.

.. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_3D_RENDER:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_LAYERS_3D_RENDER** = ``10``

Hints that an :ref:`int<class_int>` property is a bitmask using the optionally named 3D render layers.

.. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_3D_PHYSICS:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_LAYERS_3D_PHYSICS** = ``11``

Hints that an :ref:`int<class_int>` property is a bitmask using the optionally named 3D physics layers.

.. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_3D_NAVIGATION:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_LAYERS_3D_NAVIGATION** = ``12``

Hints that an :ref:`int<class_int>` property is a bitmask using the optionally named 3D navigation layers.

.. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_AVOIDANCE:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_LAYERS_AVOIDANCE** = ``37``

Hints that an integer property is a bitmask using the optionally named avoidance layers.

.. _class_@GlobalScope_constant_PROPERTY_HINT_FILE:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_FILE** = ``13``

Hints that a :ref:`String<class_String>` property is a path to a file. Editing it will show a file dialog for picking the path. The hint string can be a set of filters with wildcards like ``"*.png,*.jpg"``.

.. _class_@GlobalScope_constant_PROPERTY_HINT_DIR:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_DIR** = ``14``

Hints that a :ref:`String<class_String>` property is a path to a directory. Editing it will show a file dialog for picking the path.

.. _class_@GlobalScope_constant_PROPERTY_HINT_GLOBAL_FILE:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_GLOBAL_FILE** = ``15``

Hints that a :ref:`String<class_String>` property is an absolute path to a file outside the project folder. Editing it will show a file dialog for picking the path. The hint string can be a set of filters with wildcards, like ``"*.png,*.jpg"``.

.. _class_@GlobalScope_constant_PROPERTY_HINT_GLOBAL_DIR:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_GLOBAL_DIR** = ``16``

Hints that a :ref:`String<class_String>` property is an absolute path to a directory outside the project folder. Editing it will show a file dialog for picking the path.

.. _class_@GlobalScope_constant_PROPERTY_HINT_RESOURCE_TYPE:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_RESOURCE_TYPE** = ``17``

Hints that a property is an instance of a :ref:`Resource<class_Resource>`-derived type, optionally specified via the hint string (e.g. ``"Texture2D"``). Editing it will show a popup menu of valid resource types to instantiate.

.. _class_@GlobalScope_constant_PROPERTY_HINT_MULTILINE_TEXT:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_MULTILINE_TEXT** = ``18``

Hints that a :ref:`String<class_String>` property is text with line breaks. Editing it will show a text input field where line breaks can be typed.

.. _class_@GlobalScope_constant_PROPERTY_HINT_EXPRESSION:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_EXPRESSION** = ``19``

Hints that a :ref:`String<class_String>` property is an :ref:`Expression<class_Expression>`.

.. _class_@GlobalScope_constant_PROPERTY_HINT_PLACEHOLDER_TEXT:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_PLACEHOLDER_TEXT** = ``20``

Hints that a :ref:`String<class_String>` property should show a placeholder text on its input field, if empty. The hint string is the placeholder text to use.

.. _class_@GlobalScope_constant_PROPERTY_HINT_COLOR_NO_ALPHA:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_COLOR_NO_ALPHA** = ``21``

Hints that a :ref:`Color<class_Color>` property should be edited without affecting its transparency (:ref:`Color.a<class_Color_property_a>` is not editable).

.. _class_@GlobalScope_constant_PROPERTY_HINT_OBJECT_ID:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_OBJECT_ID** = ``22``



.. _class_@GlobalScope_constant_PROPERTY_HINT_TYPE_STRING:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_TYPE_STRING** = ``23``

If a property is :ref:`String<class_String>`, hints that the property represents a particular type (class). This allows to select a type from the create dialog. The property will store the selected type as a string.

If a property is :ref:`Array<class_Array>`, hints the editor how to show elements. The ``hint_string`` must encode nested types using ``":"`` and ``"/"``.


.. tabs::

 .. code-tab:: gdscript

    # Array of elem_type.
    hint_string = "%d:" % [elem_type]
    hint_string = "%d/%d:%s" % [elem_type, elem_hint, elem_hint_string]
    # Two-dimensional array of elem_type (array of arrays of elem_type).
    hint_string = "%d:%d:" % [TYPE_ARRAY, elem_type]
    hint_string = "%d:%d/%d:%s" % [TYPE_ARRAY, elem_type, elem_hint, elem_hint_string]
    # Three-dimensional array of elem_type (array of arrays of arrays of elem_type).
    hint_string = "%d:%d:%d:" % [TYPE_ARRAY, TYPE_ARRAY, elem_type]
    hint_string = "%d:%d:%d/%d:%s" % [TYPE_ARRAY, TYPE_ARRAY, elem_type, elem_hint, elem_hint_string]

 .. code-tab:: csharp

    // Array of elemType.
    hintString = $"{elemType:D}:";
    hintString = $"{elemType:}/{elemHint:D}:{elemHintString}";
    // Two-dimensional array of elemType (array of arrays of elemType).
    hintString = $"{Variant.Type.Array:D}:{elemType:D}:";
    hintString = $"{Variant.Type.Array:D}:{elemType:D}/{elemHint:D}:{elemHintString}";
    // Three-dimensional array of elemType (array of arrays of arrays of elemType).
    hintString = $"{Variant.Type.Array:D}:{Variant.Type.Array:D}:{elemType:D}:";
    hintString = $"{Variant.Type.Array:D}:{Variant.Type.Array:D}:{elemType:D}/{elemHint:D}:{elemHintString}";



Examples:


.. tabs::

 .. code-tab:: gdscript

    hint_string = "%d:" % [TYPE_INT] # Array of integers.
    hint_string = "%d/%d:1,10,1" % [TYPE_INT, PROPERTY_HINT_RANGE] # Array of integers (in range from 1 to 10).
    hint_string = "%d/%d:Zero,One,Two" % [TYPE_INT, PROPERTY_HINT_ENUM] # Array of integers (an enum).
    hint_string = "%d/%d:Zero,One,Three:3,Six:6" % [TYPE_INT, PROPERTY_HINT_ENUM] # Array of integers (an enum).
    hint_string = "%d/%d:*.png" % [TYPE_STRING, PROPERTY_HINT_FILE] # Array of strings (file paths).
    hint_string = "%d/%d:Texture2D" % [TYPE_OBJECT, PROPERTY_HINT_RESOURCE_TYPE] # Array of textures.
    
    hint_string = "%d:%d:" % [TYPE_ARRAY, TYPE_FLOAT] # Two-dimensional array of floats.
    hint_string = "%d:%d/%d:" % [TYPE_ARRAY, TYPE_STRING, PROPERTY_HINT_MULTILINE_TEXT] # Two-dimensional array of multiline strings.
    hint_string = "%d:%d/%d:-1,1,0.1" % [TYPE_ARRAY, TYPE_FLOAT, PROPERTY_HINT_RANGE] # Two-dimensional array of floats (in range from -1 to 1).
    hint_string = "%d:%d/%d:Texture2D" % [TYPE_ARRAY, TYPE_OBJECT, PROPERTY_HINT_RESOURCE_TYPE] # Two-dimensional array of textures.

 .. code-tab:: csharp

    hintString = $"{Variant.Type.Int:D}/{PropertyHint.Range:D}:1,10,1"; // Array of integers (in range from 1 to 10).
    hintString = $"{Variant.Type.Int:D}/{PropertyHint.Enum:D}:Zero,One,Two"; // Array of integers (an enum).
    hintString = $"{Variant.Type.Int:D}/{PropertyHint.Enum:D}:Zero,One,Three:3,Six:6"; // Array of integers (an enum).
    hintString = $"{Variant.Type.String:D}/{PropertyHint.File:D}:*.png"; // Array of strings (file paths).
    hintString = $"{Variant.Type.Object:D}/{PropertyHint.ResourceType:D}:Texture2D"; // Array of textures.
    
    hintString = $"{Variant.Type.Array:D}:{Variant.Type.Float:D}:"; // Two-dimensional array of floats.
    hintString = $"{Variant.Type.Array:D}:{Variant.Type.String:D}/{PropertyHint.MultilineText:D}:"; // Two-dimensional array of multiline strings.
    hintString = $"{Variant.Type.Array:D}:{Variant.Type.Float:D}/{PropertyHint.Range:D}:-1,1,0.1"; // Two-dimensional array of floats (in range from -1 to 1).
    hintString = $"{Variant.Type.Array:D}:{Variant.Type.Object:D}/{PropertyHint.ResourceType:D}:Texture2D"; // Two-dimensional array of textures.



\ **Note:** The trailing colon is required for properly detecting built-in types.

.. _class_@GlobalScope_constant_PROPERTY_HINT_NODE_PATH_TO_EDITED_NODE:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_NODE_PATH_TO_EDITED_NODE** = ``24``



.. _class_@GlobalScope_constant_PROPERTY_HINT_OBJECT_TOO_BIG:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_OBJECT_TOO_BIG** = ``25``



.. _class_@GlobalScope_constant_PROPERTY_HINT_NODE_PATH_VALID_TYPES:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_NODE_PATH_VALID_TYPES** = ``26``



.. _class_@GlobalScope_constant_PROPERTY_HINT_SAVE_FILE:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_SAVE_FILE** = ``27``



.. _class_@GlobalScope_constant_PROPERTY_HINT_GLOBAL_SAVE_FILE:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_GLOBAL_SAVE_FILE** = ``28``



.. _class_@GlobalScope_constant_PROPERTY_HINT_INT_IS_OBJECTID:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_INT_IS_OBJECTID** = ``29``



.. _class_@GlobalScope_constant_PROPERTY_HINT_INT_IS_POINTER:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_INT_IS_POINTER** = ``30``



.. _class_@GlobalScope_constant_PROPERTY_HINT_ARRAY_TYPE:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_ARRAY_TYPE** = ``31``



.. _class_@GlobalScope_constant_PROPERTY_HINT_LOCALE_ID:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_LOCALE_ID** = ``32``

Hints that a string property is a locale code. Editing it will show a locale dialog for picking language and country.

.. _class_@GlobalScope_constant_PROPERTY_HINT_LOCALIZABLE_STRING:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_LOCALIZABLE_STRING** = ``33``

Hints that a dictionary property is string translation map. Dictionary keys are locale codes and, values are translated strings.

.. _class_@GlobalScope_constant_PROPERTY_HINT_NODE_TYPE:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_NODE_TYPE** = ``34``



.. _class_@GlobalScope_constant_PROPERTY_HINT_HIDE_QUATERNION_EDIT:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_HIDE_QUATERNION_EDIT** = ``35``

Hints that a quaternion property should disable the temporary euler editor.

.. _class_@GlobalScope_constant_PROPERTY_HINT_PASSWORD:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_PASSWORD** = ``36``

Hints that a string property is a password, and every character is replaced with the secret character.

.. _class_@GlobalScope_constant_PROPERTY_HINT_MAX:

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

:ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` **PROPERTY_HINT_MAX** = ``38``

Represents the size of the :ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` enum.

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

----

.. _enum_@GlobalScope_PropertyUsageFlags:

.. rst-class:: classref-enumeration

flags **PropertyUsageFlags**:

.. _class_@GlobalScope_constant_PROPERTY_USAGE_NONE:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_NONE** = ``0``

The property is not stored, and does not display in the editor. This is the default for non-exported properties.

.. _class_@GlobalScope_constant_PROPERTY_USAGE_STORAGE:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_STORAGE** = ``2``

The property is serialized and saved in the scene file (default).

.. _class_@GlobalScope_constant_PROPERTY_USAGE_EDITOR:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_EDITOR** = ``4``

The property is shown in the :ref:`EditorInspector<class_EditorInspector>` (default).

.. _class_@GlobalScope_constant_PROPERTY_USAGE_INTERNAL:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_INTERNAL** = ``8``

The property is excluded from the class reference.

.. _class_@GlobalScope_constant_PROPERTY_USAGE_CHECKABLE:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_CHECKABLE** = ``16``

The property can be checked in the :ref:`EditorInspector<class_EditorInspector>`.

.. _class_@GlobalScope_constant_PROPERTY_USAGE_CHECKED:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_CHECKED** = ``32``

The property is checked in the :ref:`EditorInspector<class_EditorInspector>`.

.. _class_@GlobalScope_constant_PROPERTY_USAGE_GROUP:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_GROUP** = ``64``

Used to group properties together in the editor. See :ref:`EditorInspector<class_EditorInspector>`.

.. _class_@GlobalScope_constant_PROPERTY_USAGE_CATEGORY:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_CATEGORY** = ``128``

Used to categorize properties together in the editor.

.. _class_@GlobalScope_constant_PROPERTY_USAGE_SUBGROUP:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_SUBGROUP** = ``256``

Used to group properties together in the editor in a subgroup (under a group). See :ref:`EditorInspector<class_EditorInspector>`.

.. _class_@GlobalScope_constant_PROPERTY_USAGE_CLASS_IS_BITFIELD:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_CLASS_IS_BITFIELD** = ``512``



.. _class_@GlobalScope_constant_PROPERTY_USAGE_NO_INSTANCE_STATE:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_NO_INSTANCE_STATE** = ``1024``

The property does not save its state in :ref:`PackedScene<class_PackedScene>`.

.. _class_@GlobalScope_constant_PROPERTY_USAGE_RESTART_IF_CHANGED:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_RESTART_IF_CHANGED** = ``2048``

Editing the property prompts the user for restarting the editor.

.. _class_@GlobalScope_constant_PROPERTY_USAGE_SCRIPT_VARIABLE:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_SCRIPT_VARIABLE** = ``4096``

The property is a script variable which should be serialized and saved in the scene file.

.. _class_@GlobalScope_constant_PROPERTY_USAGE_STORE_IF_NULL:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_STORE_IF_NULL** = ``8192``



.. _class_@GlobalScope_constant_PROPERTY_USAGE_UPDATE_ALL_IF_MODIFIED:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_UPDATE_ALL_IF_MODIFIED** = ``16384``



.. _class_@GlobalScope_constant_PROPERTY_USAGE_SCRIPT_DEFAULT_VALUE:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_SCRIPT_DEFAULT_VALUE** = ``32768``



.. _class_@GlobalScope_constant_PROPERTY_USAGE_CLASS_IS_ENUM:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_CLASS_IS_ENUM** = ``65536``



.. _class_@GlobalScope_constant_PROPERTY_USAGE_NIL_IS_VARIANT:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_NIL_IS_VARIANT** = ``131072``



.. _class_@GlobalScope_constant_PROPERTY_USAGE_ARRAY:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_ARRAY** = ``262144``

The property is an array.

.. _class_@GlobalScope_constant_PROPERTY_USAGE_ALWAYS_DUPLICATE:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_ALWAYS_DUPLICATE** = ``524288``

When duplicating a resource with :ref:`Resource.duplicate<class_Resource_method_duplicate>`, and this flag is set on a property of that resource, the property should always be duplicated, regardless of the ``subresources`` bool parameter.

.. _class_@GlobalScope_constant_PROPERTY_USAGE_NEVER_DUPLICATE:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_NEVER_DUPLICATE** = ``1048576``

When duplicating a resource with :ref:`Resource.duplicate<class_Resource_method_duplicate>`, and this flag is set on a property of that resource, the property should never be duplicated, regardless of the ``subresources`` bool parameter.

.. _class_@GlobalScope_constant_PROPERTY_USAGE_HIGH_END_GFX:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_HIGH_END_GFX** = ``2097152``

The property is only shown in the editor if modern renderers are supported (the Compatibility rendering method is excluded).

.. _class_@GlobalScope_constant_PROPERTY_USAGE_NODE_PATH_FROM_SCENE_ROOT:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_NODE_PATH_FROM_SCENE_ROOT** = ``4194304``



.. _class_@GlobalScope_constant_PROPERTY_USAGE_RESOURCE_NOT_PERSISTENT:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_RESOURCE_NOT_PERSISTENT** = ``8388608``



.. _class_@GlobalScope_constant_PROPERTY_USAGE_KEYING_INCREMENTS:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_KEYING_INCREMENTS** = ``16777216``



.. _class_@GlobalScope_constant_PROPERTY_USAGE_DEFERRED_SET_RESOURCE:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_DEFERRED_SET_RESOURCE** = ``33554432``



.. _class_@GlobalScope_constant_PROPERTY_USAGE_EDITOR_INSTANTIATE_OBJECT:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_EDITOR_INSTANTIATE_OBJECT** = ``67108864``



.. _class_@GlobalScope_constant_PROPERTY_USAGE_EDITOR_BASIC_SETTING:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_EDITOR_BASIC_SETTING** = ``134217728``



.. _class_@GlobalScope_constant_PROPERTY_USAGE_READ_ONLY:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_READ_ONLY** = ``268435456``

The property is read-only in the :ref:`EditorInspector<class_EditorInspector>`.

.. _class_@GlobalScope_constant_PROPERTY_USAGE_SECRET:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_SECRET** = ``536870912``

An export preset property with this flag contains confidential information and is stored separately from the rest of the export preset configuration.

.. _class_@GlobalScope_constant_PROPERTY_USAGE_DEFAULT:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_DEFAULT** = ``6``

Default usage (storage and editor).

.. _class_@GlobalScope_constant_PROPERTY_USAGE_NO_EDITOR:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_NO_EDITOR** = ``2``

Default usage but without showing the property in the editor (storage).

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

----

.. _enum_@GlobalScope_MethodFlags:

.. rst-class:: classref-enumeration

flags **MethodFlags**:

.. _class_@GlobalScope_constant_METHOD_FLAG_NORMAL:

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

:ref:`MethodFlags<enum_@GlobalScope_MethodFlags>` **METHOD_FLAG_NORMAL** = ``1``

Flag for a normal method.

.. _class_@GlobalScope_constant_METHOD_FLAG_EDITOR:

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

:ref:`MethodFlags<enum_@GlobalScope_MethodFlags>` **METHOD_FLAG_EDITOR** = ``2``

Flag for an editor method.

.. _class_@GlobalScope_constant_METHOD_FLAG_CONST:

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

:ref:`MethodFlags<enum_@GlobalScope_MethodFlags>` **METHOD_FLAG_CONST** = ``4``

Flag for a constant method.

.. _class_@GlobalScope_constant_METHOD_FLAG_VIRTUAL:

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

:ref:`MethodFlags<enum_@GlobalScope_MethodFlags>` **METHOD_FLAG_VIRTUAL** = ``8``

Flag for a virtual method.

.. _class_@GlobalScope_constant_METHOD_FLAG_VARARG:

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

:ref:`MethodFlags<enum_@GlobalScope_MethodFlags>` **METHOD_FLAG_VARARG** = ``16``

Flag for a method with a variable number of arguments.

.. _class_@GlobalScope_constant_METHOD_FLAG_STATIC:

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

:ref:`MethodFlags<enum_@GlobalScope_MethodFlags>` **METHOD_FLAG_STATIC** = ``32``

Flag for a static method.

.. _class_@GlobalScope_constant_METHOD_FLAG_OBJECT_CORE:

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

:ref:`MethodFlags<enum_@GlobalScope_MethodFlags>` **METHOD_FLAG_OBJECT_CORE** = ``64``

Used internally. Allows to not dump core virtual methods (such as :ref:`Object._notification<class_Object_method__notification>`) to the JSON API.

.. _class_@GlobalScope_constant_METHOD_FLAGS_DEFAULT:

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

:ref:`MethodFlags<enum_@GlobalScope_MethodFlags>` **METHOD_FLAGS_DEFAULT** = ``1``

Default method flags (normal).

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

----

.. _enum_@GlobalScope_Variant.Type:

.. rst-class:: classref-enumeration

enum **Variant.Type**:

.. _class_@GlobalScope_constant_TYPE_NIL:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_NIL** = ``0``

Variable is ``null``.

.. _class_@GlobalScope_constant_TYPE_BOOL:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_BOOL** = ``1``

Variable is of type :ref:`bool<class_bool>`.

.. _class_@GlobalScope_constant_TYPE_INT:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_INT** = ``2``

Variable is of type :ref:`int<class_int>`.

.. _class_@GlobalScope_constant_TYPE_FLOAT:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_FLOAT** = ``3``

Variable is of type :ref:`float<class_float>`.

.. _class_@GlobalScope_constant_TYPE_STRING:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_STRING** = ``4``

Variable is of type :ref:`String<class_String>`.

.. _class_@GlobalScope_constant_TYPE_VECTOR2:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_VECTOR2** = ``5``

Variable is of type :ref:`Vector2<class_Vector2>`.

.. _class_@GlobalScope_constant_TYPE_VECTOR2I:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_VECTOR2I** = ``6``

Variable is of type :ref:`Vector2i<class_Vector2i>`.

.. _class_@GlobalScope_constant_TYPE_RECT2:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_RECT2** = ``7``

Variable is of type :ref:`Rect2<class_Rect2>`.

.. _class_@GlobalScope_constant_TYPE_RECT2I:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_RECT2I** = ``8``

Variable is of type :ref:`Rect2i<class_Rect2i>`.

.. _class_@GlobalScope_constant_TYPE_VECTOR3:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_VECTOR3** = ``9``

Variable is of type :ref:`Vector3<class_Vector3>`.

.. _class_@GlobalScope_constant_TYPE_VECTOR3I:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_VECTOR3I** = ``10``

Variable is of type :ref:`Vector3i<class_Vector3i>`.

.. _class_@GlobalScope_constant_TYPE_TRANSFORM2D:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_TRANSFORM2D** = ``11``

Variable is of type :ref:`Transform2D<class_Transform2D>`.

.. _class_@GlobalScope_constant_TYPE_VECTOR4:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_VECTOR4** = ``12``

Variable is of type :ref:`Vector4<class_Vector4>`.

.. _class_@GlobalScope_constant_TYPE_VECTOR4I:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_VECTOR4I** = ``13``

Variable is of type :ref:`Vector4i<class_Vector4i>`.

.. _class_@GlobalScope_constant_TYPE_PLANE:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_PLANE** = ``14``

Variable is of type :ref:`Plane<class_Plane>`.

.. _class_@GlobalScope_constant_TYPE_QUATERNION:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_QUATERNION** = ``15``

Variable is of type :ref:`Quaternion<class_Quaternion>`.

.. _class_@GlobalScope_constant_TYPE_AABB:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_AABB** = ``16``

Variable is of type :ref:`AABB<class_AABB>`.

.. _class_@GlobalScope_constant_TYPE_BASIS:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_BASIS** = ``17``

Variable is of type :ref:`Basis<class_Basis>`.

.. _class_@GlobalScope_constant_TYPE_TRANSFORM3D:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_TRANSFORM3D** = ``18``

Variable is of type :ref:`Transform3D<class_Transform3D>`.

.. _class_@GlobalScope_constant_TYPE_PROJECTION:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_PROJECTION** = ``19``

Variable is of type :ref:`Projection<class_Projection>`.

.. _class_@GlobalScope_constant_TYPE_COLOR:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_COLOR** = ``20``

Variable is of type :ref:`Color<class_Color>`.

.. _class_@GlobalScope_constant_TYPE_STRING_NAME:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_STRING_NAME** = ``21``

Variable is of type :ref:`StringName<class_StringName>`.

.. _class_@GlobalScope_constant_TYPE_NODE_PATH:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_NODE_PATH** = ``22``

Variable is of type :ref:`NodePath<class_NodePath>`.

.. _class_@GlobalScope_constant_TYPE_RID:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_RID** = ``23``

Variable is of type :ref:`RID<class_RID>`.

.. _class_@GlobalScope_constant_TYPE_OBJECT:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_OBJECT** = ``24``

Variable is of type :ref:`Object<class_Object>`.

.. _class_@GlobalScope_constant_TYPE_CALLABLE:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_CALLABLE** = ``25``

Variable is of type :ref:`Callable<class_Callable>`.

.. _class_@GlobalScope_constant_TYPE_SIGNAL:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_SIGNAL** = ``26``

Variable is of type :ref:`Signal<class_Signal>`.

.. _class_@GlobalScope_constant_TYPE_DICTIONARY:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_DICTIONARY** = ``27``

Variable is of type :ref:`Dictionary<class_Dictionary>`.

.. _class_@GlobalScope_constant_TYPE_ARRAY:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_ARRAY** = ``28``

Variable is of type :ref:`Array<class_Array>`.

.. _class_@GlobalScope_constant_TYPE_PACKED_BYTE_ARRAY:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_PACKED_BYTE_ARRAY** = ``29``

Variable is of type :ref:`PackedByteArray<class_PackedByteArray>`.

.. _class_@GlobalScope_constant_TYPE_PACKED_INT32_ARRAY:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_PACKED_INT32_ARRAY** = ``30``

Variable is of type :ref:`PackedInt32Array<class_PackedInt32Array>`.

.. _class_@GlobalScope_constant_TYPE_PACKED_INT64_ARRAY:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_PACKED_INT64_ARRAY** = ``31``

Variable is of type :ref:`PackedInt64Array<class_PackedInt64Array>`.

.. _class_@GlobalScope_constant_TYPE_PACKED_FLOAT32_ARRAY:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_PACKED_FLOAT32_ARRAY** = ``32``

Variable is of type :ref:`PackedFloat32Array<class_PackedFloat32Array>`.

.. _class_@GlobalScope_constant_TYPE_PACKED_FLOAT64_ARRAY:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_PACKED_FLOAT64_ARRAY** = ``33``

Variable is of type :ref:`PackedFloat64Array<class_PackedFloat64Array>`.

.. _class_@GlobalScope_constant_TYPE_PACKED_STRING_ARRAY:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_PACKED_STRING_ARRAY** = ``34``

Variable is of type :ref:`PackedStringArray<class_PackedStringArray>`.

.. _class_@GlobalScope_constant_TYPE_PACKED_VECTOR2_ARRAY:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_PACKED_VECTOR2_ARRAY** = ``35``

Variable is of type :ref:`PackedVector2Array<class_PackedVector2Array>`.

.. _class_@GlobalScope_constant_TYPE_PACKED_VECTOR3_ARRAY:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_PACKED_VECTOR3_ARRAY** = ``36``

Variable is of type :ref:`PackedVector3Array<class_PackedVector3Array>`.

.. _class_@GlobalScope_constant_TYPE_PACKED_COLOR_ARRAY:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_PACKED_COLOR_ARRAY** = ``37``

Variable is of type :ref:`PackedColorArray<class_PackedColorArray>`.

.. _class_@GlobalScope_constant_TYPE_MAX:

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

:ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **TYPE_MAX** = ``38``

Represents the size of the :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` enum.

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

----

.. _enum_@GlobalScope_Variant.Operator:

.. rst-class:: classref-enumeration

enum **Variant.Operator**:

.. _class_@GlobalScope_constant_OP_EQUAL:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_EQUAL** = ``0``

Equality operator (``==``).

.. _class_@GlobalScope_constant_OP_NOT_EQUAL:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_NOT_EQUAL** = ``1``

Inequality operator (``!=``).

.. _class_@GlobalScope_constant_OP_LESS:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_LESS** = ``2``

Less than operator (``<``).

.. _class_@GlobalScope_constant_OP_LESS_EQUAL:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_LESS_EQUAL** = ``3``

Less than or equal operator (``<=``).

.. _class_@GlobalScope_constant_OP_GREATER:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_GREATER** = ``4``

Greater than operator (``>``).

.. _class_@GlobalScope_constant_OP_GREATER_EQUAL:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_GREATER_EQUAL** = ``5``

Greater than or equal operator (``>=``).

.. _class_@GlobalScope_constant_OP_ADD:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_ADD** = ``6``

Addition operator (``+``).

.. _class_@GlobalScope_constant_OP_SUBTRACT:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_SUBTRACT** = ``7``

Subtraction operator (``-``).

.. _class_@GlobalScope_constant_OP_MULTIPLY:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_MULTIPLY** = ``8``

Multiplication operator (``*``).

.. _class_@GlobalScope_constant_OP_DIVIDE:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_DIVIDE** = ``9``

Division operator (``/``).

.. _class_@GlobalScope_constant_OP_NEGATE:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_NEGATE** = ``10``

Unary negation operator (``-``).

.. _class_@GlobalScope_constant_OP_POSITIVE:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_POSITIVE** = ``11``

Unary plus operator (``+``).

.. _class_@GlobalScope_constant_OP_MODULE:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_MODULE** = ``12``

Remainder/modulo operator (``%``).

.. _class_@GlobalScope_constant_OP_POWER:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_POWER** = ``13``

Power operator (``**``).

.. _class_@GlobalScope_constant_OP_SHIFT_LEFT:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_SHIFT_LEFT** = ``14``

Left shift operator (``<<``).

.. _class_@GlobalScope_constant_OP_SHIFT_RIGHT:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_SHIFT_RIGHT** = ``15``

Right shift operator (``>>``).

.. _class_@GlobalScope_constant_OP_BIT_AND:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_BIT_AND** = ``16``

Bitwise AND operator (``&``).

.. _class_@GlobalScope_constant_OP_BIT_OR:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_BIT_OR** = ``17``

Bitwise OR operator (``|``).

.. _class_@GlobalScope_constant_OP_BIT_XOR:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_BIT_XOR** = ``18``

Bitwise XOR operator (``^``).

.. _class_@GlobalScope_constant_OP_BIT_NEGATE:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_BIT_NEGATE** = ``19``

Bitwise NOT operator (``~``).

.. _class_@GlobalScope_constant_OP_AND:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_AND** = ``20``

Logical AND operator (``and`` or ``&&``).

.. _class_@GlobalScope_constant_OP_OR:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_OR** = ``21``

Logical OR operator (``or`` or ``||``).

.. _class_@GlobalScope_constant_OP_XOR:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_XOR** = ``22``

Logical XOR operator (not implemented in GDScript).

.. _class_@GlobalScope_constant_OP_NOT:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_NOT** = ``23``

Logical NOT operator (``not`` or ``!``).

.. _class_@GlobalScope_constant_OP_IN:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_IN** = ``24``

Logical IN operator (``in``).

.. _class_@GlobalScope_constant_OP_MAX:

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

:ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` **OP_MAX** = ``25``

Represents the size of the :ref:`Variant.Operator<enum_@GlobalScope_Variant.Operator>` enum.

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

----

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

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

.. _class_@GlobalScope_property_AudioServer:

.. rst-class:: classref-property

:ref:`AudioServer<class_AudioServer>` **AudioServer**

The :ref:`AudioServer<class_AudioServer>` singleton.

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

----

.. _class_@GlobalScope_property_CameraServer:

.. rst-class:: classref-property

:ref:`CameraServer<class_CameraServer>` **CameraServer**

The :ref:`CameraServer<class_CameraServer>` singleton.

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

----

.. _class_@GlobalScope_property_ClassDB:

.. rst-class:: classref-property

:ref:`ClassDB<class_ClassDB>` **ClassDB**

The :ref:`ClassDB<class_ClassDB>` singleton.

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

----

.. _class_@GlobalScope_property_DisplayServer:

.. rst-class:: classref-property

:ref:`DisplayServer<class_DisplayServer>` **DisplayServer**

The :ref:`DisplayServer<class_DisplayServer>` singleton.

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

----

.. _class_@GlobalScope_property_EditorInterface:

.. rst-class:: classref-property

:ref:`EditorInterface<class_EditorInterface>` **EditorInterface**

The :ref:`EditorInterface<class_EditorInterface>` singleton.

\ **Note:** Only available in editor builds.

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

----

.. _class_@GlobalScope_property_Engine:

.. rst-class:: classref-property

:ref:`Engine<class_Engine>` **Engine**

The :ref:`Engine<class_Engine>` singleton.

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

----

.. _class_@GlobalScope_property_EngineDebugger:

.. rst-class:: classref-property

:ref:`EngineDebugger<class_EngineDebugger>` **EngineDebugger**

The :ref:`EngineDebugger<class_EngineDebugger>` singleton.

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

----

.. _class_@GlobalScope_property_GDExtensionManager:

.. rst-class:: classref-property

:ref:`GDExtensionManager<class_GDExtensionManager>` **GDExtensionManager**

The :ref:`GDExtensionManager<class_GDExtensionManager>` singleton.

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

----

.. _class_@GlobalScope_property_Geometry2D:

.. rst-class:: classref-property

:ref:`Geometry2D<class_Geometry2D>` **Geometry2D**

The :ref:`Geometry2D<class_Geometry2D>` singleton.

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

----

.. _class_@GlobalScope_property_Geometry3D:

.. rst-class:: classref-property

:ref:`Geometry3D<class_Geometry3D>` **Geometry3D**

The :ref:`Geometry3D<class_Geometry3D>` singleton.

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

----

.. _class_@GlobalScope_property_GodotSharp:

.. rst-class:: classref-property

:ref:`GodotSharp<class_GodotSharp>` **GodotSharp**

The :ref:`GodotSharp<class_GodotSharp>` singleton.

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

----

.. _class_@GlobalScope_property_IP:

.. rst-class:: classref-property

:ref:`IP<class_IP>` **IP**

The :ref:`IP<class_IP>` singleton.

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

----

.. _class_@GlobalScope_property_Input:

.. rst-class:: classref-property

:ref:`Input<class_Input>` **Input**

The :ref:`Input<class_Input>` singleton.

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

----

.. _class_@GlobalScope_property_InputMap:

.. rst-class:: classref-property

:ref:`InputMap<class_InputMap>` **InputMap**

The :ref:`InputMap<class_InputMap>` singleton.

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

----

.. _class_@GlobalScope_property_JavaClassWrapper:

.. rst-class:: classref-property

:ref:`JavaClassWrapper<class_JavaClassWrapper>` **JavaClassWrapper**

The :ref:`JavaClassWrapper<class_JavaClassWrapper>` singleton.

\ **Note:** Only implemented on Android.

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

----

.. _class_@GlobalScope_property_JavaScriptBridge:

.. rst-class:: classref-property

:ref:`JavaScriptBridge<class_JavaScriptBridge>` **JavaScriptBridge**

The :ref:`JavaScriptBridge<class_JavaScriptBridge>` singleton.

\ **Note:** Only implemented on the Web platform.

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

----

.. _class_@GlobalScope_property_Marshalls:

.. rst-class:: classref-property

:ref:`Marshalls<class_Marshalls>` **Marshalls**

The :ref:`Marshalls<class_Marshalls>` singleton.

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

----

.. _class_@GlobalScope_property_NavigationMeshGenerator:

.. rst-class:: classref-property

:ref:`NavigationMeshGenerator<class_NavigationMeshGenerator>` **NavigationMeshGenerator**

The :ref:`NavigationMeshGenerator<class_NavigationMeshGenerator>` singleton.

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

----

.. _class_@GlobalScope_property_NavigationServer2D:

.. rst-class:: classref-property

:ref:`NavigationServer2D<class_NavigationServer2D>` **NavigationServer2D**

The :ref:`NavigationServer2D<class_NavigationServer2D>` singleton.

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

----

.. _class_@GlobalScope_property_NavigationServer3D:

.. rst-class:: classref-property

:ref:`NavigationServer3D<class_NavigationServer3D>` **NavigationServer3D**

The :ref:`NavigationServer3D<class_NavigationServer3D>` singleton.

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

----

.. _class_@GlobalScope_property_OS:

.. rst-class:: classref-property

:ref:`OS<class_OS>` **OS**

The :ref:`OS<class_OS>` singleton.

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

----

.. _class_@GlobalScope_property_Performance:

.. rst-class:: classref-property

:ref:`Performance<class_Performance>` **Performance**

The :ref:`Performance<class_Performance>` singleton.

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

----

.. _class_@GlobalScope_property_PhysicsServer2D:

.. rst-class:: classref-property

:ref:`PhysicsServer2D<class_PhysicsServer2D>` **PhysicsServer2D**

The :ref:`PhysicsServer2D<class_PhysicsServer2D>` singleton.

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

----

.. _class_@GlobalScope_property_PhysicsServer2DManager:

.. rst-class:: classref-property

:ref:`PhysicsServer2DManager<class_PhysicsServer2DManager>` **PhysicsServer2DManager**

The :ref:`PhysicsServer2DManager<class_PhysicsServer2DManager>` singleton.

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

----

.. _class_@GlobalScope_property_PhysicsServer3D:

.. rst-class:: classref-property

:ref:`PhysicsServer3D<class_PhysicsServer3D>` **PhysicsServer3D**

The :ref:`PhysicsServer3D<class_PhysicsServer3D>` singleton.

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

----

.. _class_@GlobalScope_property_PhysicsServer3DManager:

.. rst-class:: classref-property

:ref:`PhysicsServer3DManager<class_PhysicsServer3DManager>` **PhysicsServer3DManager**

The :ref:`PhysicsServer3DManager<class_PhysicsServer3DManager>` singleton.

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

----

.. _class_@GlobalScope_property_ProjectSettings:

.. rst-class:: classref-property

:ref:`ProjectSettings<class_ProjectSettings>` **ProjectSettings**

The :ref:`ProjectSettings<class_ProjectSettings>` singleton.

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

----

.. _class_@GlobalScope_property_RenderingServer:

.. rst-class:: classref-property

:ref:`RenderingServer<class_RenderingServer>` **RenderingServer**

The :ref:`RenderingServer<class_RenderingServer>` singleton.

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

----

.. _class_@GlobalScope_property_ResourceLoader:

.. rst-class:: classref-property

:ref:`ResourceLoader<class_ResourceLoader>` **ResourceLoader**

The :ref:`ResourceLoader<class_ResourceLoader>` singleton.

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

----

.. _class_@GlobalScope_property_ResourceSaver:

.. rst-class:: classref-property

:ref:`ResourceSaver<class_ResourceSaver>` **ResourceSaver**

The :ref:`ResourceSaver<class_ResourceSaver>` singleton.

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

----

.. _class_@GlobalScope_property_ResourceUID:

.. rst-class:: classref-property

:ref:`ResourceUID<class_ResourceUID>` **ResourceUID**

The :ref:`ResourceUID<class_ResourceUID>` singleton.

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

----

.. _class_@GlobalScope_property_TextServerManager:

.. rst-class:: classref-property

:ref:`TextServerManager<class_TextServerManager>` **TextServerManager**

The :ref:`TextServerManager<class_TextServerManager>` singleton.

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

----

.. _class_@GlobalScope_property_ThemeDB:

.. rst-class:: classref-property

:ref:`ThemeDB<class_ThemeDB>` **ThemeDB**

The :ref:`ThemeDB<class_ThemeDB>` singleton.

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

----

.. _class_@GlobalScope_property_Time:

.. rst-class:: classref-property

:ref:`Time<class_Time>` **Time**

The :ref:`Time<class_Time>` singleton.

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

----

.. _class_@GlobalScope_property_TranslationServer:

.. rst-class:: classref-property

:ref:`TranslationServer<class_TranslationServer>` **TranslationServer**

The :ref:`TranslationServer<class_TranslationServer>` singleton.

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

----

.. _class_@GlobalScope_property_WorkerThreadPool:

.. rst-class:: classref-property

:ref:`WorkerThreadPool<class_WorkerThreadPool>` **WorkerThreadPool**

The :ref:`WorkerThreadPool<class_WorkerThreadPool>` singleton.

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

----

.. _class_@GlobalScope_property_XRServer:

.. rst-class:: classref-property

:ref:`XRServer<class_XRServer>` **XRServer**

The :ref:`XRServer<class_XRServer>` singleton.

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

----

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

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

.. _class_@GlobalScope_method_abs:

.. rst-class:: classref-method

:ref:`Variant<class_Variant>` **abs** **(** :ref:`Variant<class_Variant>` x **)**

Returns the absolute value of a :ref:`Variant<class_Variant>` parameter ``x`` (i.e. non-negative value). Supported types: :ref:`int<class_int>`, :ref:`float<class_float>`, :ref:`Vector2<class_Vector2>`, :ref:`Vector2i<class_Vector2i>`, :ref:`Vector3<class_Vector3>`, :ref:`Vector3i<class_Vector3i>`, :ref:`Vector4<class_Vector4>`, :ref:`Vector4i<class_Vector4i>`.

::

    var a = abs(-1)
    # a is 1
    
    var b = abs(-1.2)
    # b is 1.2
    
    var c = abs(Vector2(-3.5, -4))
    # c is (3.5, 4)
    
    var d = abs(Vector2i(-5, -6))
    # d is (5, 6)
    
    var e = abs(Vector3(-7, 8.5, -3.8))
    # e is (7, 8.5, 3.8)
    
    var f = abs(Vector3i(-7, -8, -9))
    # f is (7, 8, 9)

\ **Note:** For better type safety, use :ref:`absf<class_@GlobalScope_method_absf>`, :ref:`absi<class_@GlobalScope_method_absi>`, :ref:`Vector2.abs<class_Vector2_method_abs>`, :ref:`Vector2i.abs<class_Vector2i_method_abs>`, :ref:`Vector3.abs<class_Vector3_method_abs>`, :ref:`Vector3i.abs<class_Vector3i_method_abs>`, :ref:`Vector4.abs<class_Vector4_method_abs>`, or :ref:`Vector4i.abs<class_Vector4i_method_abs>`.

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

----

.. _class_@GlobalScope_method_absf:

.. rst-class:: classref-method

:ref:`float<class_float>` **absf** **(** :ref:`float<class_float>` x **)**

Returns the absolute value of float parameter ``x`` (i.e. positive value).

::

    # a is 1.2
    var a = absf(-1.2)

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

----

.. _class_@GlobalScope_method_absi:

.. rst-class:: classref-method

:ref:`int<class_int>` **absi** **(** :ref:`int<class_int>` x **)**

Returns the absolute value of int parameter ``x`` (i.e. positive value).

::

    # a is 1
    var a = absi(-1)

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

----

.. _class_@GlobalScope_method_acos:

.. rst-class:: classref-method

:ref:`float<class_float>` **acos** **(** :ref:`float<class_float>` x **)**

Returns the arc cosine of ``x`` in radians. Use to get the angle of cosine ``x``. ``x`` will be clamped between ``-1.0`` and ``1.0`` (inclusive), in order to prevent :ref:`acos<class_@GlobalScope_method_acos>` from returning :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>`.

::

    # c is 0.523599 or 30 degrees if converted with rad_to_deg(c)
    var c = acos(0.866025)

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

----

.. _class_@GlobalScope_method_acosh:

.. rst-class:: classref-method

:ref:`float<class_float>` **acosh** **(** :ref:`float<class_float>` x **)**

Returns the hyperbolic arc (also called inverse) cosine of ``x``, returning a value in radians. Use it to get the angle from an angle's cosine in hyperbolic space if ``x`` is larger or equal to 1. For values of ``x`` lower than 1, it will return 0, in order to prevent :ref:`acosh<class_@GlobalScope_method_acosh>` from returning :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>`.

::

    var a = acosh(2) # Returns 1.31695789692482
    cosh(a) # Returns 2
    
    var b = acosh(-1) # Returns 0

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

----

.. _class_@GlobalScope_method_asin:

.. rst-class:: classref-method

:ref:`float<class_float>` **asin** **(** :ref:`float<class_float>` x **)**

Returns the arc sine of ``x`` in radians. Use to get the angle of sine ``x``. ``x`` will be clamped between ``-1.0`` and ``1.0`` (inclusive), in order to prevent :ref:`asin<class_@GlobalScope_method_asin>` from returning :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>`.

::

    # s is 0.523599 or 30 degrees if converted with rad_to_deg(s)
    var s = asin(0.5)

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

----

.. _class_@GlobalScope_method_asinh:

.. rst-class:: classref-method

:ref:`float<class_float>` **asinh** **(** :ref:`float<class_float>` x **)**

Returns the hyperbolic arc (also called inverse) sine of ``x``, returning a value in radians. Use it to get the angle from an angle's sine in hyperbolic space.

::

    var a = asinh(0.9) # Returns 0.8088669356527824
    sinh(a) # Returns 0.9

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

----

.. _class_@GlobalScope_method_atan:

.. rst-class:: classref-method

:ref:`float<class_float>` **atan** **(** :ref:`float<class_float>` x **)**

Returns the arc tangent of ``x`` in radians. Use it to get the angle from an angle's tangent in trigonometry.

The method cannot know in which quadrant the angle should fall. See :ref:`atan2<class_@GlobalScope_method_atan2>` if you have both ``y`` and ``x``.

::

    var a = atan(0.5) # a is 0.463648

If ``x`` is between ``-PI / 2`` and ``PI / 2`` (inclusive), ``atan(tan(x))`` is equal to ``x``.

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

----

.. _class_@GlobalScope_method_atan2:

.. rst-class:: classref-method

:ref:`float<class_float>` **atan2** **(** :ref:`float<class_float>` y, :ref:`float<class_float>` x **)**

Returns the arc tangent of ``y/x`` in radians. Use to get the angle of tangent ``y/x``. To compute the value, the method takes into account the sign of both arguments in order to determine the quadrant.

Important note: The Y coordinate comes first, by convention.

::

    var a = atan2(0, -1) # a is 3.141593

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

----

.. _class_@GlobalScope_method_atanh:

.. rst-class:: classref-method

:ref:`float<class_float>` **atanh** **(** :ref:`float<class_float>` x **)**

Returns the hyperbolic arc (also called inverse) tangent of ``x``, returning a value in radians. Use it to get the angle from an angle's tangent in hyperbolic space if ``x`` is between -1 and 1 (non-inclusive).

In mathematics, the inverse hyperbolic tangent is only defined for -1 < ``x`` < 1 in the real set, so values equal or lower to -1 for ``x`` return negative :ref:`@GDScript.INF<class_@GDScript_constant_INF>` and values equal or higher than 1 return positive :ref:`@GDScript.INF<class_@GDScript_constant_INF>` in order to prevent :ref:`atanh<class_@GlobalScope_method_atanh>` from returning :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>`.

::

    var a = atanh(0.9) # Returns 1.47221948958322
    tanh(a) # Returns 0.9
    
    var b = atanh(-2) # Returns -inf
    tanh(b) # Returns -1

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

----

.. _class_@GlobalScope_method_bezier_derivative:

.. rst-class:: classref-method

:ref:`float<class_float>` **bezier_derivative** **(** :ref:`float<class_float>` start, :ref:`float<class_float>` control_1, :ref:`float<class_float>` control_2, :ref:`float<class_float>` end, :ref:`float<class_float>` t **)**

Returns the derivative at the given ``t`` on a one-dimensional `Bézier curve <https://en.wikipedia.org/wiki/B%C3%A9zier_curve>`__ defined by the given ``control_1``, ``control_2``, and ``end`` points.

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

----

.. _class_@GlobalScope_method_bezier_interpolate:

.. rst-class:: classref-method

:ref:`float<class_float>` **bezier_interpolate** **(** :ref:`float<class_float>` start, :ref:`float<class_float>` control_1, :ref:`float<class_float>` control_2, :ref:`float<class_float>` end, :ref:`float<class_float>` t **)**

Returns the point at the given ``t`` on a one-dimensional `Bézier curve <https://en.wikipedia.org/wiki/B%C3%A9zier_curve>`__ defined by the given ``control_1``, ``control_2``, and ``end`` points.

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

----

.. _class_@GlobalScope_method_bytes_to_var:

.. rst-class:: classref-method

:ref:`Variant<class_Variant>` **bytes_to_var** **(** :ref:`PackedByteArray<class_PackedByteArray>` bytes **)**

Decodes a byte array back to a :ref:`Variant<class_Variant>` value, without decoding objects.

\ **Note:** If you need object deserialization, see :ref:`bytes_to_var_with_objects<class_@GlobalScope_method_bytes_to_var_with_objects>`.

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

----

.. _class_@GlobalScope_method_bytes_to_var_with_objects:

.. rst-class:: classref-method

:ref:`Variant<class_Variant>` **bytes_to_var_with_objects** **(** :ref:`PackedByteArray<class_PackedByteArray>` bytes **)**

Decodes a byte array back to a :ref:`Variant<class_Variant>` value. Decoding objects is allowed.

\ **Warning:** Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution).

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

----

.. _class_@GlobalScope_method_ceil:

.. rst-class:: classref-method

:ref:`Variant<class_Variant>` **ceil** **(** :ref:`Variant<class_Variant>` x **)**

Rounds ``x`` upward (towards positive infinity), returning the smallest whole number that is not less than ``x``. Supported types: :ref:`int<class_int>`, :ref:`float<class_float>`, :ref:`Vector2<class_Vector2>`, :ref:`Vector3<class_Vector3>`, :ref:`Vector4<class_Vector4>`.

::

    var i = ceil(1.45) # i is 2.0
    i = ceil(1.001)    # i is 2.0

See also :ref:`floor<class_@GlobalScope_method_floor>`, :ref:`round<class_@GlobalScope_method_round>`, and :ref:`snapped<class_@GlobalScope_method_snapped>`.

\ **Note:** For better type safety, use :ref:`ceilf<class_@GlobalScope_method_ceilf>`, :ref:`ceili<class_@GlobalScope_method_ceili>`, :ref:`Vector2.ceil<class_Vector2_method_ceil>`, :ref:`Vector3.ceil<class_Vector3_method_ceil>`, or :ref:`Vector4.ceil<class_Vector4_method_ceil>`.

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

----

.. _class_@GlobalScope_method_ceilf:

.. rst-class:: classref-method

:ref:`float<class_float>` **ceilf** **(** :ref:`float<class_float>` x **)**

Rounds ``x`` upward (towards positive infinity), returning the smallest whole number that is not less than ``x``.

A type-safe version of :ref:`ceil<class_@GlobalScope_method_ceil>`, returning a :ref:`float<class_float>`.

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

----

.. _class_@GlobalScope_method_ceili:

.. rst-class:: classref-method

:ref:`int<class_int>` **ceili** **(** :ref:`float<class_float>` x **)**

Rounds ``x`` upward (towards positive infinity), returning the smallest whole number that is not less than ``x``.

A type-safe version of :ref:`ceil<class_@GlobalScope_method_ceil>`, returning an :ref:`int<class_int>`.

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

----

.. _class_@GlobalScope_method_clamp:

.. rst-class:: classref-method

:ref:`Variant<class_Variant>` **clamp** **(** :ref:`Variant<class_Variant>` value, :ref:`Variant<class_Variant>` min, :ref:`Variant<class_Variant>` max **)**

Clamps the ``value``, returning a :ref:`Variant<class_Variant>` not less than ``min`` and not more than ``max``. Any values that can be compared with the less than and greater than operators will work.

::

    var a = clamp(-10, -1, 5)
    # a is -1
    
    var b = clamp(8.1, 0.9, 5.5)
    # b is 5.5
    
    var c = clamp(Vector2(-3.5, -4), Vector2(-3.2, -2), Vector2(2, 6.5))
    # c is (-3.2, -2)
    
    var d = clamp(Vector2i(7, 8), Vector2i(-3, -2), Vector2i(2, 6))
    # d is (2, 6)
    
    var e = clamp(Vector3(-7, 8.5, -3.8), Vector3(-3, -2, 5.4), Vector3(-2, 6, -4.1))
    # e is (-3, -2, 5.4)
    
    var f = clamp(Vector3i(-7, -8, -9), Vector3i(-1, 2, 3), Vector3i(-4, -5, -6))
    # f is (-4, -5, -6)

\ **Note:** For better type safety, use :ref:`clampf<class_@GlobalScope_method_clampf>`, :ref:`clampi<class_@GlobalScope_method_clampi>`, :ref:`Vector2.clamp<class_Vector2_method_clamp>`, :ref:`Vector2i.clamp<class_Vector2i_method_clamp>`, :ref:`Vector3.clamp<class_Vector3_method_clamp>`, :ref:`Vector3i.clamp<class_Vector3i_method_clamp>`, :ref:`Vector4.clamp<class_Vector4_method_clamp>`, :ref:`Vector4i.clamp<class_Vector4i_method_clamp>`, or :ref:`Color.clamp<class_Color_method_clamp>`.

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

----

.. _class_@GlobalScope_method_clampf:

.. rst-class:: classref-method

:ref:`float<class_float>` **clampf** **(** :ref:`float<class_float>` value, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)**

Clamps the ``value``, returning a :ref:`float<class_float>` not less than ``min`` and not more than ``max``.

::

    var speed = 42.1
    var a = clampf(speed, 1.0, 20.5) # a is 20.5
    
    speed = -10.0
    var b = clampf(speed, -1.0, 1.0) # b is -1.0

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

----

.. _class_@GlobalScope_method_clampi:

.. rst-class:: classref-method

:ref:`int<class_int>` **clampi** **(** :ref:`int<class_int>` value, :ref:`int<class_int>` min, :ref:`int<class_int>` max **)**

Clamps the ``value``, returning an :ref:`int<class_int>` not less than ``min`` and not more than ``max``.

::

    var speed = 42
    var a = clampi(speed, 1, 20) # a is 20
    
    speed = -10
    var b = clampi(speed, -1, 1) # b is -1

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

----

.. _class_@GlobalScope_method_cos:

.. rst-class:: classref-method

:ref:`float<class_float>` **cos** **(** :ref:`float<class_float>` angle_rad **)**

Returns the cosine of angle ``angle_rad`` in radians.

::

    cos(PI * 2)         # Returns 1.0
    cos(PI)             # Returns -1.0
    cos(deg_to_rad(90)) # Returns 0.0

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

----

.. _class_@GlobalScope_method_cosh:

.. rst-class:: classref-method

:ref:`float<class_float>` **cosh** **(** :ref:`float<class_float>` x **)**

Returns the hyperbolic cosine of ``x`` in radians.

::

    print(cosh(1)) # Prints 1.543081

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

----

.. _class_@GlobalScope_method_cubic_interpolate:

.. rst-class:: classref-method

:ref:`float<class_float>` **cubic_interpolate** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` pre, :ref:`float<class_float>` post, :ref:`float<class_float>` weight **)**

Cubic interpolates between two values by the factor defined in ``weight`` with ``pre`` and ``post`` values.

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

----

.. _class_@GlobalScope_method_cubic_interpolate_angle:

.. rst-class:: classref-method

:ref:`float<class_float>` **cubic_interpolate_angle** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` pre, :ref:`float<class_float>` post, :ref:`float<class_float>` weight **)**

Cubic interpolates between two rotation values with shortest path by the factor defined in ``weight`` with ``pre`` and ``post`` values. See also :ref:`lerp_angle<class_@GlobalScope_method_lerp_angle>`.

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

----

.. _class_@GlobalScope_method_cubic_interpolate_angle_in_time:

.. rst-class:: classref-method

:ref:`float<class_float>` **cubic_interpolate_angle_in_time** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` pre, :ref:`float<class_float>` post, :ref:`float<class_float>` weight, :ref:`float<class_float>` to_t, :ref:`float<class_float>` pre_t, :ref:`float<class_float>` post_t **)**

Cubic interpolates between two rotation values with shortest path by the factor defined in ``weight`` with ``pre`` and ``post`` values. See also :ref:`lerp_angle<class_@GlobalScope_method_lerp_angle>`.

It can perform smoother interpolation than ``cubic_interpolate()`` by the time values.

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

----

.. _class_@GlobalScope_method_cubic_interpolate_in_time:

.. rst-class:: classref-method

:ref:`float<class_float>` **cubic_interpolate_in_time** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` pre, :ref:`float<class_float>` post, :ref:`float<class_float>` weight, :ref:`float<class_float>` to_t, :ref:`float<class_float>` pre_t, :ref:`float<class_float>` post_t **)**

Cubic interpolates between two values by the factor defined in ``weight`` with ``pre`` and ``post`` values.

It can perform smoother interpolation than :ref:`cubic_interpolate<class_@GlobalScope_method_cubic_interpolate>` by the time values.

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

----

.. _class_@GlobalScope_method_db_to_linear:

.. rst-class:: classref-method

:ref:`float<class_float>` **db_to_linear** **(** :ref:`float<class_float>` db **)**

Converts from decibels to linear energy (audio).

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

----

.. _class_@GlobalScope_method_deg_to_rad:

.. rst-class:: classref-method

:ref:`float<class_float>` **deg_to_rad** **(** :ref:`float<class_float>` deg **)**

Converts an angle expressed in degrees to radians.

::

    var r = deg_to_rad(180) # r is 3.141593

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

----

.. _class_@GlobalScope_method_ease:

.. rst-class:: classref-method

:ref:`float<class_float>` **ease** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` curve **)**

Returns an "eased" value of ``x`` based on an easing function defined with ``curve``. This easing function is based on an exponent. The ``curve`` can be any floating-point number, with specific values leading to the following behaviors:

::

    - Lower than -1.0 (exclusive): Ease in-out
    - 1.0: Linear
    - Between -1.0 and 0.0 (exclusive): Ease out-in
    - 0.0: Constant
    - Between 0.0 to 1.0 (exclusive): Ease out
    - 1.0: Linear
    - Greater than 1.0 (exclusive): Ease in

\ `ease() curve values cheatsheet <https://raw.githubusercontent.com/godotengine/godot-docs/master/img/ease_cheatsheet.png>`__\ 

See also :ref:`smoothstep<class_@GlobalScope_method_smoothstep>`. If you need to perform more advanced transitions, use :ref:`Tween.interpolate_value<class_Tween_method_interpolate_value>`.

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

----

.. _class_@GlobalScope_method_error_string:

.. rst-class:: classref-method

:ref:`String<class_String>` **error_string** **(** :ref:`int<class_int>` error **)**

Returns a human-readable name for the given :ref:`Error<enum_@GlobalScope_Error>` code.

::

    print(OK)                              # Prints 0
    print(error_string(OK))                # Prints OK
    print(error_string(ERR_BUSY))          # Prints Busy
    print(error_string(ERR_OUT_OF_MEMORY)) # Prints Out of memory

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

----

.. _class_@GlobalScope_method_exp:

.. rst-class:: classref-method

:ref:`float<class_float>` **exp** **(** :ref:`float<class_float>` x **)**

The natural exponential function. It raises the mathematical constant *e* to the power of ``x`` and returns it.

\ *e* has an approximate value of 2.71828, and can be obtained with ``exp(1)``.

For exponents to other bases use the method :ref:`pow<class_@GlobalScope_method_pow>`.

::

    var a = exp(2) # Approximately 7.39

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

----

.. _class_@GlobalScope_method_floor:

.. rst-class:: classref-method

:ref:`Variant<class_Variant>` **floor** **(** :ref:`Variant<class_Variant>` x **)**

Rounds ``x`` downward (towards negative infinity), returning the largest whole number that is not more than ``x``. Supported types: :ref:`int<class_int>`, :ref:`float<class_float>`, :ref:`Vector2<class_Vector2>`, :ref:`Vector3<class_Vector3>`, :ref:`Vector4<class_Vector4>`.

::

    var a = floor(2.99) # a is 2.0
    a = floor(-2.99)    # a is -3.0

See also :ref:`ceil<class_@GlobalScope_method_ceil>`, :ref:`round<class_@GlobalScope_method_round>`, and :ref:`snapped<class_@GlobalScope_method_snapped>`.

\ **Note:** For better type safety, use :ref:`floorf<class_@GlobalScope_method_floorf>`, :ref:`floori<class_@GlobalScope_method_floori>`, :ref:`Vector2.floor<class_Vector2_method_floor>`, :ref:`Vector3.floor<class_Vector3_method_floor>`, or :ref:`Vector4.floor<class_Vector4_method_floor>`.

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

----

.. _class_@GlobalScope_method_floorf:

.. rst-class:: classref-method

:ref:`float<class_float>` **floorf** **(** :ref:`float<class_float>` x **)**

Rounds ``x`` downward (towards negative infinity), returning the largest whole number that is not more than ``x``.

A type-safe version of :ref:`floor<class_@GlobalScope_method_floor>`, returning a :ref:`float<class_float>`.

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

----

.. _class_@GlobalScope_method_floori:

.. rst-class:: classref-method

:ref:`int<class_int>` **floori** **(** :ref:`float<class_float>` x **)**

Rounds ``x`` downward (towards negative infinity), returning the largest whole number that is not more than ``x``.

A type-safe version of :ref:`floor<class_@GlobalScope_method_floor>`, returning an :ref:`int<class_int>`.

\ **Note:** This function is *not* the same as ``int(x)``, which rounds towards 0.

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

----

.. _class_@GlobalScope_method_fmod:

.. rst-class:: classref-method

:ref:`float<class_float>` **fmod** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)**

Returns the floating-point remainder of ``x`` divided by ``y``, keeping the sign of ``x``.

::

    var remainder = fmod(7, 5.5) # remainder is 1.5

For the integer remainder operation, use the ``%`` operator.

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

----

.. _class_@GlobalScope_method_fposmod:

.. rst-class:: classref-method

:ref:`float<class_float>` **fposmod** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)**

Returns the floating-point modulus of ``x`` divided by ``y``, wrapping equally in positive and negative.

::

    print(" (x)  (fmod(x, 1.5))   (fposmod(x, 1.5))")
    for i in 7:
        var x = i * 0.5 - 1.5
        print("%4.1f           %4.1f  | %4.1f" % [x, fmod(x, 1.5), fposmod(x, 1.5)])

Produces:

::

     (x)  (fmod(x, 1.5))   (fposmod(x, 1.5))
    -1.5           -0.0  |  0.0
    -1.0           -1.0  |  0.5
    -0.5           -0.5  |  1.0
     0.0            0.0  |  0.0
     0.5            0.5  |  0.5
     1.0            1.0  |  1.0
     1.5            0.0  |  0.0

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

----

.. _class_@GlobalScope_method_hash:

.. rst-class:: classref-method

:ref:`int<class_int>` **hash** **(** :ref:`Variant<class_Variant>` variable **)**

Returns the integer hash of the passed ``variable``.


.. tabs::

 .. code-tab:: gdscript

    print(hash("a")) # Prints 177670

 .. code-tab:: csharp

    GD.Print(GD.Hash("a")); // Prints 177670



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

----

.. _class_@GlobalScope_method_instance_from_id:

.. rst-class:: classref-method

:ref:`Object<class_Object>` **instance_from_id** **(** :ref:`int<class_int>` instance_id **)**

Returns the :ref:`Object<class_Object>` that corresponds to ``instance_id``. All Objects have a unique instance ID. See also :ref:`Object.get_instance_id<class_Object_method_get_instance_id>`.


.. tabs::

 .. code-tab:: gdscript

    var foo = "bar"
    
    func _ready():
        var id = get_instance_id()
        var inst = instance_from_id(id)
        print(inst.foo) # Prints bar

 .. code-tab:: csharp

    public partial class MyNode : Node
    {
        public string Foo { get; set; } = "bar";
    
        public override void _Ready()
        {
            ulong id = GetInstanceId();
            var inst = (MyNode)InstanceFromId(Id);
            GD.Print(inst.Foo); // Prints bar
        }
    }



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

----

.. _class_@GlobalScope_method_inverse_lerp:

.. rst-class:: classref-method

:ref:`float<class_float>` **inverse_lerp** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` weight **)**

Returns an interpolation or extrapolation factor considering the range specified in ``from`` and ``to``, and the interpolated value specified in ``weight``. The returned value will be between ``0.0`` and ``1.0`` if ``weight`` is between ``from`` and ``to`` (inclusive). If ``weight`` is located outside this range, then an extrapolation factor will be returned (return value lower than ``0.0`` or greater than ``1.0``). Use :ref:`clamp<class_@GlobalScope_method_clamp>` on the result of :ref:`inverse_lerp<class_@GlobalScope_method_inverse_lerp>` if this is not desired.

::

    # The interpolation ratio in the `lerp()` call below is 0.75.
    var middle = lerp(20, 30, 0.75)
    # middle is now 27.5.
    
    # Now, we pretend to have forgotten the original ratio and want to get it back.
    var ratio = inverse_lerp(20, 30, 27.5)
    # ratio is now 0.75.

See also :ref:`lerp<class_@GlobalScope_method_lerp>`, which performs the reverse of this operation, and :ref:`remap<class_@GlobalScope_method_remap>` to map a continuous series of values to another.

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

----

.. _class_@GlobalScope_method_is_equal_approx:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_equal_approx** **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)**

Returns ``true`` if ``a`` and ``b`` are approximately equal to each other.

Here, "approximately equal" means that ``a`` and ``b`` are within a small internal epsilon of each other, which scales with the magnitude of the numbers.

Infinity values of the same sign are considered equal.

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

----

.. _class_@GlobalScope_method_is_finite:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_finite** **(** :ref:`float<class_float>` x **)**

Returns whether ``x`` is a finite value, i.e. it is not :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>`, positive infinity, or negative infinity.

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

----

.. _class_@GlobalScope_method_is_inf:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_inf** **(** :ref:`float<class_float>` x **)**

Returns ``true`` if ``x`` is either positive infinity or negative infinity.

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

----

.. _class_@GlobalScope_method_is_instance_id_valid:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_instance_id_valid** **(** :ref:`int<class_int>` id **)**

Returns ``true`` if the Object that corresponds to ``id`` is a valid object (e.g. has not been deleted from memory). All Objects have a unique instance ID.

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

----

.. _class_@GlobalScope_method_is_instance_valid:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_instance_valid** **(** :ref:`Variant<class_Variant>` instance **)**

Returns ``true`` if ``instance`` is a valid Object (e.g. has not been deleted from memory).

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

----

.. _class_@GlobalScope_method_is_nan:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_nan** **(** :ref:`float<class_float>` x **)**

Returns ``true`` if ``x`` is a NaN ("Not a Number" or invalid) value.

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

----

.. _class_@GlobalScope_method_is_same:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_same** **(** :ref:`Variant<class_Variant>` a, :ref:`Variant<class_Variant>` b **)**

Returns ``true``, for value types, if ``a`` and ``b`` share the same value. Returns ``true``, for reference types, if the references of ``a`` and ``b`` are the same.

::

    # Vector2 is a value type
    var vec2_a = Vector2(0, 0)
    var vec2_b = Vector2(0, 0)
    var vec2_c = Vector2(1, 1)
    is_same(vec2_a, vec2_a)  # true
    is_same(vec2_a, vec2_b)  # true
    is_same(vec2_a, vec2_c)  # false
    
    # Array is a reference type
    var arr_a = []
    var arr_b = []
    is_same(arr_a, arr_a)  # true
    is_same(arr_a, arr_b)  # false

These are :ref:`Variant<class_Variant>` value types: ``null``, :ref:`bool<class_bool>`, :ref:`int<class_int>`, :ref:`float<class_float>`, :ref:`String<class_String>`, :ref:`StringName<class_StringName>`, :ref:`Vector2<class_Vector2>`, :ref:`Vector2i<class_Vector2i>`, :ref:`Vector3<class_Vector3>`, :ref:`Vector3i<class_Vector3i>`, :ref:`Vector4<class_Vector4>`, :ref:`Vector4i<class_Vector4i>`, :ref:`Rect2<class_Rect2>`, :ref:`Rect2i<class_Rect2i>`, :ref:`Transform2D<class_Transform2D>`, :ref:`Transform3D<class_Transform3D>`, :ref:`Plane<class_Plane>`, :ref:`Quaternion<class_Quaternion>`, :ref:`AABB<class_AABB>`, :ref:`Basis<class_Basis>`, :ref:`Projection<class_Projection>`, :ref:`Color<class_Color>`, :ref:`NodePath<class_NodePath>`, :ref:`RID<class_RID>`, :ref:`Callable<class_Callable>` and :ref:`Signal<class_Signal>`.

These are :ref:`Variant<class_Variant>` reference types: :ref:`Object<class_Object>`, :ref:`Dictionary<class_Dictionary>`, :ref:`Array<class_Array>`, :ref:`PackedByteArray<class_PackedByteArray>`, :ref:`PackedInt32Array<class_PackedInt32Array>`, :ref:`PackedInt64Array<class_PackedInt64Array>`, :ref:`PackedFloat32Array<class_PackedFloat32Array>`, :ref:`PackedFloat64Array<class_PackedFloat64Array>`, :ref:`PackedStringArray<class_PackedStringArray>`, :ref:`PackedVector2Array<class_PackedVector2Array>`, :ref:`PackedVector3Array<class_PackedVector3Array>` and :ref:`PackedColorArray<class_PackedColorArray>`.

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

----

.. _class_@GlobalScope_method_is_zero_approx:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_zero_approx** **(** :ref:`float<class_float>` x **)**

Returns ``true`` if ``x`` is zero or almost zero. The comparison is done using a tolerance calculation with a small internal epsilon.

This function is faster than using :ref:`is_equal_approx<class_@GlobalScope_method_is_equal_approx>` with one value as zero.

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

----

.. _class_@GlobalScope_method_lerp:

.. rst-class:: classref-method

:ref:`Variant<class_Variant>` **lerp** **(** :ref:`Variant<class_Variant>` from, :ref:`Variant<class_Variant>` to, :ref:`Variant<class_Variant>` weight **)**

Linearly interpolates between two values by the factor defined in ``weight``. To perform interpolation, ``weight`` should be between ``0.0`` and ``1.0`` (inclusive). However, values outside this range are allowed and can be used to perform *extrapolation*. If this is not desired, use :ref:`clamp<class_@GlobalScope_method_clamp>` on the result of this function.

Both ``from`` and ``to`` must be the same type. Supported types: :ref:`int<class_int>`, :ref:`float<class_float>`, :ref:`Vector2<class_Vector2>`, :ref:`Vector3<class_Vector3>`, :ref:`Vector4<class_Vector4>`, :ref:`Color<class_Color>`, :ref:`Quaternion<class_Quaternion>`, :ref:`Basis<class_Basis>`.

::

    lerp(0, 4, 0.75) # Returns 3.0

See also :ref:`inverse_lerp<class_@GlobalScope_method_inverse_lerp>` which performs the reverse of this operation. To perform eased interpolation with :ref:`lerp<class_@GlobalScope_method_lerp>`, combine it with :ref:`ease<class_@GlobalScope_method_ease>` or :ref:`smoothstep<class_@GlobalScope_method_smoothstep>`. See also :ref:`remap<class_@GlobalScope_method_remap>` to map a continuous series of values to another.

\ **Note:** For better type safety, use :ref:`lerpf<class_@GlobalScope_method_lerpf>`, :ref:`Vector2.lerp<class_Vector2_method_lerp>`, :ref:`Vector3.lerp<class_Vector3_method_lerp>`, :ref:`Vector4.lerp<class_Vector4_method_lerp>`, :ref:`Color.lerp<class_Color_method_lerp>`, :ref:`Quaternion.slerp<class_Quaternion_method_slerp>` or :ref:`Basis.slerp<class_Basis_method_slerp>`.

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

----

.. _class_@GlobalScope_method_lerp_angle:

.. rst-class:: classref-method

:ref:`float<class_float>` **lerp_angle** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` weight **)**

Linearly interpolates between two angles (in radians) by a ``weight`` value between 0.0 and 1.0.

Similar to :ref:`lerp<class_@GlobalScope_method_lerp>`, but interpolates correctly when the angles wrap around :ref:`@GDScript.TAU<class_@GDScript_constant_TAU>`. To perform eased interpolation with :ref:`lerp_angle<class_@GlobalScope_method_lerp_angle>`, combine it with :ref:`ease<class_@GlobalScope_method_ease>` or :ref:`smoothstep<class_@GlobalScope_method_smoothstep>`.

::

    extends Sprite
    var elapsed = 0.0
    func _process(delta):
        var min_angle = deg_to_rad(0.0)
        var max_angle = deg_to_rad(90.0)
        rotation = lerp_angle(min_angle, max_angle, elapsed)
        elapsed += delta

\ **Note:** This function lerps through the shortest path between ``from`` and ``to``. However, when these two angles are approximately ``PI + k * TAU`` apart for any integer ``k``, it's not obvious which way they lerp due to floating-point precision errors. For example, ``lerp_angle(0, PI, weight)`` lerps counter-clockwise, while ``lerp_angle(0, PI + 5 * TAU, weight)`` lerps clockwise.

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

----

.. _class_@GlobalScope_method_lerpf:

.. rst-class:: classref-method

:ref:`float<class_float>` **lerpf** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` weight **)**

Linearly interpolates between two values by the factor defined in ``weight``. To perform interpolation, ``weight`` should be between ``0.0`` and ``1.0`` (inclusive). However, values outside this range are allowed and can be used to perform *extrapolation*. If this is not desired, use :ref:`clampf<class_@GlobalScope_method_clampf>` on the result of this function.

::

    lerpf(0, 4, 0.75) # Returns 3.0

See also :ref:`inverse_lerp<class_@GlobalScope_method_inverse_lerp>` which performs the reverse of this operation. To perform eased interpolation with :ref:`lerp<class_@GlobalScope_method_lerp>`, combine it with :ref:`ease<class_@GlobalScope_method_ease>` or :ref:`smoothstep<class_@GlobalScope_method_smoothstep>`.

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

----

.. _class_@GlobalScope_method_linear_to_db:

.. rst-class:: classref-method

:ref:`float<class_float>` **linear_to_db** **(** :ref:`float<class_float>` lin **)**

Converts from linear energy to decibels (audio). This can be used to implement volume sliders that behave as expected (since volume isn't linear).

\ **Example:**\ 

::

    # "Slider" refers to a node that inherits Range such as HSlider or VSlider.
    # Its range must be configured to go from 0 to 1.
    # Change the bus name if you'd like to change the volume of a specific bus only.
    AudioServer.set_bus_volume_db(AudioServer.get_bus_index("Master"), linear_to_db($Slider.value))

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

----

.. _class_@GlobalScope_method_log:

.. rst-class:: classref-method

:ref:`float<class_float>` **log** **(** :ref:`float<class_float>` x **)**

Returns the `natural logarithm <https://en.wikipedia.org/wiki/Natural_logarithm>`__ of ``x`` (base `[i]e[/i] <https://en.wikipedia.org/wiki/E_(mathematical_constant)>`__, with *e* being approximately 2.71828). This is the amount of time needed to reach a certain level of continuous growth.

\ **Note:** This is not the same as the "log" function on most calculators, which uses a base 10 logarithm. To use base 10 logarithm, use ``log(x) / log(10)``.

::

    log(10) # Returns 2.302585

\ **Note:** The logarithm of ``0`` returns ``-inf``, while negative values return ``-nan``.

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

----

.. _class_@GlobalScope_method_max:

.. rst-class:: classref-method

:ref:`Variant<class_Variant>` **max** **(** ... **)** |vararg|

Returns the maximum of the given numeric values. This function can take any number of arguments.

::

    max(1, 7, 3, -6, 5) # Returns 7

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

----

.. _class_@GlobalScope_method_maxf:

.. rst-class:: classref-method

:ref:`float<class_float>` **maxf** **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)**

Returns the maximum of two :ref:`float<class_float>` values.

::

    maxf(3.6, 24)   # Returns 24.0
    maxf(-3.99, -4) # Returns -3.99

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

----

.. _class_@GlobalScope_method_maxi:

.. rst-class:: classref-method

:ref:`int<class_int>` **maxi** **(** :ref:`int<class_int>` a, :ref:`int<class_int>` b **)**

Returns the maximum of two :ref:`int<class_int>` values.

::

    maxi(1, 2)   # Returns 2
    maxi(-3, -4) # Returns -3

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

----

.. _class_@GlobalScope_method_min:

.. rst-class:: classref-method

:ref:`Variant<class_Variant>` **min** **(** ... **)** |vararg|

Returns the minimum of the given numeric values. This function can take any number of arguments.

::

    min(1, 7, 3, -6, 5) # Returns -6

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

----

.. _class_@GlobalScope_method_minf:

.. rst-class:: classref-method

:ref:`float<class_float>` **minf** **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)**

Returns the minimum of two :ref:`float<class_float>` values.

::

    minf(3.6, 24)   # Returns 3.6
    minf(-3.99, -4) # Returns -4.0

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

----

.. _class_@GlobalScope_method_mini:

.. rst-class:: classref-method

:ref:`int<class_int>` **mini** **(** :ref:`int<class_int>` a, :ref:`int<class_int>` b **)**

Returns the minimum of two :ref:`int<class_int>` values.

::

    mini(1, 2)   # Returns 1
    mini(-3, -4) # Returns -4

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

----

.. _class_@GlobalScope_method_move_toward:

.. rst-class:: classref-method

:ref:`float<class_float>` **move_toward** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` delta **)**

Moves ``from`` toward ``to`` by the ``delta`` amount. Will not go past ``to``.

Use a negative ``delta`` value to move away.

::

    move_toward(5, 10, 4)    # Returns 9
    move_toward(10, 5, 4)    # Returns 6
    move_toward(5, 10, 9)    # Returns 10
    move_toward(10, 5, -1.5) # Returns 11.5

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

----

.. _class_@GlobalScope_method_nearest_po2:

.. rst-class:: classref-method

:ref:`int<class_int>` **nearest_po2** **(** :ref:`int<class_int>` value **)**

Returns the smallest integer power of 2 that is greater than or equal to ``value``.

::

    nearest_po2(3) # Returns 4
    nearest_po2(4) # Returns 4
    nearest_po2(5) # Returns 8
    
    nearest_po2(0)  # Returns 0 (this may not be expected)
    nearest_po2(-1) # Returns 0 (this may not be expected)

\ **Warning:** Due to its implementation, this method returns ``0`` rather than ``1`` for values less than or equal to ``0``, with an exception for ``value`` being the smallest negative 64-bit integer (``-9223372036854775808``) in which case the ``value`` is returned unchanged.

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

----

.. _class_@GlobalScope_method_pingpong:

.. rst-class:: classref-method

:ref:`float<class_float>` **pingpong** **(** :ref:`float<class_float>` value, :ref:`float<class_float>` length **)**

Wraps ``value`` between ``0`` and the ``length``. If the limit is reached, the next value the function returns is decreased to the ``0`` side or increased to the ``length`` side (like a triangle wave). If ``length`` is less than zero, it becomes positive.

::

    pingpong(-3.0, 3.0) # Returns 3.0
    pingpong(-2.0, 3.0) # Returns 2.0
    pingpong(-1.0, 3.0) # Returns 1.0
    pingpong(0.0, 3.0)  # Returns 0.0
    pingpong(1.0, 3.0)  # Returns 1.0
    pingpong(2.0, 3.0)  # Returns 2.0
    pingpong(3.0, 3.0)  # Returns 3.0
    pingpong(4.0, 3.0)  # Returns 2.0
    pingpong(5.0, 3.0)  # Returns 1.0
    pingpong(6.0, 3.0)  # Returns 0.0

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

----

.. _class_@GlobalScope_method_posmod:

.. rst-class:: classref-method

:ref:`int<class_int>` **posmod** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y **)**

Returns the integer modulus of ``x`` divided by ``y`` that wraps equally in positive and negative.

::

    print("#(i)  (i % 3)   (posmod(i, 3))")
    for i in range(-3, 4):
        print("%2d       %2d  | %2d" % [i, i % 3, posmod(i, 3)])

Produces:

::

    (i)  (i % 3)   (posmod(i, 3))
    -3        0  |  0
    -2       -2  |  1
    -1       -1  |  2
     0        0  |  0
     1        1  |  1
     2        2  |  2
     3        0  |  0

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

----

.. _class_@GlobalScope_method_pow:

.. rst-class:: classref-method

:ref:`float<class_float>` **pow** **(** :ref:`float<class_float>` base, :ref:`float<class_float>` exp **)**

Returns the result of ``base`` raised to the power of ``exp``.

In GDScript, this is the equivalent of the ``**`` operator.

::

    pow(2, 5)   # Returns 32.0
    pow(4, 1.5) # Returns 8.0

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

----

.. _class_@GlobalScope_method_print:

.. rst-class:: classref-method

void **print** **(** ... **)** |vararg|

Converts one or more arguments of any type to string in the best way possible and prints them to the console.


.. tabs::

 .. code-tab:: gdscript

    var a = [1, 2, 3]
    print("a", "b", a) # Prints ab[1, 2, 3]

 .. code-tab:: csharp

    var a = new Godot.Collections.Array { 1, 2, 3 };
    GD.Print("a", "b", a); // Prints ab[1, 2, 3]



\ **Note:** Consider using :ref:`push_error<class_@GlobalScope_method_push_error>` and :ref:`push_warning<class_@GlobalScope_method_push_warning>` to print error and warning messages instead of :ref:`print<class_@GlobalScope_method_print>` or :ref:`print_rich<class_@GlobalScope_method_print_rich>`. This distinguishes them from print messages used for debugging purposes, while also displaying a stack trace when an error or warning is printed.

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

----

.. _class_@GlobalScope_method_print_rich:

.. rst-class:: classref-method

void **print_rich** **(** ... **)** |vararg|

Converts one or more arguments of any type to string in the best way possible and prints them to the console.

The following BBCode tags are supported: ``b``, ``i``, ``u``, ``s``, ``indent``, ``code``, ``url``, ``center``, ``right``, ``color``, ``bgcolor``, ``fgcolor``.

Color tags only support the following named colors: ``black``, ``red``, ``green``, ``yellow``, ``blue``, ``magenta``, ``pink``, ``purple``, ``cyan``, ``white``, ``orange``, ``gray``. Hexadecimal color codes are not supported.

URL tags only support URLs wrapped by a URL tag, not URLs with a different title.

When printing to standard output, the supported subset of BBCode is converted to ANSI escape codes for the terminal emulator to display. Support for ANSI escape codes varies across terminal emulators, especially for italic and strikethrough. In standard output, ``code`` is represented with faint text but without any font change. Unsupported tags are left as-is in standard output.


.. tabs::

 .. code-tab:: gdscript

    print_rich("[color=green][b]Hello world![/b][/color]") # Prints out "Hello world!" in green with a bold font

 .. code-tab:: csharp

    GD.PrintRich("[color=green][b]Hello world![/b][/color]"); // Prints out "Hello world!" in green with a bold font



\ **Note:** Consider using :ref:`push_error<class_@GlobalScope_method_push_error>` and :ref:`push_warning<class_@GlobalScope_method_push_warning>` to print error and warning messages instead of :ref:`print<class_@GlobalScope_method_print>` or :ref:`print_rich<class_@GlobalScope_method_print_rich>`. This distinguishes them from print messages used for debugging purposes, while also displaying a stack trace when an error or warning is printed.

\ **Note:** On Windows, only Windows 10 and later correctly displays ANSI escape codes in standard output.

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

----

.. _class_@GlobalScope_method_print_verbose:

.. rst-class:: classref-method

void **print_verbose** **(** ... **)** |vararg|

If verbose mode is enabled (:ref:`OS.is_stdout_verbose<class_OS_method_is_stdout_verbose>` returning ``true``), converts one or more arguments of any type to string in the best way possible and prints them to the console.

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

----

.. _class_@GlobalScope_method_printerr:

.. rst-class:: classref-method

void **printerr** **(** ... **)** |vararg|

Prints one or more arguments to strings in the best way possible to standard error line.


.. tabs::

 .. code-tab:: gdscript

    printerr("prints to stderr")

 .. code-tab:: csharp

    GD.PrintErr("prints to stderr");



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

----

.. _class_@GlobalScope_method_printraw:

.. rst-class:: classref-method

void **printraw** **(** ... **)** |vararg|

Prints one or more arguments to strings in the best way possible to the OS terminal. Unlike :ref:`print<class_@GlobalScope_method_print>`, no newline is automatically added at the end.


.. tabs::

 .. code-tab:: gdscript

    printraw("A")
    printraw("B")
    printraw("C")
    # Prints ABC to terminal

 .. code-tab:: csharp

    GD.PrintRaw("A");
    GD.PrintRaw("B");
    GD.PrintRaw("C");
    // Prints ABC to terminal



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

----

.. _class_@GlobalScope_method_prints:

.. rst-class:: classref-method

void **prints** **(** ... **)** |vararg|

Prints one or more arguments to the console with a space between each argument.


.. tabs::

 .. code-tab:: gdscript

    prints("A", "B", "C") # Prints A B C

 .. code-tab:: csharp

    GD.PrintS("A", "B", "C"); // Prints A B C



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

----

.. _class_@GlobalScope_method_printt:

.. rst-class:: classref-method

void **printt** **(** ... **)** |vararg|

Prints one or more arguments to the console with a tab between each argument.


.. tabs::

 .. code-tab:: gdscript

    printt("A", "B", "C") # Prints A       B       C

 .. code-tab:: csharp

    GD.PrintT("A", "B", "C"); // Prints A       B       C



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

----

.. _class_@GlobalScope_method_push_error:

.. rst-class:: classref-method

void **push_error** **(** ... **)** |vararg|

Pushes an error message to Godot's built-in debugger and to the OS terminal.


.. tabs::

 .. code-tab:: gdscript

    push_error("test error") # Prints "test error" to debugger and terminal as error call

 .. code-tab:: csharp

    GD.PushError("test error"); // Prints "test error" to debugger and terminal as error call



\ **Note:** This function does not pause project execution. To print an error message and pause project execution in debug builds, use ``assert(false, "test error")`` instead.

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

----

.. _class_@GlobalScope_method_push_warning:

.. rst-class:: classref-method

void **push_warning** **(** ... **)** |vararg|

Pushes a warning message to Godot's built-in debugger and to the OS terminal.


.. tabs::

 .. code-tab:: gdscript

    push_warning("test warning") # Prints "test warning" to debugger and terminal as warning call

 .. code-tab:: csharp

    GD.PushWarning("test warning"); // Prints "test warning" to debugger and terminal as warning call



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

----

.. _class_@GlobalScope_method_rad_to_deg:

.. rst-class:: classref-method

:ref:`float<class_float>` **rad_to_deg** **(** :ref:`float<class_float>` rad **)**

Converts an angle expressed in radians to degrees.

::

    rad_to_deg(0.523599) # Returns 30
    rad_to_deg(PI)       # Returns 180
    rad_to_deg(PI * 2)   # Returns 360

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

----

.. _class_@GlobalScope_method_rand_from_seed:

.. rst-class:: classref-method

:ref:`PackedInt64Array<class_PackedInt64Array>` **rand_from_seed** **(** :ref:`int<class_int>` seed **)**

Given a ``seed``, returns a :ref:`PackedInt64Array<class_PackedInt64Array>` of size ``2``, where its first element is the randomized :ref:`int<class_int>` value, and the second element is the same as ``seed``. Passing the same ``seed`` consistently returns the same array.

\ **Note:** "Seed" here refers to the internal state of the pseudo random number generator, currently implemented as a 64 bit integer.

::

    var a = rand_from_seed(4)
    
    print(a[0])	# Prints 2879024997
    print(a[1])	# Prints 4

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

----

.. _class_@GlobalScope_method_randf:

.. rst-class:: classref-method

:ref:`float<class_float>` **randf** **(** **)**

Returns a random floating point value between ``0.0`` and ``1.0`` (inclusive).


.. tabs::

 .. code-tab:: gdscript

    randf() # Returns e.g. 0.375671

 .. code-tab:: csharp

    GD.Randf(); // Returns e.g. 0.375671



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

----

.. _class_@GlobalScope_method_randf_range:

.. rst-class:: classref-method

:ref:`float<class_float>` **randf_range** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to **)**

Returns a random floating point value between ``from`` and ``to`` (inclusive).


.. tabs::

 .. code-tab:: gdscript

    randf_range(0, 20.5) # Returns e.g. 7.45315
    randf_range(-10, 10) # Returns e.g. -3.844535

 .. code-tab:: csharp

    GD.RandRange(0.0, 20.5);   // Returns e.g. 7.45315
    GD.RandRange(-10.0, 10.0); // Returns e.g. -3.844535



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

----

.. _class_@GlobalScope_method_randfn:

.. rst-class:: classref-method

:ref:`float<class_float>` **randfn** **(** :ref:`float<class_float>` mean, :ref:`float<class_float>` deviation **)**

Returns a normally-distributed pseudo-random floating point value using Box-Muller transform with the specified ``mean`` and a standard ``deviation``. This is also called Gaussian distribution.

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

----

.. _class_@GlobalScope_method_randi:

.. rst-class:: classref-method

:ref:`int<class_int>` **randi** **(** **)**

Returns a random unsigned 32-bit integer. Use remainder to obtain a random value in the interval ``[0, N - 1]`` (where N is smaller than 2^32).


.. tabs::

 .. code-tab:: gdscript

    randi()           # Returns random integer between 0 and 2^32 - 1
    randi() % 20      # Returns random integer between 0 and 19
    randi() % 100     # Returns random integer between 0 and 99
    randi() % 100 + 1 # Returns random integer between 1 and 100

 .. code-tab:: csharp

    GD.Randi();           // Returns random integer between 0 and 2^32 - 1
    GD.Randi() % 20;      // Returns random integer between 0 and 19
    GD.Randi() % 100;     // Returns random integer between 0 and 99
    GD.Randi() % 100 + 1; // Returns random integer between 1 and 100



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

----

.. _class_@GlobalScope_method_randi_range:

.. rst-class:: classref-method

:ref:`int<class_int>` **randi_range** **(** :ref:`int<class_int>` from, :ref:`int<class_int>` to **)**

Returns a random signed 32-bit integer between ``from`` and ``to`` (inclusive). If ``to`` is lesser than ``from``, they are swapped.


.. tabs::

 .. code-tab:: gdscript

    randi_range(0, 1)      # Returns either 0 or 1
    randi_range(-10, 1000) # Returns random integer between -10 and 1000

 .. code-tab:: csharp

    GD.RandRange(0, 1);      // Returns either 0 or 1
    GD.RandRange(-10, 1000); // Returns random integer between -10 and 1000



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

----

.. _class_@GlobalScope_method_randomize:

.. rst-class:: classref-method

void **randomize** **(** **)**

Randomizes the seed (or the internal state) of the random number generator. The current implementation uses a number based on the device's time.

\ **Note:** This function is called automatically when the project is run. If you need to fix the seed to have consistent, reproducible results, use :ref:`seed<class_@GlobalScope_method_seed>` to initialize the random number generator.

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

----

.. _class_@GlobalScope_method_remap:

.. rst-class:: classref-method

:ref:`float<class_float>` **remap** **(** :ref:`float<class_float>` value, :ref:`float<class_float>` istart, :ref:`float<class_float>` istop, :ref:`float<class_float>` ostart, :ref:`float<class_float>` ostop **)**

Maps a ``value`` from range ``[istart, istop]`` to ``[ostart, ostop]``. See also :ref:`lerp<class_@GlobalScope_method_lerp>` and :ref:`inverse_lerp<class_@GlobalScope_method_inverse_lerp>`. If ``value`` is outside ``[istart, istop]``, then the resulting value will also be outside ``[ostart, ostop]``. If this is not desired, use :ref:`clamp<class_@GlobalScope_method_clamp>` on the result of this function.

::

    remap(75, 0, 100, -1, 1) # Returns 0.5

For complex use cases where multiple ranges are needed, consider using :ref:`Curve<class_Curve>` or :ref:`Gradient<class_Gradient>` instead.

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

----

.. _class_@GlobalScope_method_rid_allocate_id:

.. rst-class:: classref-method

:ref:`int<class_int>` **rid_allocate_id** **(** **)**

Allocates a unique ID which can be used by the implementation to construct a RID. This is used mainly from native extensions to implement servers.

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

----

.. _class_@GlobalScope_method_rid_from_int64:

.. rst-class:: classref-method

:ref:`RID<class_RID>` **rid_from_int64** **(** :ref:`int<class_int>` base **)**

Creates a RID from a ``base``. This is used mainly from native extensions to build servers.

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

----

.. _class_@GlobalScope_method_round:

.. rst-class:: classref-method

:ref:`Variant<class_Variant>` **round** **(** :ref:`Variant<class_Variant>` x **)**

Rounds ``x`` to the nearest whole number, with halfway cases rounded away from 0. Supported types: :ref:`int<class_int>`, :ref:`float<class_float>`, :ref:`Vector2<class_Vector2>`, :ref:`Vector3<class_Vector3>`, :ref:`Vector4<class_Vector4>`.

::

    round(2.4) # Returns 2
    round(2.5) # Returns 3
    round(2.6) # Returns 3

See also :ref:`floor<class_@GlobalScope_method_floor>`, :ref:`ceil<class_@GlobalScope_method_ceil>`, and :ref:`snapped<class_@GlobalScope_method_snapped>`.

\ **Note:** For better type safety, use :ref:`roundf<class_@GlobalScope_method_roundf>`, :ref:`roundi<class_@GlobalScope_method_roundi>`, :ref:`Vector2.round<class_Vector2_method_round>`, :ref:`Vector3.round<class_Vector3_method_round>`, or :ref:`Vector4.round<class_Vector4_method_round>`.

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

----

.. _class_@GlobalScope_method_roundf:

.. rst-class:: classref-method

:ref:`float<class_float>` **roundf** **(** :ref:`float<class_float>` x **)**

Rounds ``x`` to the nearest whole number, with halfway cases rounded away from 0.

A type-safe version of :ref:`round<class_@GlobalScope_method_round>`, returning a :ref:`float<class_float>`.

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

----

.. _class_@GlobalScope_method_roundi:

.. rst-class:: classref-method

:ref:`int<class_int>` **roundi** **(** :ref:`float<class_float>` x **)**

Rounds ``x`` to the nearest whole number, with halfway cases rounded away from 0.

A type-safe version of :ref:`round<class_@GlobalScope_method_round>`, returning an :ref:`int<class_int>`.

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

----

.. _class_@GlobalScope_method_seed:

.. rst-class:: classref-method

void **seed** **(** :ref:`int<class_int>` base **)**

Sets the seed for the random number generator to ``base``. Setting the seed manually can ensure consistent, repeatable results for most random functions.


.. tabs::

 .. code-tab:: gdscript

    var my_seed = "Godot Rocks".hash()
    seed(my_seed)
    var a = randf() + randi()
    seed(my_seed)
    var b = randf() + randi()
    # a and b are now identical

 .. code-tab:: csharp

    ulong mySeed = (ulong)GD.Hash("Godot Rocks");
    GD.Seed(mySeed);
    var a = GD.Randf() + GD.Randi();
    GD.Seed(mySeed);
    var b = GD.Randf() + GD.Randi();
    // a and b are now identical



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

----

.. _class_@GlobalScope_method_sign:

.. rst-class:: classref-method

:ref:`Variant<class_Variant>` **sign** **(** :ref:`Variant<class_Variant>` x **)**

Returns the same type of :ref:`Variant<class_Variant>` as ``x``, with ``-1`` for negative values, ``1`` for positive values, and ``0`` for zeros. Supported types: :ref:`int<class_int>`, :ref:`float<class_float>`, :ref:`Vector2<class_Vector2>`, :ref:`Vector2i<class_Vector2i>`, :ref:`Vector3<class_Vector3>`, :ref:`Vector3i<class_Vector3i>`, :ref:`Vector4<class_Vector4>`, :ref:`Vector4i<class_Vector4i>`.

::

    sign(-6.0) # Returns -1
    sign(0.0)  # Returns 0
    sign(6.0)  # Returns 1
    
    sign(Vector3(-6.0, 0.0, 6.0)) # Returns (-1, 0, 1)

\ **Note:** For better type safety, use :ref:`signf<class_@GlobalScope_method_signf>`, :ref:`signi<class_@GlobalScope_method_signi>`, :ref:`Vector2.sign<class_Vector2_method_sign>`, :ref:`Vector2i.sign<class_Vector2i_method_sign>`, :ref:`Vector3.sign<class_Vector3_method_sign>`, :ref:`Vector3i.sign<class_Vector3i_method_sign>`, :ref:`Vector4.sign<class_Vector4_method_sign>`, or :ref:`Vector4i.sign<class_Vector4i_method_sign>`.

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

----

.. _class_@GlobalScope_method_signf:

.. rst-class:: classref-method

:ref:`float<class_float>` **signf** **(** :ref:`float<class_float>` x **)**

Returns ``-1.0`` if ``x`` is negative, ``1.0`` if ``x`` is positive, and ``0.0`` if ``x`` is zero.

::

    signf(-6.5) # Returns -1.0
    signf(0.0)  # Returns 0.0
    signf(6.5)  # Returns 1.0

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

----

.. _class_@GlobalScope_method_signi:

.. rst-class:: classref-method

:ref:`int<class_int>` **signi** **(** :ref:`int<class_int>` x **)**

Returns ``-1`` if ``x`` is negative, ``1`` if ``x`` is positive, and ``0`` if if ``x`` is zero.

::

    signi(-6) # Returns -1
    signi(0)  # Returns 0
    signi(6)  # Returns 1

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

----

.. _class_@GlobalScope_method_sin:

.. rst-class:: classref-method

:ref:`float<class_float>` **sin** **(** :ref:`float<class_float>` angle_rad **)**

Returns the sine of angle ``angle_rad`` in radians.

::

    sin(0.523599)       # Returns 0.5
    sin(deg_to_rad(90)) # Returns 1.0

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

----

.. _class_@GlobalScope_method_sinh:

.. rst-class:: classref-method

:ref:`float<class_float>` **sinh** **(** :ref:`float<class_float>` x **)**

Returns the hyperbolic sine of ``x``.

::

    var a = log(2.0) # Returns 0.693147
    sinh(a) # Returns 0.75

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

----

.. _class_@GlobalScope_method_smoothstep:

.. rst-class:: classref-method

:ref:`float<class_float>` **smoothstep** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` x **)**

Returns the result of smoothly interpolating the value of ``x`` between ``0`` and ``1``, based on the where ``x`` lies with respect to the edges ``from`` and ``to``.

The return value is ``0`` if ``x <= from``, and ``1`` if ``x >= to``. If ``x`` lies between ``from`` and ``to``, the returned value follows an S-shaped curve that maps ``x`` between ``0`` and ``1``.

This S-shaped curve is the cubic Hermite interpolator, given by ``f(y) = 3*y^2 - 2*y^3`` where ``y = (x-from) / (to-from)``.

::

    smoothstep(0, 2, -5.0) # Returns 0.0
    smoothstep(0, 2, 0.5) # Returns 0.15625
    smoothstep(0, 2, 1.0) # Returns 0.5
    smoothstep(0, 2, 2.0) # Returns 1.0

Compared to :ref:`ease<class_@GlobalScope_method_ease>` with a curve value of ``-1.6521``, :ref:`smoothstep<class_@GlobalScope_method_smoothstep>` returns the smoothest possible curve with no sudden changes in the derivative. If you need to perform more advanced transitions, use :ref:`Tween<class_Tween>` or :ref:`AnimationPlayer<class_AnimationPlayer>`.

\ `Comparison between smoothstep() and ease(x, -1.6521) return values <https://raw.githubusercontent.com/godotengine/godot-docs/master/img/smoothstep_ease_comparison.png>`__

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

----

.. _class_@GlobalScope_method_snapped:

.. rst-class:: classref-method

:ref:`Variant<class_Variant>` **snapped** **(** :ref:`Variant<class_Variant>` x, :ref:`Variant<class_Variant>` step **)**

Returns the multiple of ``step`` that is the closest to ``x``. This can also be used to round a floating point number to an arbitrary number of decimals.

The returned value is the same type of :ref:`Variant<class_Variant>` as ``step``. Supported types: :ref:`int<class_int>`, :ref:`float<class_float>`, :ref:`Vector2<class_Vector2>`, :ref:`Vector2i<class_Vector2i>`, :ref:`Vector3<class_Vector3>`, :ref:`Vector3i<class_Vector3i>`, :ref:`Vector4<class_Vector4>`, :ref:`Vector4i<class_Vector4i>`.

::

    snapped(100, 32)  # Returns 96
    snapped(3.14159, 0.01)  # Returns 3.14
    
    snapped(Vector2(34, 70), Vector2(8, 8))  # Returns (32, 72)

See also :ref:`ceil<class_@GlobalScope_method_ceil>`, :ref:`floor<class_@GlobalScope_method_floor>`, and :ref:`round<class_@GlobalScope_method_round>`.

\ **Note:** For better type safety, use :ref:`snappedf<class_@GlobalScope_method_snappedf>`, :ref:`snappedi<class_@GlobalScope_method_snappedi>`, :ref:`Vector2.snapped<class_Vector2_method_snapped>`, :ref:`Vector2i.snapped<class_Vector2i_method_snapped>`, :ref:`Vector3.snapped<class_Vector3_method_snapped>`, :ref:`Vector3i.snapped<class_Vector3i_method_snapped>`, :ref:`Vector4.snapped<class_Vector4_method_snapped>`, or :ref:`Vector4i.snapped<class_Vector4i_method_snapped>`.

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

----

.. _class_@GlobalScope_method_snappedf:

.. rst-class:: classref-method

:ref:`float<class_float>` **snappedf** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` step **)**

Returns the multiple of ``step`` that is the closest to ``x``. This can also be used to round a floating point number to an arbitrary number of decimals.

A type-safe version of :ref:`snapped<class_@GlobalScope_method_snapped>`, returning a :ref:`float<class_float>`.

::

    snappedf(32.0, 2.5)  # Returns 32.5
    snappedf(3.14159, 0.01)  # Returns 3.14

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

----

.. _class_@GlobalScope_method_snappedi:

.. rst-class:: classref-method

:ref:`int<class_int>` **snappedi** **(** :ref:`float<class_float>` x, :ref:`int<class_int>` step **)**

Returns the multiple of ``step`` that is the closest to ``x``.

A type-safe version of :ref:`snapped<class_@GlobalScope_method_snapped>`, returning an :ref:`int<class_int>`.

::

    snappedi(53, 16)  # Returns 48
    snappedi(4096, 100)  # Returns 4100

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

----

.. _class_@GlobalScope_method_sqrt:

.. rst-class:: classref-method

:ref:`float<class_float>` **sqrt** **(** :ref:`float<class_float>` x **)**

Returns the square root of ``x``, where ``x`` is a non-negative number.

::

    sqrt(9)     # Returns 3
    sqrt(10.24) # Returns 3.2
    sqrt(-1)    # Returns NaN

\ **Note:** Negative values of ``x`` return NaN ("Not a Number"). in C#, if you need negative inputs, use ``System.Numerics.Complex``.

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

----

.. _class_@GlobalScope_method_step_decimals:

.. rst-class:: classref-method

:ref:`int<class_int>` **step_decimals** **(** :ref:`float<class_float>` x **)**

Returns the position of the first non-zero digit, after the decimal point. Note that the maximum return value is 10, which is a design decision in the implementation.

::

    var n = step_decimals(5)       # n is 0
    n = step_decimals(1.0005)      # n is 4
    n = step_decimals(0.000000005) # n is 9

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

----

.. _class_@GlobalScope_method_str:

.. rst-class:: classref-method

:ref:`String<class_String>` **str** **(** ... **)** |vararg|

Converts one or more arguments of any :ref:`Variant<class_Variant>` type to a :ref:`String<class_String>` in the best way possible.

::

    var a = [10, 20, 30]
    var b = str(a)
    print(len(a)) # Prints 3 (the number of elements in the array).
    print(len(b)) # Prints 12 (the length of the string "[10, 20, 30]").

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

----

.. _class_@GlobalScope_method_str_to_var:

.. rst-class:: classref-method

:ref:`Variant<class_Variant>` **str_to_var** **(** :ref:`String<class_String>` string **)**

Converts a formatted ``string`` that was returned by :ref:`var_to_str<class_@GlobalScope_method_var_to_str>` to the original :ref:`Variant<class_Variant>`.


.. tabs::

 .. code-tab:: gdscript

    var data = '{ "a": 1, "b": 2 }' # data is a String
    var dict = str_to_var(data)     # dict is a Dictionary
    print(dict["a"])                # Prints 1

 .. code-tab:: csharp

    string data = "{ \"a\": 1, \"b\": 2 }";           // data is a string
    var dict = GD.StrToVar(data).AsGodotDictionary(); // dict is a Dictionary
    GD.Print(dict["a"]);                              // Prints 1



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

----

.. _class_@GlobalScope_method_tan:

.. rst-class:: classref-method

:ref:`float<class_float>` **tan** **(** :ref:`float<class_float>` angle_rad **)**

Returns the tangent of angle ``angle_rad`` in radians.

::

    tan(deg_to_rad(45)) # Returns 1

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

----

.. _class_@GlobalScope_method_tanh:

.. rst-class:: classref-method

:ref:`float<class_float>` **tanh** **(** :ref:`float<class_float>` x **)**

Returns the hyperbolic tangent of ``x``.

::

    var a = log(2.0) # Returns 0.693147
    tanh(a)          # Returns 0.6

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

----

.. _class_@GlobalScope_method_typeof:

.. rst-class:: classref-method

:ref:`int<class_int>` **typeof** **(** :ref:`Variant<class_Variant>` variable **)**

Returns the internal type of the given ``variable``, using the :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` values.

::

    var json = JSON.new()
    json.parse('["a", "b", "c"]')
    var result = json.get_data()
    if typeof(result) == TYPE_ARRAY:
        print(result[0]) # Prints a
    else:
        print("Unexpected result")

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

----

.. _class_@GlobalScope_method_var_to_bytes:

.. rst-class:: classref-method

:ref:`PackedByteArray<class_PackedByteArray>` **var_to_bytes** **(** :ref:`Variant<class_Variant>` variable **)**

Encodes a :ref:`Variant<class_Variant>` value to a byte array, without encoding objects. Deserialization can be done with :ref:`bytes_to_var<class_@GlobalScope_method_bytes_to_var>`.

\ **Note:** If you need object serialization, see :ref:`var_to_bytes_with_objects<class_@GlobalScope_method_var_to_bytes_with_objects>`.

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

----

.. _class_@GlobalScope_method_var_to_bytes_with_objects:

.. rst-class:: classref-method

:ref:`PackedByteArray<class_PackedByteArray>` **var_to_bytes_with_objects** **(** :ref:`Variant<class_Variant>` variable **)**

Encodes a :ref:`Variant<class_Variant>` value to a byte array. Encoding objects is allowed (and can potentially include executable code). Deserialization can be done with :ref:`bytes_to_var_with_objects<class_@GlobalScope_method_bytes_to_var_with_objects>`.

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

----

.. _class_@GlobalScope_method_var_to_str:

.. rst-class:: classref-method

:ref:`String<class_String>` **var_to_str** **(** :ref:`Variant<class_Variant>` variable **)**

Converts a :ref:`Variant<class_Variant>` ``variable`` to a formatted :ref:`String<class_String>` that can then be parsed using :ref:`str_to_var<class_@GlobalScope_method_str_to_var>`.


.. tabs::

 .. code-tab:: gdscript

    var a = { "a": 1, "b": 2 }
    print(var_to_str(a))

 .. code-tab:: csharp

    var a = new Godot.Collections.Dictionary { ["a"] = 1, ["b"] = 2 };
    GD.Print(GD.VarToStr(a));



Prints:

::

    {
        "a": 1,
        "b": 2
    }

\ **Note:** Converting :ref:`Signal<class_Signal>` or :ref:`Callable<class_Callable>` is not supported and will result in an empty value for these types, regardless of their data.

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

----

.. _class_@GlobalScope_method_weakref:

.. rst-class:: classref-method

:ref:`Variant<class_Variant>` **weakref** **(** :ref:`Variant<class_Variant>` obj **)**

Returns a weak reference to an object, or ``null`` if ``obj`` is invalid.

A weak reference to an object is not enough to keep the object alive: when the only remaining references to a referent are weak references, garbage collection is free to destroy the referent and reuse its memory for something else. However, until the object is actually destroyed the weak reference may return the object even if there are no strong references to it.

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

----

.. _class_@GlobalScope_method_wrap:

.. rst-class:: classref-method

:ref:`Variant<class_Variant>` **wrap** **(** :ref:`Variant<class_Variant>` value, :ref:`Variant<class_Variant>` min, :ref:`Variant<class_Variant>` max **)**

Wraps the :ref:`Variant<class_Variant>` ``value`` between ``min`` and ``max``. Can be used for creating loop-alike behavior or infinite surfaces.

Variant types :ref:`int<class_int>` and :ref:`float<class_float>` are supported. If any of the arguments is :ref:`float<class_float>` this function returns a :ref:`float<class_float>`, otherwise it returns an :ref:`int<class_int>`.

::

    var a = wrap(4, 5, 10)
    # a is 9 (int)
    
    var a = wrap(7, 5, 10)
    # a is 7 (int)
    
    var a = wrap(10.5, 5, 10)
    # a is 5.5 (float)

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

----

.. _class_@GlobalScope_method_wrapf:

.. rst-class:: classref-method

:ref:`float<class_float>` **wrapf** **(** :ref:`float<class_float>` value, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)**

Wraps the float ``value`` between ``min`` and ``max``. Can be used for creating loop-alike behavior or infinite surfaces.

::

    # Infinite loop between 5.0 and 9.9
    value = wrapf(value + 0.1, 5.0, 10.0)

::

    # Infinite rotation (in radians)
    angle = wrapf(angle + 0.1, 0.0, TAU)

::

    # Infinite rotation (in radians)
    angle = wrapf(angle + 0.1, -PI, PI)

\ **Note:** If ``min`` is ``0``, this is equivalent to :ref:`fposmod<class_@GlobalScope_method_fposmod>`, so prefer using that instead.

\ ``wrapf`` is more flexible than using the :ref:`fposmod<class_@GlobalScope_method_fposmod>` approach by giving the user control over the minimum value.

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

----

.. _class_@GlobalScope_method_wrapi:

.. rst-class:: classref-method

:ref:`int<class_int>` **wrapi** **(** :ref:`int<class_int>` value, :ref:`int<class_int>` min, :ref:`int<class_int>` max **)**

Wraps the integer ``value`` between ``min`` and ``max``. Can be used for creating loop-alike behavior or infinite surfaces.

::

    # Infinite loop between 5 and 9
    frame = wrapi(frame + 1, 5, 10)

::

    # result is -2
    var result = wrapi(-6, -5, -1)

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