class_pinjoint2d.rst 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the PinJoint2D.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_PinJoint2D:
  6. PinJoint2D
  7. ==========
  8. **Inherits:** :ref:`Joint2D<class_Joint2D>` **<** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  9. Pin Joint for 2D shapes.
  10. Description
  11. -----------
  12. Pin Joint for 2D rigid bodies. It pins two bodies (rigid or static) together.
  13. Properties
  14. ----------
  15. +---------------------------+-----------------------------------------------------+---------+
  16. | :ref:`float<class_float>` | :ref:`softness<class_PinJoint2D_property_softness>` | ``0.0`` |
  17. +---------------------------+-----------------------------------------------------+---------+
  18. Property Descriptions
  19. ---------------------
  20. .. _class_PinJoint2D_property_softness:
  21. - :ref:`float<class_float>` **softness**
  22. +-----------+---------------------+
  23. | *Default* | ``0.0`` |
  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.
  30. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  31. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  32. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`