class_pinjoint2d.rst 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.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. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Pin Joint for 2D Shapes.
  13. Properties
  14. ----------
  15. +---------------------------+-----------------------------------------------------+
  16. | :ref:`float<class_float>` | :ref:`softness<class_PinJoint2D_property_softness>` |
  17. +---------------------------+-----------------------------------------------------+
  18. Description
  19. -----------
  20. Pin Joint for 2D Rigid Bodies. It pins two bodies (rigid or static) together.
  21. Property Descriptions
  22. ---------------------
  23. .. _class_PinJoint2D_property_softness:
  24. - :ref:`float<class_float>` **softness**
  25. +----------+---------------------+
  26. | *Setter* | set_softness(value) |
  27. +----------+---------------------+
  28. | *Getter* | get_softness() |
  29. +----------+---------------------+
  30. The higher this value, the more the bond to the pinned partner can flex.