|
@@ -14,7 +14,7 @@ SoftBody
|
|
|
Brief Description
|
|
|
-----------------
|
|
|
|
|
|
-
|
|
|
+A soft mesh physics body.
|
|
|
|
|
|
Properties
|
|
|
----------
|
|
@@ -66,6 +66,11 @@ Methods
|
|
|
| void | :ref:`set_ray_pickable<class_SoftBody_set_ray_pickable>` **(** :ref:`bool<class_bool>` ray_pickable **)** |
|
|
|
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
|
|
+Description
|
|
|
+-----------
|
|
|
+
|
|
|
+A deformable physics body. Used to create elastic or deformable objects such as cloth, rubber, or other flexible materials.
|
|
|
+
|
|
|
Property Descriptions
|
|
|
---------------------
|
|
|
|
|
@@ -89,6 +94,12 @@ Property Descriptions
|
|
|
| *Getter* | get_collision_layer() |
|
|
|
+----------+----------------------------+
|
|
|
|
|
|
+The physics layers this area is in.
|
|
|
+
|
|
|
+Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property.
|
|
|
+
|
|
|
+A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.
|
|
|
+
|
|
|
.. _class_SoftBody_collision_mask:
|
|
|
|
|
|
- :ref:`int<class_int>` **collision_mask**
|
|
@@ -99,6 +110,8 @@ Property Descriptions
|
|
|
| *Getter* | get_collision_mask() |
|
|
|
+----------+---------------------------+
|
|
|
|
|
|
+The physics layers this area scans for collisions.
|
|
|
+
|
|
|
.. _class_SoftBody_damping_coefficient:
|
|
|
|
|
|
- :ref:`float<class_float>` **damping_coefficient**
|
|
@@ -169,6 +182,8 @@ Property Descriptions
|
|
|
| *Getter* | get_simulation_precision() |
|
|
|
+----------+---------------------------------+
|
|
|
|
|
|
+Increasing this value will improve the resulting simulation, but can affect performance. Use with care.
|
|
|
+
|
|
|
.. _class_SoftBody_total_mass:
|
|
|
|
|
|
- :ref:`float<class_float>` **total_mass**
|
|
@@ -196,14 +211,20 @@ Method Descriptions
|
|
|
|
|
|
- void **add_collision_exception_with** **(** :ref:`Node<class_Node>` body **)**
|
|
|
|
|
|
+Adds a body to the list of bodies that this body can't collide with.
|
|
|
+
|
|
|
.. _class_SoftBody_get_collision_layer_bit:
|
|
|
|
|
|
- :ref:`bool<class_bool>` **get_collision_layer_bit** **(** :ref:`int<class_int>` bit **)** const
|
|
|
|
|
|
+Returns an individual bit on the collision mask.
|
|
|
+
|
|
|
.. _class_SoftBody_get_collision_mask_bit:
|
|
|
|
|
|
- :ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** const
|
|
|
|
|
|
+Returns an individual bit on the collision mask.
|
|
|
+
|
|
|
.. _class_SoftBody_is_ray_pickable:
|
|
|
|
|
|
- :ref:`bool<class_bool>` **is_ray_pickable** **(** **)** const
|
|
@@ -212,14 +233,20 @@ Method Descriptions
|
|
|
|
|
|
- void **remove_collision_exception_with** **(** :ref:`Node<class_Node>` body **)**
|
|
|
|
|
|
+Removes a body from the list of bodies that this body can't collide with.
|
|
|
+
|
|
|
.. _class_SoftBody_set_collision_layer_bit:
|
|
|
|
|
|
- void **set_collision_layer_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
|
|
|
|
|
|
+Sets individual bits on the layer mask. Use this if you only need to change one layer's value.
|
|
|
+
|
|
|
.. _class_SoftBody_set_collision_mask_bit:
|
|
|
|
|
|
- void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
|
|
|
|
|
|
+Sets individual bits on the collision mask. Use this if you only need to change one layer's value.
|
|
|
+
|
|
|
.. _class_SoftBody_set_ray_pickable:
|
|
|
|
|
|
- void **set_ray_pickable** **(** :ref:`bool<class_bool>` ray_pickable **)**
|