Files
godot-docs/classes/class_joint2d.rst
2018-09-13 01:56:47 +02:00

44 lines
1.7 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Joint2D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_Joint2D:
Joint2D
=======
**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`PinJoint2D<class_PinJoint2D>`, :ref:`DampedSpringJoint2D<class_DampedSpringJoint2D>`, :ref:`GrooveJoint2D<class_GrooveJoint2D>`
**Category:** Core
Brief Description
-----------------
Base node for all joint constraints in 2D physics.
Description
-----------
Base node for all joint constraints in 2D physics. Joints take 2 bodies and apply a custom constraint.
Property Descriptions
---------------------
.. _class_Joint2D_bias:
- :ref:`float<class_float>` **bias** - When :ref:`node_a<class_Joint2D_node_a>` and :ref:`node_b<class_Joint2D_node_b>` move in different directions the ``bias`` controls how fast the joint pulls them back to their original position. The lower the ``bias`` the more the two bodies can pull on the joint. Default value: ``0``
.. _class_Joint2D_disable_collision:
- :ref:`bool<class_bool>` **disable_collision** - If ``true`` :ref:`node_a<class_Joint2D_node_a>` and :ref:`node_b<class_Joint2D_node_b>` can collide. Default value: ``false``.
.. _class_Joint2D_node_a:
- :ref:`NodePath<class_NodePath>` **node_a** - The first body attached to the joint. Must derive from :ref:`PhysicsBody2D<class_PhysicsBody2D>`.
.. _class_Joint2D_node_b:
- :ref:`NodePath<class_NodePath>` **node_b** - The second body attached to the joint. Must derive from :ref:`PhysicsBody2D<class_PhysicsBody2D>`.