godot-docs/classes/class_hingejoint.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the HingeJoint.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_HingeJoint:

HingeJoint
==========

**Inherits:** :ref:`Joint<class_joint>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------



Member Functions
----------------

+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`    | :ref:`get_flag<class_HingeJoint_get_flag>`  **(** :ref:`int<class_int>` flag  **)** const                               |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`  | :ref:`get_param<class_HingeJoint_get_param>`  **(** :ref:`int<class_int>` param  **)** const                            |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_flag<class_HingeJoint_set_flag>`  **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` enabled  **)**    |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_param<class_HingeJoint_set_param>`  **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value  **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+

Member Variables
----------------

- :ref:`float<class_float>` **angular_limit/bias**
- :ref:`bool<class_bool>` **angular_limit/enable**
- :ref:`float<class_float>` **angular_limit/lower**
- :ref:`float<class_float>` **angular_limit/relaxation**
- :ref:`float<class_float>` **angular_limit/softness**
- :ref:`float<class_float>` **angular_limit/upper**
- :ref:`bool<class_bool>` **motor/enable**
- :ref:`float<class_float>` **motor/max_impulse**
- :ref:`float<class_float>` **motor/target_velocity**
- :ref:`float<class_float>` **params/bias**

Numeric Constants
-----------------

- **PARAM_BIAS** = **0**
- **PARAM_LIMIT_UPPER** = **1**
- **PARAM_LIMIT_LOWER** = **2**
- **PARAM_LIMIT_BIAS** = **3**
- **PARAM_LIMIT_SOFTNESS** = **4**
- **PARAM_LIMIT_RELAXATION** = **5**
- **PARAM_MOTOR_TARGET_VELOCITY** = **6**
- **PARAM_MOTOR_MAX_IMPULSE** = **7**
- **PARAM_MAX** = **8**
- **FLAG_USE_LIMIT** = **0**
- **FLAG_ENABLE_MOTOR** = **1**
- **FLAG_MAX** = **2**

Member Function Description
---------------------------

.. _class_HingeJoint_get_flag:

- :ref:`bool<class_bool>`  **get_flag**  **(** :ref:`int<class_int>` flag  **)** const

.. _class_HingeJoint_get_param:

- :ref:`float<class_float>`  **get_param**  **(** :ref:`int<class_int>` param  **)** const

.. _class_HingeJoint_set_flag:

- void  **set_flag**  **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` enabled  **)**

.. _class_HingeJoint_set_param:

- void  **set_param**  **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value  **)**