Files
godot-docs/classes/class_hingejoint.rst
Rémi Verschelde 577559cfe9 Sync classes with upstream 2.0 branch
Constants get reordered in their definition order.
2016-07-08 23:46:59 +02:00

67 lines
2.7 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _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 **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
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 **)**