:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/stag-toolkit/sphinx/gen/gdextension/SimulatedRopeBinding.xml.

.. _class_SimulatedRopeBinding:

SimulatedRopeBinding
====================

**Inherits:** ``Node3D``

.. container:: contribute

	There is currently no description for this class. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +-------------------------------------------+---------------------------------------------------------------------------------------------------+------------+
   | ``float``                                 | :ref:`bind_at<class_SimulatedRopeBinding_property_bind_at>`                                       | ``0.0``    |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------+------------+
   | :ref:`SimulatedRope<class_SimulatedRope>` | :ref:`bind_to<class_SimulatedRopeBinding_property_bind_to>`                                       | ``null``   |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------+------------+
   | ``bool``                                  | :ref:`snap_enabled<class_SimulatedRopeBinding_property_snap_enabled>`                             | ``false``  |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------+------------+
   | ``float``                                 | :ref:`snap_tension_threshold<class_SimulatedRopeBinding_property_snap_tension_threshold>`         | ``5000.0`` |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------+------------+
   | ``float``                                 | :ref:`spring_constant_multiplier<class_SimulatedRopeBinding_property_spring_constant_multiplier>` | ``1.0``    |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------+------------+
   | ``int``                                   | :ref:`update_tick<class_SimulatedRopeBinding_property_update_tick>`                               | ``2``      |
   +-------------------------------------------+---------------------------------------------------------------------------------------------------+------------+

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
   :widths: auto

   +-----------------+--------------------------------------------------------------------------------------------------------+
   | ``int``         | :ref:`get_bind_id<class_SimulatedRopeBinding_method_get_bind_id>`\ (\ ) |const|                        |
   +-----------------+--------------------------------------------------------------------------------------------------------+
   | ``RigidBody3D`` | :ref:`get_rigid_body<class_SimulatedRopeBinding_method_get_rigid_body>`\ (\ ) |const|                  |
   +-----------------+--------------------------------------------------------------------------------------------------------+
   | ``Vector3``     | :ref:`get_tension_force<class_SimulatedRopeBinding_method_get_tension_force>`\ (\ ) |const|            |
   +-----------------+--------------------------------------------------------------------------------------------------------+
   | |void|          | :ref:`slide_bind_at<class_SimulatedRopeBinding_method_slide_bind_at>`\ (\ factor_amount\: ``float``\ ) |
   +-----------------+--------------------------------------------------------------------------------------------------------+
   | |void|          | :ref:`update_bind<class_SimulatedRopeBinding_method_update_bind>`\ (\ )                                |
   +-----------------+--------------------------------------------------------------------------------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Signals
-------

.. _class_SimulatedRopeBinding_signal_rope_bound:

.. rst-class:: classref-signal

**rope_bound**\ (\ rope\: :ref:`SimulatedRope<class_SimulatedRope>`\ ) :ref:`🔗<class_SimulatedRopeBinding_signal_rope_bound>`

.. container:: contribute

	There is currently no description for this signal. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_SimulatedRopeBinding_signal_rope_snapped:

.. rst-class:: classref-signal

**rope_snapped**\ (\ tension_force\: ``Vector3``\ ) :ref:`🔗<class_SimulatedRopeBinding_signal_rope_snapped>`

.. container:: contribute

	There is currently no description for this signal. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_SimulatedRopeBinding_signal_rope_unbound:

.. rst-class:: classref-signal

**rope_unbound**\ (\ rope\: :ref:`SimulatedRope<class_SimulatedRope>`\ ) :ref:`🔗<class_SimulatedRopeBinding_signal_rope_unbound>`

.. container:: contribute

	There is currently no description for this signal. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_SimulatedRopeBinding_property_bind_at:

.. rst-class:: classref-property

``float`` **bind_at** = ``0.0`` :ref:`🔗<class_SimulatedRopeBinding_property_bind_at>`

.. rst-class:: classref-property-setget

- |void| **set_bind_at**\ (\ value\: ``float``\ )
- ``float`` **get_bind_at**\ (\ )

.. container:: contribute

	There is currently no description for this property. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_SimulatedRopeBinding_property_bind_to:

.. rst-class:: classref-property

:ref:`SimulatedRope<class_SimulatedRope>` **bind_to** = ``null`` :ref:`🔗<class_SimulatedRopeBinding_property_bind_to>`

.. rst-class:: classref-property-setget

- |void| **set_bind_to**\ (\ value\: :ref:`SimulatedRope<class_SimulatedRope>`\ )
- :ref:`SimulatedRope<class_SimulatedRope>` **get_bind_to**\ (\ )

.. container:: contribute

	There is currently no description for this property. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_SimulatedRopeBinding_property_snap_enabled:

.. rst-class:: classref-property

``bool`` **snap_enabled** = ``false`` :ref:`🔗<class_SimulatedRopeBinding_property_snap_enabled>`

.. rst-class:: classref-property-setget

- |void| **set_snap_enabled**\ (\ value\: ``bool``\ )
- ``bool`` **get_snap_enabled**\ (\ )

.. container:: contribute

	There is currently no description for this property. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_SimulatedRopeBinding_property_snap_tension_threshold:

.. rst-class:: classref-property

``float`` **snap_tension_threshold** = ``5000.0`` :ref:`🔗<class_SimulatedRopeBinding_property_snap_tension_threshold>`

.. rst-class:: classref-property-setget

- |void| **set_snap_tension_threshold**\ (\ value\: ``float``\ )
- ``float`` **get_snap_tension_threshold**\ (\ )

.. container:: contribute

	There is currently no description for this property. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_SimulatedRopeBinding_property_spring_constant_multiplier:

.. rst-class:: classref-property

``float`` **spring_constant_multiplier** = ``1.0`` :ref:`🔗<class_SimulatedRopeBinding_property_spring_constant_multiplier>`

.. rst-class:: classref-property-setget

- |void| **set_spring_constant_multiplier**\ (\ value\: ``float``\ )
- ``float`` **get_spring_constant_multiplier**\ (\ )

.. container:: contribute

	There is currently no description for this property. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_SimulatedRopeBinding_property_update_tick:

.. rst-class:: classref-property

``int`` **update_tick** = ``2`` :ref:`🔗<class_SimulatedRopeBinding_property_update_tick>`

.. rst-class:: classref-property-setget

- |void| **set_update_tick**\ (\ value\: ``int``\ )
- ``int`` **get_update_tick**\ (\ )

.. container:: contribute

	There is currently no description for this property. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Method Descriptions
-------------------

.. _class_SimulatedRopeBinding_method_get_bind_id:

.. rst-class:: classref-method

``int`` **get_bind_id**\ (\ ) |const| :ref:`🔗<class_SimulatedRopeBinding_method_get_bind_id>`

.. container:: contribute

	There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_SimulatedRopeBinding_method_get_rigid_body:

.. rst-class:: classref-method

``RigidBody3D`` **get_rigid_body**\ (\ ) |const| :ref:`🔗<class_SimulatedRopeBinding_method_get_rigid_body>`

.. container:: contribute

	There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_SimulatedRopeBinding_method_get_tension_force:

.. rst-class:: classref-method

``Vector3`` **get_tension_force**\ (\ ) |const| :ref:`🔗<class_SimulatedRopeBinding_method_get_tension_force>`

.. container:: contribute

	There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_SimulatedRopeBinding_method_slide_bind_at:

.. rst-class:: classref-method

|void| **slide_bind_at**\ (\ factor_amount\: ``float``\ ) :ref:`🔗<class_SimulatedRopeBinding_method_slide_bind_at>`

.. container:: contribute

	There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. rst-class:: classref-item-separator

----

.. _class_SimulatedRopeBinding_method_update_bind:

.. rst-class:: classref-method

|void| **update_bind**\ (\ ) :ref:`🔗<class_SimulatedRopeBinding_method_update_bind>`

.. container:: contribute

	There is currently no description for this method. Please help us by `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |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.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`