class_pinjoint2d.rst 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PinJoint2D.xml.
  6. .. _class_PinJoint2D:
  7. PinJoint2D
  8. ==========
  9. **Inherits:** :ref:`Joint2D<class_Joint2D>` **<** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. Pin joint for 2D shapes.
  11. Description
  12. -----------
  13. Pin joint for 2D rigid bodies. It pins two bodies (dynamic or static) together.
  14. Properties
  15. ----------
  16. +---------------------------+-----------------------------------------------------+---------+
  17. | :ref:`float<class_float>` | :ref:`softness<class_PinJoint2D_property_softness>` | ``0.0`` |
  18. +---------------------------+-----------------------------------------------------+---------+
  19. Property Descriptions
  20. ---------------------
  21. .. _class_PinJoint2D_property_softness:
  22. - :ref:`float<class_float>` **softness**
  23. +-----------+---------------------+
  24. | *Default* | ``0.0`` |
  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.
  31. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  32. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  33. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  34. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  35. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  36. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`