2018-07-26 11:56:21 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2019-04-01 12:33:56 +02:00
<class name= "SoftBody" inherits= "MeshInstance" category= "Core" version= "3.2" >
2018-07-26 11:56:21 +02:00
<brief_description >
2018-09-16 19:52:21 +02:00
A soft mesh physics body.
2018-07-26 11:56:21 +02:00
</brief_description>
<description >
2018-09-16 19:52:21 +02:00
A deformable physics body. Used to create elastic or deformable objects such as cloth, rubber, or other flexible materials.
2018-07-26 11:56:21 +02:00
</description>
<tutorials >
2019-10-31 16:29:41 +01:00
<link > https://docs.godotengine.org/en/latest/tutorials/physics/soft_body.html</link>
2018-07-26 11:56:21 +02:00
</tutorials>
<methods >
<method name= "add_collision_exception_with" >
<return type= "void" >
</return>
<argument index= "0" name= "body" type= "Node" >
</argument>
<description >
2018-09-16 19:52:21 +02:00
Adds a body to the list of bodies that this body can't collide with.
2018-07-26 11:56:21 +02:00
</description>
</method>
2018-10-24 21:32:55 +02:00
<method name= "get_collision_exceptions" >
<return type= "Array" >
</return>
<description >
Returns an array of nodes that were added as collision exceptions for this body.
</description>
</method>
2018-07-26 11:56:21 +02:00
<method name= "get_collision_layer_bit" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "bit" type= "int" >
</argument>
<description >
2018-09-16 19:52:21 +02:00
Returns an individual bit on the collision mask.
2018-07-26 11:56:21 +02:00
</description>
</method>
<method name= "get_collision_mask_bit" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "bit" type= "int" >
</argument>
<description >
2018-09-16 19:52:21 +02:00
Returns an individual bit on the collision mask.
2018-07-26 11:56:21 +02:00
</description>
</method>
<method name= "remove_collision_exception_with" >
<return type= "void" >
</return>
<argument index= "0" name= "body" type= "Node" >
</argument>
<description >
2018-09-16 19:52:21 +02:00
Removes a body from the list of bodies that this body can't collide with.
2018-07-26 11:56:21 +02:00
</description>
</method>
<method name= "set_collision_layer_bit" >
<return type= "void" >
</return>
<argument index= "0" name= "bit" type= "int" >
</argument>
<argument index= "1" name= "value" type= "bool" >
</argument>
<description >
2018-09-16 19:52:21 +02:00
Sets individual bits on the layer mask. Use this if you only need to change one layer's value.
2018-07-26 11:56:21 +02:00
</description>
</method>
<method name= "set_collision_mask_bit" >
<return type= "void" >
</return>
<argument index= "0" name= "bit" type= "int" >
</argument>
<argument index= "1" name= "value" type= "bool" >
</argument>
<description >
2018-09-16 19:52:21 +02:00
Sets individual bits on the collision mask. Use this if you only need to change one layer's value.
2018-07-26 11:56:21 +02:00
</description>
</method>
</methods>
<members >
2019-10-31 16:29:41 +01:00
<member name= "ray_pickable" type= "bool" setter= "set_ray_pickable" getter= "is_ray_pickable" default= "false" >
2019-11-02 12:14:15 +01:00
If [code]true[/code], the [SoftBody] will respond to [RayCast]s.
2019-10-31 16:29:41 +01:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "areaAngular_stiffness" type= "float" setter= "set_areaAngular_stiffness" getter= "get_areaAngular_stiffness" default= "0.5" >
2018-07-26 11:56:21 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "collision_layer" type= "int" setter= "set_collision_layer" getter= "get_collision_layer" default= "1" >
2019-10-31 16:29:41 +01:00
The physics layers this SoftBody is in.
2018-09-16 19:52:21 +02:00
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.
2018-07-26 11:56:21 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "collision_mask" type= "int" setter= "set_collision_mask" getter= "get_collision_mask" default= "1" >
2019-10-31 16:29:41 +01:00
The physics layers this SoftBody scans for collisions.
2018-07-26 11:56:21 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "damping_coefficient" type= "float" setter= "set_damping_coefficient" getter= "get_damping_coefficient" default= "0.01" >
2018-07-26 11:56:21 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "drag_coefficient" type= "float" setter= "set_drag_coefficient" getter= "get_drag_coefficient" default= "0.0" >
2018-07-26 11:56:21 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "linear_stiffness" type= "float" setter= "set_linear_stiffness" getter= "get_linear_stiffness" default= "0.5" >
2018-07-26 11:56:21 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "parent_collision_ignore" type= "NodePath" setter= "set_parent_collision_ignore" getter= "get_parent_collision_ignore" default= "NodePath("")" >
2019-10-31 16:29:41 +01:00
[NodePath] to a [CollisionObject] this SoftBody should avoid clipping.
2018-07-26 11:56:21 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "pose_matching_coefficient" type= "float" setter= "set_pose_matching_coefficient" getter= "get_pose_matching_coefficient" default= "0.0" >
2018-07-26 11:56:21 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "pressure_coefficient" type= "float" setter= "set_pressure_coefficient" getter= "get_pressure_coefficient" default= "0.0" >
2018-07-26 11:56:21 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "simulation_precision" type= "int" setter= "set_simulation_precision" getter= "get_simulation_precision" default= "5" >
2018-09-16 19:52:21 +02:00
Increasing this value will improve the resulting simulation, but can affect performance. Use with care.
2018-07-26 11:56:21 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "total_mass" type= "float" setter= "set_total_mass" getter= "get_total_mass" default= "1.0" >
2019-10-31 16:29:41 +01:00
The SoftBody's mass.
2018-07-26 11:56:21 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "volume_stiffness" type= "float" setter= "set_volume_stiffness" getter= "get_volume_stiffness" default= "0.5" >
2018-07-26 11:56:21 +02:00
</member>
</members>
<constants >
</constants>
</class>