classref: Sync with latest 4.0-dev

classes/class_pinjoint3d.rst

@@ -0,0 +1,131 @@
+:github_url: hide
+
+.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
+.. DO NOT EDIT THIS FILE, but the PinJoint3D.xml source instead.
+.. The source is found in doc/classes or modules/<name>/doc_classes.
+
+.. _class_PinJoint3D:
+
+PinJoint3D
+==========
+
+**Inherits:** :ref:`Joint3D<class_Joint3D>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
+
+Pin joint for 3D PhysicsBodies.
+
+Description
+-----------
+
+Pin joint for 3D rigid bodies. It pins 2 bodies (dynamic or static) together. See also :ref:`Generic6DOFJoint3D<class_Generic6DOFJoint3D>`.
+
+Properties
+----------
+
++---------------------------+-----------------------------------------------------------------------------+---------+
+| :ref:`float<class_float>` | :ref:`params/bias<class_PinJoint3D_property_params/bias>`                   | ``0.3`` |
++---------------------------+-----------------------------------------------------------------------------+---------+
+| :ref:`float<class_float>` | :ref:`params/damping<class_PinJoint3D_property_params/damping>`             | ``1.0`` |
++---------------------------+-----------------------------------------------------------------------------+---------+
+| :ref:`float<class_float>` | :ref:`params/impulse_clamp<class_PinJoint3D_property_params/impulse_clamp>` | ``0.0`` |
++---------------------------+-----------------------------------------------------------------------------+---------+
+
+Methods
+-------
+
++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`float<class_float>` | :ref:`get_param<class_PinJoint3D_method_get_param>` **(** :ref:`Param<enum_PinJoint3D_Param>` param **)** |const|                          |
++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+| void                      | :ref:`set_param<class_PinJoint3D_method_set_param>` **(** :ref:`Param<enum_PinJoint3D_Param>` param, :ref:`float<class_float>` value **)** |
++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+
+Enumerations
+------------
+
+.. _enum_PinJoint3D_Param:
+
+.. _class_PinJoint3D_constant_PARAM_BIAS:
+
+.. _class_PinJoint3D_constant_PARAM_DAMPING:
+
+.. _class_PinJoint3D_constant_PARAM_IMPULSE_CLAMP:
+
+enum **Param**:
+
+- **PARAM_BIAS** = **0** --- The force with which the pinned objects stay in positional relation to each other. The higher, the stronger.
+
+- **PARAM_DAMPING** = **1** --- The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger.
+
+- **PARAM_IMPULSE_CLAMP** = **2** --- If above 0, this value is the maximum value for an impulse that this Joint3D produces.
+
+Property Descriptions
+---------------------
+
+.. _class_PinJoint3D_property_params/bias:
+
+- :ref:`float<class_float>` **params/bias**
+
++-----------+------------------+
+| *Default* | ``0.3``          |
++-----------+------------------+
+| *Setter*  | set_param(value) |
++-----------+------------------+
+| *Getter*  | get_param()      |
++-----------+------------------+
+
+The force with which the pinned objects stay in positional relation to each other. The higher, the stronger.
+
+----
+
+.. _class_PinJoint3D_property_params/damping:
+
+- :ref:`float<class_float>` **params/damping**
+
++-----------+------------------+
+| *Default* | ``1.0``          |
++-----------+------------------+
+| *Setter*  | set_param(value) |
++-----------+------------------+
+| *Getter*  | get_param()      |
++-----------+------------------+
+
+The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger.
+
+----
+
+.. _class_PinJoint3D_property_params/impulse_clamp:
+
+- :ref:`float<class_float>` **params/impulse_clamp**
+
++-----------+------------------+
+| *Default* | ``0.0``          |
++-----------+------------------+
+| *Setter*  | set_param(value) |
++-----------+------------------+
+| *Getter*  | get_param()      |
++-----------+------------------+
+
+If above 0, this value is the maximum value for an impulse that this Joint3D produces.
+
+Method Descriptions
+-------------------
+
+.. _class_PinJoint3D_method_get_param:
+
+- :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_PinJoint3D_Param>` param **)** |const|
+
+Returns the value of the specified parameter.
+
+----
+
+.. _class_PinJoint3D_method_set_param:
+
+- void **set_param** **(** :ref:`Param<enum_PinJoint3D_Param>` param, :ref:`float<class_float>` value **)**
+
+Sets the value of the specified parameter.
+
+.. |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.)`