physics.Body

physics.Body(/, *args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

collision_layer: int

The body's collision layer (category bits).

collision_mask: int

The body's collision mask.

is_valid: bool

Indicates whether the body is not destroyed.

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.

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.