: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/SimulatedRope.xml.

.. _class_SimulatedRope:

SimulatedRope
=============

**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:`ideal_length<class_SimulatedRope_property_ideal_length>` | ``25.0`` |
   +-----------------------------------------------------------+----------------------------------------------------------------+----------+
   | :ref:`SimulatedRopeSettings<class_SimulatedRopeSettings>` | :ref:`settings<class_SimulatedRope_property_settings>`         | ``null`` |
   +-----------------------------------------------------------+----------------------------------------------------------------+----------+
   | ``ShaderMaterial``                                        | :ref:`shader<class_SimulatedRope_property_shader>`             |          |
   +-----------------------------------------------------------+----------------------------------------------------------------+----------+

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

Methods
-------

.. table::
   :widths: auto

   +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                    | :ref:`bind_clear<class_SimulatedRope_method_bind_clear>`\ (\ )                                                                                   |
   +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                    | :ref:`bind_erase<class_SimulatedRope_method_bind_erase>`\ (\ bind_id\: ``int``\ )                                                                |
   +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                    | :ref:`bind_set<class_SimulatedRope_method_bind_set>`\ (\ bind_id\: ``int``, position\: ``Vector3``, rope_factor\: ``float``\ )                   |
   +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
   | ``MeshInstance3D``                                        | :ref:`fetch_mesh_instance<class_SimulatedRope_method_fetch_mesh_instance>`\ (\ )                                                                 |
   +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`SimulatedRopeSettings<class_SimulatedRopeSettings>` | :ref:`fetch_settings<class_SimulatedRope_method_fetch_settings>`\ (\ )                                                                           |
   +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
   | ``AABB``                                                  | :ref:`get_aabb<class_SimulatedRope_method_get_aabb>`\ (\ ) |const|                                                                               |
   +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
   | ``float``                                                 | :ref:`get_rope_distance<class_SimulatedRope_method_get_rope_distance>`\ (\ position\: ``Vector3``\ ) |const|                                     |
   +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
   | ``float``                                                 | :ref:`get_rope_factor<class_SimulatedRope_method_get_rope_factor>`\ (\ position\: ``Vector3``\ ) |const|                                         |
   +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
   | ``Vector3``                                               | :ref:`get_rope_position<class_SimulatedRope_method_get_rope_position>`\ (\ factor\: ``float``\ ) |const|                                         |
   +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
   | ``float``                                                 | :ref:`get_rope_slack<class_SimulatedRope_method_get_rope_slack>`\ (\ factor\: ``float``\ ) |const|                                               |
   +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
   | ``Vector3``                                               | :ref:`get_rope_slide_direction<class_SimulatedRope_method_get_rope_slide_direction>`\ (\ factor\: ``float``, factor_width\: ``float``\ ) |const| |
   +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
   | ``Vector3``                                               | :ref:`get_tension_force_at<class_SimulatedRope_method_get_tension_force_at>`\ (\ factor\: ``float``\ ) |const|                                   |
   +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                    | :ref:`initialize_collision<class_SimulatedRope_method_initialize_collision>`\ (\ )                                                               |
   +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                    | :ref:`initialize_render<class_SimulatedRope_method_initialize_render>`\ (\ )                                                                     |
   +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                    | :ref:`initialize_simulation<class_SimulatedRope_method_initialize_simulation>`\ (\ )                                                             |
   +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                    | :ref:`tick_collision<class_SimulatedRope_method_tick_collision>`\ (\ )                                                                           |
   +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                    | :ref:`tick_render<class_SimulatedRope_method_tick_render>`\ (\ )                                                                                 |
   +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                    | :ref:`tick_render_aabb<class_SimulatedRope_method_tick_render_aabb>`\ (\ )                                                                       |
   +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                    | :ref:`tick_simulation<class_SimulatedRope_method_tick_simulation>`\ (\ delta\: ``float``\ )                                                      |
   +-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+

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

----

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

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

.. _class_SimulatedRope_property_ideal_length:

.. rst-class:: classref-property

``float`` **ideal_length** = ``25.0`` :ref:`🔗<class_SimulatedRope_property_ideal_length>`

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

- |void| **set_ideal_length**\ (\ value\: ``float``\ )
- ``float`` **get_ideal_length**\ (\ )

.. 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_SimulatedRope_property_settings:

.. rst-class:: classref-property

:ref:`SimulatedRopeSettings<class_SimulatedRopeSettings>` **settings** = ``null`` :ref:`🔗<class_SimulatedRope_property_settings>`

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

- |void| **set_settings**\ (\ value\: :ref:`SimulatedRopeSettings<class_SimulatedRopeSettings>`\ )
- :ref:`SimulatedRopeSettings<class_SimulatedRopeSettings>` **get_settings**\ (\ )

.. 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_SimulatedRope_property_shader:

.. rst-class:: classref-property

``ShaderMaterial`` **shader** :ref:`🔗<class_SimulatedRope_property_shader>`

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

- |void| **set_shader**\ (\ value\: ``ShaderMaterial``\ )
- ``ShaderMaterial`` **get_shader**\ (\ )

.. 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_SimulatedRope_method_bind_clear:

.. rst-class:: classref-method

|void| **bind_clear**\ (\ ) :ref:`🔗<class_SimulatedRope_method_bind_clear>`

.. 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_SimulatedRope_method_bind_erase:

.. rst-class:: classref-method

|void| **bind_erase**\ (\ bind_id\: ``int``\ ) :ref:`🔗<class_SimulatedRope_method_bind_erase>`

.. 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_SimulatedRope_method_bind_set:

.. rst-class:: classref-method

|void| **bind_set**\ (\ bind_id\: ``int``, position\: ``Vector3``, rope_factor\: ``float``\ ) :ref:`🔗<class_SimulatedRope_method_bind_set>`

.. 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_SimulatedRope_method_fetch_mesh_instance:

.. rst-class:: classref-method

``MeshInstance3D`` **fetch_mesh_instance**\ (\ ) :ref:`🔗<class_SimulatedRope_method_fetch_mesh_instance>`

.. 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_SimulatedRope_method_fetch_settings:

.. rst-class:: classref-method

:ref:`SimulatedRopeSettings<class_SimulatedRopeSettings>` **fetch_settings**\ (\ ) :ref:`🔗<class_SimulatedRope_method_fetch_settings>`

.. 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_SimulatedRope_method_get_aabb:

.. rst-class:: classref-method

``AABB`` **get_aabb**\ (\ ) |const| :ref:`🔗<class_SimulatedRope_method_get_aabb>`

.. 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_SimulatedRope_method_get_rope_distance:

.. rst-class:: classref-method

``float`` **get_rope_distance**\ (\ position\: ``Vector3``\ ) |const| :ref:`🔗<class_SimulatedRope_method_get_rope_distance>`

.. 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_SimulatedRope_method_get_rope_factor:

.. rst-class:: classref-method

``float`` **get_rope_factor**\ (\ position\: ``Vector3``\ ) |const| :ref:`🔗<class_SimulatedRope_method_get_rope_factor>`

.. 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_SimulatedRope_method_get_rope_position:

.. rst-class:: classref-method

``Vector3`` **get_rope_position**\ (\ factor\: ``float``\ ) |const| :ref:`🔗<class_SimulatedRope_method_get_rope_position>`

.. 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_SimulatedRope_method_get_rope_slack:

.. rst-class:: classref-method

``float`` **get_rope_slack**\ (\ factor\: ``float``\ ) |const| :ref:`🔗<class_SimulatedRope_method_get_rope_slack>`

.. 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_SimulatedRope_method_get_rope_slide_direction:

.. rst-class:: classref-method

``Vector3`` **get_rope_slide_direction**\ (\ factor\: ``float``, factor_width\: ``float``\ ) |const| :ref:`🔗<class_SimulatedRope_method_get_rope_slide_direction>`

.. 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_SimulatedRope_method_get_tension_force_at:

.. rst-class:: classref-method

``Vector3`` **get_tension_force_at**\ (\ factor\: ``float``\ ) |const| :ref:`🔗<class_SimulatedRope_method_get_tension_force_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_SimulatedRope_method_initialize_collision:

.. rst-class:: classref-method

|void| **initialize_collision**\ (\ ) :ref:`🔗<class_SimulatedRope_method_initialize_collision>`

.. 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_SimulatedRope_method_initialize_render:

.. rst-class:: classref-method

|void| **initialize_render**\ (\ ) :ref:`🔗<class_SimulatedRope_method_initialize_render>`

.. 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_SimulatedRope_method_initialize_simulation:

.. rst-class:: classref-method

|void| **initialize_simulation**\ (\ ) :ref:`🔗<class_SimulatedRope_method_initialize_simulation>`

.. 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_SimulatedRope_method_tick_collision:

.. rst-class:: classref-method

|void| **tick_collision**\ (\ ) :ref:`🔗<class_SimulatedRope_method_tick_collision>`

.. 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_SimulatedRope_method_tick_render:

.. rst-class:: classref-method

|void| **tick_render**\ (\ ) :ref:`🔗<class_SimulatedRope_method_tick_render>`

.. 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_SimulatedRope_method_tick_render_aabb:

.. rst-class:: classref-method

|void| **tick_render_aabb**\ (\ ) :ref:`🔗<class_SimulatedRope_method_tick_render_aabb>`

.. 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_SimulatedRope_method_tick_simulation:

.. rst-class:: classref-method

|void| **tick_simulation**\ (\ delta\: ``float``\ ) :ref:`🔗<class_SimulatedRope_method_tick_simulation>`

.. 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.)`