SoftBody

A soft mesh physics body.

A deformable physics body. Used to create elastic or deformable objects such as cloth, rubber, or other flexible materials.

Tutorials

Methods

void	add_collision_exception_with ( body )
Array	( )
bool	( int bit ) const
	get_collision_mask_bit ( bit ) const
void	remove_collision_exception_with ( body )
void	set_collision_layer_bit ( bit, bool value )
void	( int bit, value )

float areaAngular_stiffness

Default	`0.5`
Setter	set_areaAngular_stiffness(value)
Getter	get_areaAngular_stiffness()

Default	`1`
Setter	set_collision_layer(value)
Getter	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 in the documentation for more information.

int collision_mask

Default	`1`
Setter	set_collision_mask(value)
Getter	get_collision_mask()

damping_coefficient

float drag_coefficient

Default	`0.0`
Setter	set_drag_coefficient(value)
Getter	get_drag_coefficient()

linear_stiffness

Default
Setter	set_linear_stiffness(value)
Getter	get_linear_stiffness()

NodePath parent_collision_ignore

Default	`NodePath(“”)`
Setter	set_parent_collision_ignore(value)
Getter	get_parent_collision_ignore()

to a CollisionObject this SoftBody should avoid clipping.

pose_matching_coefficient

Default	`0.0`
Setter	set_pose_matching_coefficient(value)
Getter	get_pose_matching_coefficient()

float pressure_coefficient

ray_pickable

Default	`true`
Setter	set_ray_pickable(value)
Getter	is_ray_pickable()

If true, the SoftBody will respond to RayCasts.

Default	`5`
Setter	set_simulation_precision(value)
Getter	get_simulation_precision()

Increasing this value will improve the resulting simulation, but can affect performance. Use with care.

total_mass

Default	`1.0`
Setter	set_total_mass(value)
Getter	get_total_mass()

The SoftBody’s mass.

float volume_stiffness

Default
Setter	set_volume_stiffness(value)
Getter	get_volume_stiffness()

Method Descriptions

void add_collision_exception_with ( body )

Adds a body to the list of bodies that this body can’t collide with.

Array get_collision_exceptions ( )

get_collision_layer_bit ( int bit ) const

Returns an individual bit on the collision mask.

get_collision_mask_bit ( int bit ) const

Returns an individual bit on the collision mask.

void remove_collision_exception_with ( body )

Removes a body from the list of bodies that this body can’t collide with.

void set_collision_layer_bit ( int bit, value )

Sets individual bits on the layer mask. Use this if you only need to change one layer’s value.

Sets individual bits on the collision mask. Use this if you only need to change one layer’s value.