virtualx-engine-docs/_sources/classes/class_pinjoint2d.rst.txt
2024-10-23 09:41:33 -07:00

61 lines
2 KiB
ReStructuredText

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/PinJoint2D.xml.
.. _class_PinJoint2D:
PinJoint2D
==========
**Inherits:** :ref:`Joint2D<class_Joint2D>` **<** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
Pin Joint for 2D shapes.
.. rst-class:: classref-introduction-group
Description
-----------
Pin Joint for 2D rigid bodies. It pins two bodies (rigid or static) together.
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+---------------------------+-----------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`softness<class_PinJoint2D_property_softness>` | ``0.0`` |
+---------------------------+-----------------------------------------------------+---------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_PinJoint2D_property_softness:
.. rst-class:: classref-property
:ref:`float<class_float>` **softness** = ``0.0``
.. rst-class:: classref-property-setget
- void **set_softness** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_softness** **(** **)**
The higher this value, the more the bond to the pinned partner can flex.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`