mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
96 lines
5.1 KiB
ReStructuredText
96 lines
5.1 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
|
|
|
.. _class_DampedSpringJoint2D:
|
|
|
|
DampedSpringJoint2D
|
|
===================
|
|
|
|
**Inherits:** :ref:`Joint2D<class_joint2d>` **<** :ref:`Node2D<class_node2d>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Damped spring constraint for 2D physics.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_damping<class_DampedSpringJoint2D_get_damping>` **(** **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_length<class_DampedSpringJoint2D_get_length>` **(** **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_rest_length<class_DampedSpringJoint2D_get_rest_length>` **(** **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`get_stiffness<class_DampedSpringJoint2D_get_stiffness>` **(** **)** const |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_damping<class_DampedSpringJoint2D_set_damping>` **(** :ref:`float<class_float>` damping **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_length<class_DampedSpringJoint2D_set_length>` **(** :ref:`float<class_float>` length **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_rest_length<class_DampedSpringJoint2D_set_rest_length>` **(** :ref:`float<class_float>` rest_length **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_stiffness<class_DampedSpringJoint2D_set_stiffness>` **(** :ref:`float<class_float>` stiffness **)** |
|
|
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Description
|
|
-----------
|
|
|
|
Damped spring constraint for 2D physics. This resembles a spring joint that always wants to go back to a given length.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_DampedSpringJoint2D_get_damping:
|
|
|
|
- :ref:`float<class_float>` **get_damping** **(** **)** const
|
|
|
|
Return the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
|
|
|
|
.. _class_DampedSpringJoint2D_get_length:
|
|
|
|
- :ref:`float<class_float>` **get_length** **(** **)** const
|
|
|
|
Return the maximum length of the spring joint.
|
|
|
|
.. _class_DampedSpringJoint2D_get_rest_length:
|
|
|
|
- :ref:`float<class_float>` **get_rest_length** **(** **)** const
|
|
|
|
Return the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
|
|
|
|
.. _class_DampedSpringJoint2D_get_stiffness:
|
|
|
|
- :ref:`float<class_float>` **get_stiffness** **(** **)** const
|
|
|
|
Return the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
|
|
|
|
.. _class_DampedSpringJoint2D_set_damping:
|
|
|
|
- void **set_damping** **(** :ref:`float<class_float>` damping **)**
|
|
|
|
Set the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
|
|
|
|
.. _class_DampedSpringJoint2D_set_length:
|
|
|
|
- void **set_length** **(** :ref:`float<class_float>` length **)**
|
|
|
|
Set the maximum length of the spring joint.
|
|
|
|
.. _class_DampedSpringJoint2D_set_rest_length:
|
|
|
|
- void **set_rest_length** **(** :ref:`float<class_float>` rest_length **)**
|
|
|
|
Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
|
|
|
|
.. _class_DampedSpringJoint2D_set_stiffness:
|
|
|
|
- void **set_stiffness** **(** :ref:`float<class_float>` stiffness **)**
|
|
|
|
Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
|
|
|
|
|