class_pinjoint2d.rst 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the PinJoint2D.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_PinJoint2D:
  5. PinJoint2D
  6. ==========
  7. **Inherits:** :ref:`Joint2D<class_Joint2D>` **<** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Pin Joint for 2D Shapes.
  12. Properties
  13. ----------
  14. +---------------------------+--------------------------------------------+
  15. | :ref:`float<class_float>` | :ref:`softness<class_PinJoint2D_softness>` |
  16. +---------------------------+--------------------------------------------+
  17. Description
  18. -----------
  19. Pin Joint for 2D Rigid Bodies. It pins two bodies (rigid or static) together.
  20. Property Descriptions
  21. ---------------------
  22. .. _class_PinJoint2D_softness:
  23. - :ref:`float<class_float>` **softness**
  24. +----------+---------------------+
  25. | *Setter* | set_softness(value) |
  26. +----------+---------------------+
  27. | *Getter* | get_softness() |
  28. +----------+---------------------+
  29. The higher this value, the more the bond to the pinned partner can flex.