godot-docs/classes/class_springarm.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the SpringArm.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_SpringArm:

SpringArm
=========

**Inherits:** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------



Properties
----------

+---------------------------+----------------------------------------------------------------+------+
| :ref:`int<class_int>`     | :ref:`collision_mask<class_SpringArm_property_collision_mask>` | 1    |
+---------------------------+----------------------------------------------------------------+------+
| :ref:`float<class_float>` | :ref:`margin<class_SpringArm_property_margin>`                 | 0.01 |
+---------------------------+----------------------------------------------------------------+------+
| :ref:`Shape<class_Shape>` | :ref:`shape<class_SpringArm_property_shape>`                   |      |
+---------------------------+----------------------------------------------------------------+------+
| :ref:`float<class_float>` | :ref:`spring_length<class_SpringArm_property_spring_length>`   | 1.0  |
+---------------------------+----------------------------------------------------------------+------+

Methods
-------

+---------------------------+--------------------------------------------------------------------------------------------------------------------+
| void                      | :ref:`add_excluded_object<class_SpringArm_method_add_excluded_object>` **(** :ref:`RID<class_RID>` RID **)**       |
+---------------------------+--------------------------------------------------------------------------------------------------------------------+
| void                      | :ref:`clear_excluded_objects<class_SpringArm_method_clear_excluded_objects>` **(** **)**                           |
+---------------------------+--------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_hit_length<class_SpringArm_method_get_hit_length>` **(** **)**                                           |
+---------------------------+--------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`   | :ref:`remove_excluded_object<class_SpringArm_method_remove_excluded_object>` **(** :ref:`RID<class_RID>` RID **)** |
+---------------------------+--------------------------------------------------------------------------------------------------------------------+

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

.. _class_SpringArm_property_collision_mask:

- :ref:`int<class_int>` **collision_mask**

+-----------+---------------------------+
| *Default* | 1                         |
+-----------+---------------------------+
| *Setter*  | set_collision_mask(value) |
+-----------+---------------------------+
| *Getter*  | get_collision_mask()      |
+-----------+---------------------------+

.. _class_SpringArm_property_margin:

- :ref:`float<class_float>` **margin**

+-----------+-------------------+
| *Default* | 0.01              |
+-----------+-------------------+
| *Setter*  | set_margin(value) |
+-----------+-------------------+
| *Getter*  | get_margin()      |
+-----------+-------------------+

.. _class_SpringArm_property_shape:

- :ref:`Shape<class_Shape>` **shape**

+----------+------------------+
| *Setter* | set_shape(value) |
+----------+------------------+
| *Getter* | get_shape()      |
+----------+------------------+

.. _class_SpringArm_property_spring_length:

- :ref:`float<class_float>` **spring_length**

+-----------+-------------------+
| *Default* | 1.0               |
+-----------+-------------------+
| *Setter*  | set_length(value) |
+-----------+-------------------+
| *Getter*  | get_length()      |
+-----------+-------------------+

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

.. _class_SpringArm_method_add_excluded_object:

- void **add_excluded_object** **(** :ref:`RID<class_RID>` RID **)**

.. _class_SpringArm_method_clear_excluded_objects:

- void **clear_excluded_objects** **(** **)**

.. _class_SpringArm_method_get_hit_length:

- :ref:`float<class_float>` **get_hit_length** **(** **)**

.. _class_SpringArm_method_remove_excluded_object:

- :ref:`bool<class_bool>` **remove_excluded_object** **(** :ref:`RID<class_RID>` RID **)**