pandemonium_engine_docs/classes/class_pinjoint2d.rst

49 lines
1.7 KiB
ReStructuredText

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.5/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.
Description
-----------
Pin Joint for 2D rigid bodies. It pins two bodies (rigid or static) together.
Properties
----------
+---------------------------+-----------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`softness<class_PinJoint2D_property_softness>` | ``0.0`` |
+---------------------------+-----------------------------------------------------+---------+
Property Descriptions
---------------------
.. _class_PinJoint2D_property_softness:
- :ref:`float<class_float>` **softness**
+-----------+---------------------+
| *Default* | ``0.0`` |
+-----------+---------------------+
| *Setter* | set_softness(value) |
+-----------+---------------------+
| *Getter* | 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.)`