:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/SoftBody.xml. .. _class_SoftBody: SoftBody ======== **Inherits:** :ref:`MeshInstance` **<** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`CullInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` A soft mesh physics body. .. rst-class:: classref-introduction-group Description ----------- A deformable physics body. Used to create elastic or deformable objects such as cloth, rubber, or other flexible materials. \ **Note:** There are many known bugs in **SoftBody**. Therefore, it's not recommended to use them for things that can affect gameplay (such as a player character made entirely out of soft bodies). .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`../tutorials/physics/soft_body` .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------------+-------------------------------------------------------------------------------------+------------------+ | :ref:`float` | :ref:`areaAngular_stiffness` | ``0.5`` | +---------------------------------+-------------------------------------------------------------------------------------+------------------+ | :ref:`int` | :ref:`collision_layer` | ``1`` | +---------------------------------+-------------------------------------------------------------------------------------+------------------+ | :ref:`int` | :ref:`collision_mask` | ``1`` | +---------------------------------+-------------------------------------------------------------------------------------+------------------+ | :ref:`float` | :ref:`damping_coefficient` | ``0.01`` | +---------------------------------+-------------------------------------------------------------------------------------+------------------+ | :ref:`float` | :ref:`drag_coefficient` | ``0.0`` | +---------------------------------+-------------------------------------------------------------------------------------+------------------+ | :ref:`float` | :ref:`linear_stiffness` | ``0.5`` | +---------------------------------+-------------------------------------------------------------------------------------+------------------+ | :ref:`NodePath` | :ref:`parent_collision_ignore` | ``NodePath("")`` | +---------------------------------+-------------------------------------------------------------------------------------+------------------+ | :ref:`bool` | :ref:`physics_enabled` | ``true`` | +---------------------------------+-------------------------------------------------------------------------------------+------------------+ | :ref:`float` | :ref:`pose_matching_coefficient` | ``0.0`` | +---------------------------------+-------------------------------------------------------------------------------------+------------------+ | :ref:`float` | :ref:`pressure_coefficient` | ``0.0`` | +---------------------------------+-------------------------------------------------------------------------------------+------------------+ | :ref:`bool` | :ref:`ray_pickable` | ``true`` | +---------------------------------+-------------------------------------------------------------------------------------+------------------+ | :ref:`int` | :ref:`simulation_precision` | ``5`` | +---------------------------------+-------------------------------------------------------------------------------------+------------------+ | :ref:`float` | :ref:`total_mass` | ``1.0`` | +---------------------------------+-------------------------------------------------------------------------------------+------------------+ | :ref:`float` | :ref:`volume_stiffness` | ``0.5`` | +---------------------------------+-------------------------------------------------------------------------------------+------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_collision_exception_with` **(** :ref:`Node` body **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_collision_exceptions` **(** **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_point_transform` **(** :ref:`int` point_index **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_point_pinned` **(** :ref:`int` point_index **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_collision_exception_with` **(** :ref:`Node` body **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_point_pinned` **(** :ref:`int` point_index, :ref:`bool` pinned, :ref:`NodePath` attachment_path=NodePath("") **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_SoftBody_property_areaAngular_stiffness: .. rst-class:: classref-property :ref:`float` **areaAngular_stiffness** = ``0.5`` .. rst-class:: classref-property-setget - void **set_areaAngular_stiffness** **(** :ref:`float` value **)** - :ref:`float` **get_areaAngular_stiffness** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SoftBody_property_collision_layer: .. rst-class:: classref-property :ref:`int` **collision_layer** = ``1`` .. rst-class:: classref-property-setget - void **set_collision_layer** **(** :ref:`int` value **)** - :ref:`int` **get_collision_layer** **(** **)** The physics layers this SoftBody 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. See `Collision layers and masks <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information. .. rst-class:: classref-item-separator ---- .. _class_SoftBody_property_collision_mask: .. rst-class:: classref-property :ref:`int` **collision_mask** = ``1`` .. rst-class:: classref-property-setget - void **set_collision_mask** **(** :ref:`int` value **)** - :ref:`int` **get_collision_mask** **(** **)** The physics layers this SoftBody scans for collisions. See `Collision layers and masks <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information. .. rst-class:: classref-item-separator ---- .. _class_SoftBody_property_damping_coefficient: .. rst-class:: classref-property :ref:`float` **damping_coefficient** = ``0.01`` .. rst-class:: classref-property-setget - void **set_damping_coefficient** **(** :ref:`float` value **)** - :ref:`float` **get_damping_coefficient** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SoftBody_property_drag_coefficient: .. rst-class:: classref-property :ref:`float` **drag_coefficient** = ``0.0`` .. rst-class:: classref-property-setget - void **set_drag_coefficient** **(** :ref:`float` value **)** - :ref:`float` **get_drag_coefficient** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SoftBody_property_linear_stiffness: .. rst-class:: classref-property :ref:`float` **linear_stiffness** = ``0.5`` .. rst-class:: classref-property-setget - void **set_linear_stiffness** **(** :ref:`float` value **)** - :ref:`float` **get_linear_stiffness** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SoftBody_property_parent_collision_ignore: .. rst-class:: classref-property :ref:`NodePath` **parent_collision_ignore** = ``NodePath("")`` .. rst-class:: classref-property-setget - void **set_parent_collision_ignore** **(** :ref:`NodePath` value **)** - :ref:`NodePath` **get_parent_collision_ignore** **(** **)** :ref:`NodePath` to a :ref:`CollisionObject` this SoftBody should avoid clipping. .. rst-class:: classref-item-separator ---- .. _class_SoftBody_property_physics_enabled: .. rst-class:: classref-property :ref:`bool` **physics_enabled** = ``true`` .. rst-class:: classref-property-setget - void **set_physics_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_physics_enabled** **(** **)** If ``true``, the **SoftBody** is simulated in physics. Can be set to ``false`` to pause the physics simulation. .. rst-class:: classref-item-separator ---- .. _class_SoftBody_property_pose_matching_coefficient: .. rst-class:: classref-property :ref:`float` **pose_matching_coefficient** = ``0.0`` .. rst-class:: classref-property-setget - void **set_pose_matching_coefficient** **(** :ref:`float` value **)** - :ref:`float` **get_pose_matching_coefficient** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SoftBody_property_pressure_coefficient: .. rst-class:: classref-property :ref:`float` **pressure_coefficient** = ``0.0`` .. rst-class:: classref-property-setget - void **set_pressure_coefficient** **(** :ref:`float` value **)** - :ref:`float` **get_pressure_coefficient** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SoftBody_property_ray_pickable: .. rst-class:: classref-property :ref:`bool` **ray_pickable** = ``true`` .. rst-class:: classref-property-setget - void **set_ray_pickable** **(** :ref:`bool` value **)** - :ref:`bool` **is_ray_pickable** **(** **)** If ``true``, the **SoftBody** will respond to :ref:`RayCast`\ s. .. rst-class:: classref-item-separator ---- .. _class_SoftBody_property_simulation_precision: .. rst-class:: classref-property :ref:`int` **simulation_precision** = ``5`` .. rst-class:: classref-property-setget - void **set_simulation_precision** **(** :ref:`int` value **)** - :ref:`int` **get_simulation_precision** **(** **)** Increasing this value will improve the resulting simulation, but can affect performance. Use with care. .. rst-class:: classref-item-separator ---- .. _class_SoftBody_property_total_mass: .. rst-class:: classref-property :ref:`float` **total_mass** = ``1.0`` .. rst-class:: classref-property-setget - void **set_total_mass** **(** :ref:`float` value **)** - :ref:`float` **get_total_mass** **(** **)** The SoftBody's mass. .. rst-class:: classref-item-separator ---- .. _class_SoftBody_property_volume_stiffness: .. rst-class:: classref-property :ref:`float` **volume_stiffness** = ``0.5`` .. rst-class:: classref-property-setget - void **set_volume_stiffness** **(** :ref:`float` value **)** - :ref:`float` **get_volume_stiffness** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_SoftBody_method_add_collision_exception_with: .. rst-class:: classref-method void **add_collision_exception_with** **(** :ref:`Node` body **)** Adds a body to the list of bodies that this body can't collide with. .. rst-class:: classref-item-separator ---- .. _class_SoftBody_method_get_collision_exceptions: .. rst-class:: classref-method :ref:`Array` **get_collision_exceptions** **(** **)** Returns an array of nodes that were added as collision exceptions for this body. .. rst-class:: classref-item-separator ---- .. _class_SoftBody_method_get_collision_layer_bit: .. rst-class:: classref-method :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** |const| Returns an individual bit on the collision mask. .. rst-class:: classref-item-separator ---- .. _class_SoftBody_method_get_collision_mask_bit: .. rst-class:: classref-method :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** |const| Returns an individual bit on the collision mask. .. rst-class:: classref-item-separator ---- .. _class_SoftBody_method_get_point_transform: .. rst-class:: classref-method :ref:`Vector3` **get_point_transform** **(** :ref:`int` point_index **)** Returns local translation of a vertex in the surface array. .. rst-class:: classref-item-separator ---- .. _class_SoftBody_method_is_point_pinned: .. rst-class:: classref-method :ref:`bool` **is_point_pinned** **(** :ref:`int` point_index **)** |const| Returns ``true`` if vertex is set to pinned. .. rst-class:: classref-item-separator ---- .. _class_SoftBody_method_remove_collision_exception_with: .. rst-class:: classref-method void **remove_collision_exception_with** **(** :ref:`Node` body **)** Removes a body from the list of bodies that this body can't collide with. .. rst-class:: classref-item-separator ---- .. _class_SoftBody_method_set_collision_layer_bit: .. rst-class:: classref-method void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets individual bits on the layer mask. Use this if you only need to change one layer's value. .. rst-class:: classref-item-separator ---- .. _class_SoftBody_method_set_collision_mask_bit: .. rst-class:: classref-method void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** Sets individual bits on the collision mask. Use this if you only need to change one layer's value. .. rst-class:: classref-item-separator ---- .. _class_SoftBody_method_set_point_pinned: .. rst-class:: classref-method void **set_point_pinned** **(** :ref:`int` point_index, :ref:`bool` pinned, :ref:`NodePath` attachment_path=NodePath("") **)** Sets the pinned state of a surface vertex. When set to ``true``, the optional ``attachment_path`` can define a :ref:`Spatial` the pinned vertex will be attached to. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |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.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`