RigidBody2D

Category: Core

A body that is controlled by the 2D physics engine.

Properties

void	( Physics2DDirectBodyState state ) virtual
void	( Vector2 force )
void	( Vector2 offset, force )
void	add_torque ( torque )
void	apply_central_impulse ( impulse )
void	apply_impulse ( offset, Vector2 impulse )
void	( float torque )
	get_colliding_bodies ( ) const
void	( Vector2 axis_velocity )
	test_motion ( motion, bool infinite_inertia=true, margin=0.08, Physics2DTestMotionResult result=null )

Signals

body_entered ( body )

Emitted when a body enters into contact with this one. contact_monitor must be and greater than 0.

body_exited ( Node body )

Emitted when a body exits contact with this one. must be true and contacts_reported greater than 0.

body_shape_entered ( body_id, Node body, body_shape, int local_shape )

Emitted when a body enters into contact with this one. Reports colliding shape information. See for shape index information. contact_monitor must be true and greater than 0.

body_shape_exited ( int body_id, body, int body_shape, local_shape )

Emitted when a body shape exits contact with this one. Reports colliding shape information. See CollisionObject2D for shape index information. must be true and contacts_reported greater than 0.

sleeping_state_changed ( )

Emitted when changes.

enum Mode:

MODE_RIGID = 0 — Rigid mode. The body behaves as a physical object. It collides with other bodies and responds to forces applied to it. This is the default mode.
MODE_STATIC = 1 — Static mode. The body behaves like a StaticBody2D and does not move.
MODE_CHARACTER = 2 — Character mode. Similar to , but the body can not rotate.

enum CCDMode:

CCD_MODE_DISABLED = 0 — Continuous collision detection disabled. This is the fastest way to detect body collisions, but can miss small, fast-moving objects.
CCD_MODE_CAST_RAY = 1 — Continuous collision detection enabled using raycasting. This is faster than shapecasting but less precise.
CCD_MODE_CAST_SHAPE = 2 — Continuous collision detection enabled using shapecasting. This is the slowest CCD method and the most precise.

Description

This node implements simulated 2D physics. You do not control a RigidBody2D directly. Instead you apply forces to it (gravity, impulses, etc.) and the physics simulation calculates the resulting movement based on its mass, friction, and other physical properties.

A RigidBody2D has 4 behavior modes: Rigid, Static, Character, and Kinematic.

Note: You should not change a RigidBody2D’s position or linear_velocity every frame or even very often. If you need to directly affect the body’s state, use , which allows you to directly access the physics state.

Please also keep in mind that physics bodies manage their own transform which overwrites the ones you set. So any direct or indirect transformation (including scaling of the node or its parent) will be visible in the editor only, and immediately reset at runtime.

If you need to override the default physics behavior or add a transformation at runtime, you can write a custom force integration. See custom_integrator.

angular_damp

Setter	set_angular_damp(value)
Getter	get_angular_damp()

float angular_velocity

Setter	set_angular_velocity(value)
Getter	get_angular_velocity()

The body’s rotational velocity.

applied_force

Setter	set_applied_force(value)
Getter	get_applied_force()

The body’s total applied force.

float applied_torque

Setter	set_applied_torque(value)
Getter	get_applied_torque()

The body’s total applied torque.

bounce

Setter	set_bounce(value)
Getter	get_bounce()

The body’s bounciness. Default value: 0.

bool can_sleep

If true, the body will not calculate forces and will act as a static body if there is no movement. The body will wake up when other forces are applied via collisions or by using or add_force. Default value: true.

contact_monitor

Setter	set_contact_monitor(value)
Getter	is_contact_monitor_enabled()

If true, the body will emit signals when it collides with another RigidBody2D. See also contacts_reported. Default value: false.

contacts_reported

Setter	set_max_contacts_reported(value)
Getter	get_max_contacts_reported()

The maximum number of contacts to report. Default value: 0.

CCDMode continuous_cd

Setter	set_continuous_collision_detection_mode(value)
Getter	get_continuous_collision_detection_mode()

Continuous collision detection mode. Default value: .

Continuous collision detection tries to predict where a moving body will collide instead of moving it and correcting its movement after collision. Continuous collision detection is slower, but more precise and misses fewer collisions with small, fast-moving objects. Raycasting and shapecasting methods are available. See CCDMode for details.

custom_integrator

Setter	set_use_custom_integrator(value)
Getter	is_using_custom_integrator()

If true, internal force integration is disabled for this body. Aside from collision response, the body will only move as determined by the _integrate_forces function.

friction

Setter	set_friction(value)
Getter	get_friction()

The body’s friction. Values range from 0 (frictionless) to 1 (maximum friction). Default value: 1.

float gravity_scale

Setter	set_gravity_scale(value)
Getter	get_gravity_scale()

Multiplies the gravity applied to the body. The body’s gravity is calculated from the “Default Gravity” value in “Project > Project Settings > Physics > 2d” and/or any additional gravity vector applied by s. Default value: .

float inertia

The body’s moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 (or negative) inertia to return to automatically computing it.

Setter	set_linear_damp(value)
Getter	get_linear_damp()

Damps the body’s . If -1 the body will use the “Default Linear Damp” in “Project > Project Settings > Physics > 2d”. Default value: -1.

Vector2 linear_velocity

Setter	set_linear_velocity(value)
Getter	get_linear_velocity()

mass

Setter	set_mass(value)
Getter	get_mass()

The body’s mass. Default value: 1.

Mode mode

Setter	set_mode(value)
Getter	get_mode()

The body’s mode. See MODE_* constants. Default value: .

PhysicsMaterial physics_material_override

Setter	set_physics_material_override(value)
Getter	get_physics_material_override()

sleeping

Setter	set_sleeping(value)
Getter	is_sleeping()

If true, the body is sleeping and will not calculate forces until woken up by a collision or by using apply_impulse or .

float weight

The body’s weight based on its mass and the “Default Gravity” value in “Project > Project Settings > Physics > 2d”.

Method Descriptions

void _integrate_forces ( state ) virtual

Allows you to read and safely modify the simulation state for the object. Use this instead of Node._physics_process if you need to directly change the body’s position or other physics properties. By default, it works in addition to the usual physics behavior, but allows you to disable the default behavior and write custom force integration for a body.

void add_central_force ( Vector2 force )

Adds a constant directional force without affecting rotation.

void add_force ( offset, Vector2 force )

Adds a positioned force to the body. Both the force and the offset from the body origin are in global coordinates.

void add_torque ( torque )

Adds a constant rotational force.

void apply_central_impulse ( Vector2 impulse )

Applies a directional impulse without affecting rotation.

void apply_impulse ( offset, Vector2 impulse )

Applies a positioned impulse to the body. An impulse is time independent! Applying an impulse every frame would result in a framerate dependent force. For this reason it should only be used when simulating one-time impacts (use the “_force” functions otherwise). The position uses the rotation of the global coordinate system, but is centered at the object’s origin.

void apply_torque_impulse ( torque )

Applies a rotational impulse to the body.

Array get_colliding_bodies ( ) const

Returns a list of the bodies colliding with this one. Use to set the maximum number reported. You must also set contact_monitor to true. Note that the result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead.

void set_axis_velocity ( axis_velocity )

Sets the body’s velocity on the given axis. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.

bool test_motion ( motion, bool infinite_inertia=true, margin=0.08, Physics2DTestMotionResult result=null )

Returns true if a collision would result from moving in the given vector. margin increases the size of the shapes involved in the collision detection, and result is an object of type , which contains additional information about the collision (should there be one).