godot-docs/classes/class_generic6dofjoint.rst

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

.. _class_Generic6DOFJoint:

Generic6DOFJoint
================

**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_x<class_Generic6DOFJoint_get_flag_x>`  **(** :ref:`int<class_int>` flag  **)** const                               |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`    | :ref:`get_flag_y<class_Generic6DOFJoint_get_flag_y>`  **(** :ref:`int<class_int>` flag  **)** const                               |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`    | :ref:`get_flag_z<class_Generic6DOFJoint_get_flag_z>`  **(** :ref:`int<class_int>` flag  **)** const                               |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`  | :ref:`get_param_x<class_Generic6DOFJoint_get_param_x>`  **(** :ref:`int<class_int>` param  **)** const                            |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`  | :ref:`get_param_y<class_Generic6DOFJoint_get_param_y>`  **(** :ref:`int<class_int>` param  **)** const                            |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`  | :ref:`get_param_z<class_Generic6DOFJoint_get_param_z>`  **(** :ref:`int<class_int>` param  **)** const                            |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_flag_x<class_Generic6DOFJoint_set_flag_x>`  **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value  **)**      |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_flag_y<class_Generic6DOFJoint_set_flag_y>`  **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value  **)**      |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_flag_z<class_Generic6DOFJoint_set_flag_z>`  **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value  **)**      |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_param_x<class_Generic6DOFJoint_set_param_x>`  **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value  **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_param_y<class_Generic6DOFJoint_set_param_y>`  **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value  **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_param_z<class_Generic6DOFJoint_set_param_z>`  **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value  **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+

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

- :ref:`float<class_float>` **angular_limit_x/damping**
- :ref:`bool<class_bool>` **angular_limit_x/enabled**
- :ref:`float<class_float>` **angular_limit_x/erp**
- :ref:`float<class_float>` **angular_limit_x/force_limit**
- :ref:`float<class_float>` **angular_limit_x/lower_angle**
- :ref:`float<class_float>` **angular_limit_x/restitution**
- :ref:`float<class_float>` **angular_limit_x/softness**
- :ref:`float<class_float>` **angular_limit_x/upper_angle**
- :ref:`float<class_float>` **angular_limit_y/damping**
- :ref:`bool<class_bool>` **angular_limit_y/enabled**
- :ref:`float<class_float>` **angular_limit_y/erp**
- :ref:`float<class_float>` **angular_limit_y/force_limit**
- :ref:`float<class_float>` **angular_limit_y/lower_angle**
- :ref:`float<class_float>` **angular_limit_y/restitution**
- :ref:`float<class_float>` **angular_limit_y/softness**
- :ref:`float<class_float>` **angular_limit_y/upper_angle**
- :ref:`float<class_float>` **angular_limit_z/damping**
- :ref:`bool<class_bool>` **angular_limit_z/enabled**
- :ref:`float<class_float>` **angular_limit_z/erp**
- :ref:`float<class_float>` **angular_limit_z/force_limit**
- :ref:`float<class_float>` **angular_limit_z/lower_angle**
- :ref:`float<class_float>` **angular_limit_z/restitution**
- :ref:`float<class_float>` **angular_limit_z/softness**
- :ref:`float<class_float>` **angular_limit_z/upper_angle**
- :ref:`bool<class_bool>` **angular_motor_x/enabled**
- :ref:`float<class_float>` **angular_motor_x/force_limit**
- :ref:`float<class_float>` **angular_motor_x/target_velocity**
- :ref:`bool<class_bool>` **angular_motor_y/enabled**
- :ref:`float<class_float>` **angular_motor_y/force_limit**
- :ref:`float<class_float>` **angular_motor_y/target_velocity**
- :ref:`bool<class_bool>` **angular_motor_z/enabled**
- :ref:`float<class_float>` **angular_motor_z/force_limit**
- :ref:`float<class_float>` **angular_motor_z/target_velocity**
- :ref:`float<class_float>` **linear_limit_x/damping**
- :ref:`bool<class_bool>` **linear_limit_x/enabled**
- :ref:`float<class_float>` **linear_limit_x/lower_distance**
- :ref:`float<class_float>` **linear_limit_x/restitution**
- :ref:`float<class_float>` **linear_limit_x/softness**
- :ref:`float<class_float>` **linear_limit_x/upper_distance**
- :ref:`float<class_float>` **linear_limit_y/damping**
- :ref:`bool<class_bool>` **linear_limit_y/enabled**
- :ref:`float<class_float>` **linear_limit_y/lower_distance**
- :ref:`float<class_float>` **linear_limit_y/restitution**
- :ref:`float<class_float>` **linear_limit_y/softness**
- :ref:`float<class_float>` **linear_limit_y/upper_distance**
- :ref:`float<class_float>` **linear_limit_z/damping**
- :ref:`bool<class_bool>` **linear_limit_z/enabled**
- :ref:`float<class_float>` **linear_limit_z/lower_distance**
- :ref:`float<class_float>` **linear_limit_z/restitution**
- :ref:`float<class_float>` **linear_limit_z/softness**
- :ref:`float<class_float>` **linear_limit_z/upper_distance**

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

- **PARAM_LINEAR_LOWER_LIMIT** = **0**
- **PARAM_LINEAR_UPPER_LIMIT** = **1**
- **PARAM_LINEAR_LIMIT_SOFTNESS** = **2**
- **PARAM_LINEAR_RESTITUTION** = **3**
- **PARAM_LINEAR_DAMPING** = **4**
- **PARAM_ANGULAR_LOWER_LIMIT** = **5**
- **PARAM_ANGULAR_UPPER_LIMIT** = **6**
- **PARAM_ANGULAR_LIMIT_SOFTNESS** = **7**
- **PARAM_ANGULAR_DAMPING** = **8**
- **PARAM_ANGULAR_RESTITUTION** = **9**
- **PARAM_ANGULAR_FORCE_LIMIT** = **10**
- **PARAM_ANGULAR_ERP** = **11**
- **PARAM_ANGULAR_MOTOR_TARGET_VELOCITY** = **12**
- **PARAM_ANGULAR_MOTOR_FORCE_LIMIT** = **13**
- **PARAM_MAX** = **14**
- **FLAG_ENABLE_LINEAR_LIMIT** = **0**
- **FLAG_ENABLE_ANGULAR_LIMIT** = **1**
- **FLAG_ENABLE_MOTOR** = **2**
- **FLAG_MAX** = **3**

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

.. _class_Generic6DOFJoint_get_flag_x:

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

.. _class_Generic6DOFJoint_get_flag_y:

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

.. _class_Generic6DOFJoint_get_flag_z:

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

.. _class_Generic6DOFJoint_get_param_x:

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

.. _class_Generic6DOFJoint_get_param_y:

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

.. _class_Generic6DOFJoint_get_param_z:

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

.. _class_Generic6DOFJoint_set_flag_x:

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

.. _class_Generic6DOFJoint_set_flag_y:

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

.. _class_Generic6DOFJoint_set_flag_z:

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

.. _class_Generic6DOFJoint_set_param_x:

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

.. _class_Generic6DOFJoint_set_param_y:

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

.. _class_Generic6DOFJoint_set_param_z:

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