: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/PinJoint3D.xml. .. _class_PinJoint3D: PinJoint3D ========== **Inherits:** :ref:`Joint3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` A physics joint that attaches two 3D physics bodies at a single point, allowing them to freely rotate. .. rst-class:: classref-introduction-group Description ----------- A physics joint that attaches two 3D physics bodies at a single point, allowing them to freely rotate. For example, a :ref:`RigidBody3D` can be attached to a :ref:`StaticBody3D` to create a pendulum or a seesaw. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------+-----------------------------------------------------------------------------+---------+ | :ref:`float` | :ref:`params/bias` | ``0.3`` | +---------------------------+-----------------------------------------------------------------------------+---------+ | :ref:`float` | :ref:`params/damping` | ``1.0`` | +---------------------------+-----------------------------------------------------------------------------+---------+ | :ref:`float` | :ref:`params/impulse_clamp` | ``0.0`` | +---------------------------+-----------------------------------------------------------------------------+---------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_param`\ (\ param\: :ref:`Param`\ ) |const| | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_param`\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) | +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_PinJoint3D_Param: .. rst-class:: classref-enumeration enum **Param**: :ref:`🔗` .. _class_PinJoint3D_constant_PARAM_BIAS: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_BIAS** = ``0`` The force with which the pinned objects stay in positional relation to each other. The higher, the stronger. .. _class_PinJoint3D_constant_PARAM_DAMPING: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_DAMPING** = ``1`` The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger. .. _class_PinJoint3D_constant_PARAM_IMPULSE_CLAMP: .. rst-class:: classref-enumeration-constant :ref:`Param` **PARAM_IMPULSE_CLAMP** = ``2`` If above 0, this value is the maximum value for an impulse that this Joint3D produces. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_PinJoint3D_property_params/bias: .. rst-class:: classref-property :ref:`float` **params/bias** = ``0.3`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) - :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The force with which the pinned objects stay in positional relation to each other. The higher, the stronger. .. rst-class:: classref-item-separator ---- .. _class_PinJoint3D_property_params/damping: .. rst-class:: classref-property :ref:`float` **params/damping** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) - :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| The force with which the pinned objects stay in velocity relation to each other. The higher, the stronger. .. rst-class:: classref-item-separator ---- .. _class_PinJoint3D_property_params/impulse_clamp: .. rst-class:: classref-property :ref:`float` **params/impulse_clamp** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) - :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| If above 0, this value is the maximum value for an impulse that this Joint3D produces. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_PinJoint3D_method_get_param: .. rst-class:: classref-method :ref:`float` **get_param**\ (\ param\: :ref:`Param`\ ) |const| :ref:`🔗` Returns the value of the specified parameter. .. rst-class:: classref-item-separator ---- .. _class_PinJoint3D_method_set_param: .. rst-class:: classref-method |void| **set_param**\ (\ param\: :ref:`Param`, value\: :ref:`float`\ ) :ref:`🔗` Sets the value of the specified parameter. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)` .. |void| replace:: :abbr:`void (No return value.)`