physics.RigidBody

physics.RigidBody(world: physics.World)

Create a new rigid body in the specified world.

The body is created at the origin with no colliders. Add colliders with add_collider before the body can interact with other objects.

Args

• world (World) — The physics world to create the body in.

angular_damping: float

The angular damping of the body.

angular_velocity: float

The angular velocity of the body.

collision_layer: int

The body's collision layer (category bits).

collision_mask: int

The body's collision mask.

fixed_rotation: bool

Whether the body has fixed rotation.

is_awake: bool

Whether the body is currently awake and simulating.

is_bullet: bool

Whether CCD is enabled for this body.

is_valid: bool

Indicates whether the body is not destroyed.

linear_damping: float

The linear damping of the body.

linear_velocity: Vec2

The linear velocity of the body.

mass: float

The mass of the body.

pos: Vec2

The position of the body in world coordinates.

rotation: float

The rotation of the body in radians.

add_collider(self, circle: Circle, density: float = 1.0, friction: float = 0.20000000298023224, restitution: float = 0.0, enable_events: bool = False, is_sensor: bool = False) -> None

add_collider(self, polygon: Polygon, density: float = 1.0, friction: float = 0.20000000298023224, restitution: float = 0.0, enable_events: bool = False, is_sensor: bool = False) -> None

add_collider(self, rect: Rect, density: float = 1.0, friction: float = 0.20000000298023224, restitution: float = 0.0, enable_events: bool = False, is_sensor: bool = False) -> None

add_collider(self, capsule: Capsule, density: float = 1.0, friction: float = 0.20000000298023224, restitution: float = 0.0, enable_events: bool = False, is_sensor: bool = False) -> None

Overloaded function.

1. add_collider(self, circle: Circle, density: float = 1.0, friction: float = 0.20000000298023224, restitution: float = 0.0, enable_events: bool = False, is_sensor: bool = False) -> None

Add a circular collider to the body.

Args

• circle (Circle) — The circular shape to add as a collider.
• density (float, optional) — The density of the collider. Defaults to 1.0.
• friction (float, optional) — The friction coefficient of the collider. Defaults to 0.2.
• restitution (float, optional) — The restitution (bounciness) of the collider. Defaults to 0.0.
• enable_events (bool, optional) — Whether to enable hit, contact, and sensor events for this collider. Defaults to False.
• is_sensor (bool, optional) — Whether the collider is a sensor. Defaults to False.

2. add_collider(self, polygon: Polygon, density: float = 1.0, friction: float = 0.20000000298023224, restitution: float = 0.0, enable_events: bool = False, is_sensor: bool = False) -> None

Add a polygonal collider to the body.

Args

• polygon (Polygon) — The polygonal shape to add as a collider.
• density (float, optional) — The density of the collider. Defaults to 1.0.
• friction (float, optional) — The friction coefficient of the collider. Defaults to 0.2.
• restitution (float, optional) — The restitution (bounciness) of the collider. Defaults to 0.0.
• enable_events (bool, optional) — Whether to enable hit, contact, and sensor events for this collider. Defaults to False.
• is_sensor (bool, optional) — Whether the collider is a sensor. Defaults to False.

3. add_collider(self, rect: Rect, density: float = 1.0, friction: float = 0.20000000298023224, restitution: float = 0.0, enable_events: bool = False, is_sensor: bool = False) -> None

Add a rectangular collider to the body.

Args

• rect (Rect) — The rectangular shape to add as a collider.
• density (float, optional) — The density of the collider. Defaults to 1.0.
• friction (float, optional) — The friction coefficient of the collider. Defaults to 0.2.
• restitution (float, optional) — The restitution (bounciness) of the collider. Defaults to 0.0.
• enable_events (bool, optional) — Whether to enable hit, contact, and sensor events for this collider. Defaults to False.
• is_sensor (bool, optional) — Whether the collider is a sensor. Defaults to False.

4. add_collider(self, capsule: Capsule, density: float = 1.0, friction: float = 0.20000000298023224, restitution: float = 0.0, enable_events: bool = False, is_sensor: bool = False) -> None

Add a capsule collider to the body.

Args

• capsule (Capsule) — The capsule shape to add as a collider.
• density (float, optional) — The density of the collider. Defaults to 1.0.
• friction (float, optional) — The friction coefficient of the collider. Defaults to 0.2.
• restitution (float, optional) — The restitution (bounciness) of the collider. Defaults to 0.0.
• enable_events (bool, optional) — Whether to enable hit, contact, and sensor events for this collider. Defaults to False.
• is_sensor (bool, optional) — Whether the collider is a sensor. Defaults to False.

apply_angular_impulse(self, impulse: float, wake: bool = True) -> None

Apply an angular impulse to the body.

Args

• impulse (float) — The angular impulse to apply.
• wake (bool, optional) — Whether to wake the body if it's sleeping. Defaults to True.

apply_force(self, force: Vec2, point: Vec2, wake: bool = True) -> None

Apply a force to the body at a specific point.

Args

• force (Vec2) — The force vector to apply.
• point (Vec2) — The point (in world coordinates) where the force is applied.
• wake (bool, optional) — Whether to wake the body if it's sleeping. Defaults to True.

apply_force_to_center(self, force: Vec2, wake: bool = True) -> None

Apply a force to the center of mass of the body.

Args

• force (Vec2) — The force vector to apply.
• wake (bool, optional) — Whether to wake the body if it's sleeping. Defaults to True.

apply_linear_impulse(self, impulse: Vec2, point: Vec2, wake: bool = True) -> None

Apply a linear impulse to the body at a specific point.

Args

• impulse (Vec2) — The impulse vector to apply.
• point (Vec2) — The point (in world coordinates) where the impulse is applied.
• wake (bool, optional) — Whether to wake the body if it's sleeping. Defaults to True.

apply_linear_impulse_to_center(self, impulse: Vec2, wake: bool = True) -> None

Apply a linear impulse to the center of mass of the body.

Args

• impulse (Vec2) — The impulse vector to apply.
• wake (bool, optional) — Whether to wake the body if it's sleeping. Defaults to True.

apply_torque(self, torque: float, wake: bool = True) -> None

Apply a torque to the body.

Args

• torque (float) — The torque to apply.
• wake (bool, optional) — Whether to wake the body if it's sleeping. Defaults to True.

destroy(self) -> None

Destroy the body manually.

get_colliders(self) -> list[physics.Collider]

Return non-owning handles for this body's collider shapes.

get_transform(self) -> Transform

Get the current transform of the body (position, rotation, and scale).

Returns

• Transform — The current transform of the body.

wake(self) -> None

Manually wake the body from sleep.