RigidBodyObject(bpy_struct)

base class — bpy_struct

class bpy.types.RigidBodyObject(bpy_struct)

Settings for object participating in Rigid Body Simulation

angular_damping

Amount of angular velocity that is lost over time (in [0, 1], default 0.1)

Type:

float

collision_collections

Collision collections rigid body belongs to (array of 20 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False))

Type:

bpy_prop_array[bool]

collision_margin

Threshold of distance near surface where collisions are still considered (best results when non-zero) (in [0, 1], default 0.04)

Type:

float

collision_shape

Collision Shape of object in Rigid Body Simulations (default 'BOX')

Type:

Literal[Rigidbody Object Shape Items]

deactivate_angular_velocity

Angular Velocity below which simulation stops simulating object (in [0, inf], default 0.5)

Type:

float

deactivate_linear_velocity

Linear Velocity below which simulation stops simulating object (in [0, inf], default 0.4)

Type:

float

enabled

Rigid Body actively participates to the simulation (default True)

Type:

bool

friction

Resistance of object to movement (in [0, inf], default 0.5)

Type:

float

kinematic

Allow rigid body to be controlled by the animation system (default False)

Type:

bool

linear_damping

Amount of linear velocity that is lost over time (in [0, 1], default 0.04)

Type:

float

mass

How much the object ‘weighs’ irrespective of gravity (in [0.001, inf], default 1.0)

Type:

float

mesh_source

Source of the mesh used to create collision shape (default 'BASE')

  • BASE Base – Base mesh.

  • DEFORM Deform – Deformations (shape keys, deform modifiers).

  • FINAL Final – All modifiers.

Type:

Literal[‘BASE’, ‘DEFORM’, ‘FINAL’]

restitution

Tendency of object to bounce after colliding with another (0 = stays still, 1 = perfectly elastic) (in [0, inf], default 0.0)

Type:

float

type

Role of object in Rigid Body Simulations (default 'ACTIVE')

Type:

Literal[Rigidbody Object Type Items]

use_deactivation

Enable deactivation of resting rigid bodies (increases performance and stability but can cause glitches) (default True)

Type:

bool

use_deform

Rigid body deforms during simulation (default False)

Type:

bool

use_margin

Use custom collision margin (some shapes will have a visible gap around them) (default False)

Type:

bool

use_start_deactivated

Deactivate rigid body at the start of the simulation (default False)

Type:

bool

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References