godot-docs/classes/class_rigidbody2d.rst

:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the RigidBody2D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_RigidBody2D:

RigidBody2D
===========

**Inherits:** :ref:`PhysicsBody2D<class_PhysicsBody2D>` **<** :ref:`CollisionObject2D<class_CollisionObject2D>` **<** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------

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

Properties
----------

+-----------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                     | :ref:`angular_damp<class_RigidBody2D_property_angular_damp>`                           |
+-----------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                     | :ref:`angular_velocity<class_RigidBody2D_property_angular_velocity>`                   |
+-----------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>`                 | :ref:`applied_force<class_RigidBody2D_property_applied_force>`                         |
+-----------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                     | :ref:`applied_torque<class_RigidBody2D_property_applied_torque>`                       |
+-----------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                     | :ref:`bounce<class_RigidBody2D_property_bounce>`                                       |
+-----------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                       | :ref:`can_sleep<class_RigidBody2D_property_can_sleep>`                                 |
+-----------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                       | :ref:`contact_monitor<class_RigidBody2D_property_contact_monitor>`                     |
+-----------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                         | :ref:`contacts_reported<class_RigidBody2D_property_contacts_reported>`                 |
+-----------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`CCDMode<enum_RigidBody2D_CCDMode>`      | :ref:`continuous_cd<class_RigidBody2D_property_continuous_cd>`                         |
+-----------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                       | :ref:`custom_integrator<class_RigidBody2D_property_custom_integrator>`                 |
+-----------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                     | :ref:`friction<class_RigidBody2D_property_friction>`                                   |
+-----------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                     | :ref:`gravity_scale<class_RigidBody2D_property_gravity_scale>`                         |
+-----------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                     | :ref:`inertia<class_RigidBody2D_property_inertia>`                                     |
+-----------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                     | :ref:`linear_damp<class_RigidBody2D_property_linear_damp>`                             |
+-----------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>`                 | :ref:`linear_velocity<class_RigidBody2D_property_linear_velocity>`                     |
+-----------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                     | :ref:`mass<class_RigidBody2D_property_mass>`                                           |
+-----------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Mode<enum_RigidBody2D_Mode>`            | :ref:`mode<class_RigidBody2D_property_mode>`                                           |
+-----------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`PhysicsMaterial<class_PhysicsMaterial>` | :ref:`physics_material_override<class_RigidBody2D_property_physics_material_override>` |
+-----------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                       | :ref:`sleeping<class_RigidBody2D_property_sleeping>`                                   |
+-----------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                     | :ref:`weight<class_RigidBody2D_property_weight>`                                       |
+-----------------------------------------------+----------------------------------------------------------------------------------------+

Methods
-------

+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                      | :ref:`_integrate_forces<class_RigidBody2D_method__integrate_forces>` **(** :ref:`Physics2DDirectBodyState<class_Physics2DDirectBodyState>` state **)** virtual                                                                                                                 |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                      | :ref:`add_central_force<class_RigidBody2D_method_add_central_force>` **(** :ref:`Vector2<class_Vector2>` force **)**                                                                                                                                                           |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                      | :ref:`add_force<class_RigidBody2D_method_add_force>` **(** :ref:`Vector2<class_Vector2>` offset, :ref:`Vector2<class_Vector2>` force **)**                                                                                                                                     |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                      | :ref:`add_torque<class_RigidBody2D_method_add_torque>` **(** :ref:`float<class_float>` torque **)**                                                                                                                                                                            |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                      | :ref:`apply_central_impulse<class_RigidBody2D_method_apply_central_impulse>` **(** :ref:`Vector2<class_Vector2>` impulse **)**                                                                                                                                                 |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                      | :ref:`apply_impulse<class_RigidBody2D_method_apply_impulse>` **(** :ref:`Vector2<class_Vector2>` offset, :ref:`Vector2<class_Vector2>` impulse **)**                                                                                                                           |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                      | :ref:`apply_torque_impulse<class_RigidBody2D_method_apply_torque_impulse>` **(** :ref:`float<class_float>` torque **)**                                                                                                                                                        |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_colliding_bodies<class_RigidBody2D_method_get_colliding_bodies>` **(** **)** const                                                                                                                                                                                   |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                      | :ref:`set_axis_velocity<class_RigidBody2D_method_set_axis_velocity>` **(** :ref:`Vector2<class_Vector2>` axis_velocity **)**                                                                                                                                                   |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`   | :ref:`test_motion<class_RigidBody2D_method_test_motion>` **(** :ref:`Vector2<class_Vector2>` motion, :ref:`bool<class_bool>` infinite_inertia=true, :ref:`float<class_float>` margin=0.08, :ref:`Physics2DTestMotionResult<class_Physics2DTestMotionResult>` result=null **)** |
+---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Signals
-------

.. _class_RigidBody2D_signal_body_entered:

- **body_entered** **(** :ref:`Node<class_Node>` body **)**

Emitted when a body enters into contact with this one. :ref:`contact_monitor<class_RigidBody2D_property_contact_monitor>` must be ``true`` and :ref:`contacts_reported<class_RigidBody2D_property_contacts_reported>` greater than ``0``.

----

.. _class_RigidBody2D_signal_body_exited:

- **body_exited** **(** :ref:`Node<class_Node>` body **)**

Emitted when a body exits contact with this one. :ref:`contact_monitor<class_RigidBody2D_property_contact_monitor>` must be ``true`` and :ref:`contacts_reported<class_RigidBody2D_property_contacts_reported>` greater than ``0``.

----

.. _class_RigidBody2D_signal_body_shape_entered:

- **body_shape_entered** **(** :ref:`int<class_int>` body_id, :ref:`Node<class_Node>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` local_shape **)**

Emitted when a body enters into contact with this one. Reports colliding shape information. See :ref:`CollisionObject2D<class_CollisionObject2D>` for shape index information. :ref:`contact_monitor<class_RigidBody2D_property_contact_monitor>` must be ``true`` and :ref:`contacts_reported<class_RigidBody2D_property_contacts_reported>` greater than ``0``.

----

.. _class_RigidBody2D_signal_body_shape_exited:

- **body_shape_exited** **(** :ref:`int<class_int>` body_id, :ref:`Node<class_Node>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` local_shape **)**

Emitted when a body shape exits contact with this one. Reports colliding shape information. See :ref:`CollisionObject2D<class_CollisionObject2D>` for shape index information. :ref:`contact_monitor<class_RigidBody2D_property_contact_monitor>` must be ``true`` and :ref:`contacts_reported<class_RigidBody2D_property_contacts_reported>` greater than ``0``.

----

.. _class_RigidBody2D_signal_sleeping_state_changed:

- **sleeping_state_changed** **(** **)**

Emitted when :ref:`sleeping<class_RigidBody2D_property_sleeping>` changes.

Enumerations
------------

.. _enum_RigidBody2D_Mode:

.. _class_RigidBody2D_constant_MODE_RIGID:

.. _class_RigidBody2D_constant_MODE_STATIC:

.. _class_RigidBody2D_constant_MODE_CHARACTER:

.. _class_RigidBody2D_constant_MODE_KINEMATIC:

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 :ref:`StaticBody2D<class_StaticBody2D>` and does not move.

- **MODE_CHARACTER** = **2** --- Character mode. Similar to :ref:`MODE_RIGID<class_RigidBody2D_constant_MODE_RIGID>`, but the body can not rotate.

- **MODE_KINEMATIC** = **3** --- Kinematic mode. The body behaves like a :ref:`KinematicBody2D<class_KinematicBody2D>`, and must be moved by code.

----

.. _enum_RigidBody2D_CCDMode:

.. _class_RigidBody2D_constant_CCD_MODE_DISABLED:

.. _class_RigidBody2D_constant_CCD_MODE_CAST_RAY:

.. _class_RigidBody2D_constant_CCD_MODE_CAST_SHAPE:

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 :ref:`mode<class_RigidBody2D_property_mode>`\ s: 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 :ref:`_integrate_forces<class_RigidBody2D_method__integrate_forces>`, 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 :ref:`custom_integrator<class_RigidBody2D_property_custom_integrator>`.

Property Descriptions
---------------------

.. _class_RigidBody2D_property_angular_damp:

- :ref:`float<class_float>` **angular_damp**

+----------+-------------------------+
| *Setter* | set_angular_damp(value) |
+----------+-------------------------+
| *Getter* | get_angular_damp()      |
+----------+-------------------------+

Damps the body's :ref:`angular_velocity<class_RigidBody2D_property_angular_velocity>`. If ``-1`` the body will use the "Default Angular Damp" in "Project > Project Settings > Physics > 2d". Default value: ``-1``.

----

.. _class_RigidBody2D_property_angular_velocity:

- :ref:`float<class_float>` **angular_velocity**

+----------+-----------------------------+
| *Setter* | set_angular_velocity(value) |
+----------+-----------------------------+
| *Getter* | get_angular_velocity()      |
+----------+-----------------------------+

The body's rotational velocity.

----

.. _class_RigidBody2D_property_applied_force:

- :ref:`Vector2<class_Vector2>` **applied_force**

+----------+--------------------------+
| *Setter* | set_applied_force(value) |
+----------+--------------------------+
| *Getter* | get_applied_force()      |
+----------+--------------------------+

The body's total applied force.

----

.. _class_RigidBody2D_property_applied_torque:

- :ref:`float<class_float>` **applied_torque**

+----------+---------------------------+
| *Setter* | set_applied_torque(value) |
+----------+---------------------------+
| *Getter* | get_applied_torque()      |
+----------+---------------------------+

The body's total applied torque.

----

.. _class_RigidBody2D_property_bounce:

- :ref:`float<class_float>` **bounce**

+----------+-------------------+
| *Setter* | set_bounce(value) |
+----------+-------------------+
| *Getter* | get_bounce()      |
+----------+-------------------+

The body's bounciness. Default value: ``0``.

----

.. _class_RigidBody2D_property_can_sleep:

- :ref:`bool<class_bool>` **can_sleep**

+----------+----------------------+
| *Setter* | set_can_sleep(value) |
+----------+----------------------+
| *Getter* | is_able_to_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 :ref:`apply_impulse<class_RigidBody2D_method_apply_impulse>` or :ref:`add_force<class_RigidBody2D_method_add_force>`. Default value: ``true``.

----

.. _class_RigidBody2D_property_contact_monitor:

- :ref:`bool<class_bool>` **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 :ref:`contacts_reported<class_RigidBody2D_property_contacts_reported>`. Default value: ``false``.

----

.. _class_RigidBody2D_property_contacts_reported:

- :ref:`int<class_int>` **contacts_reported**

+----------+----------------------------------+
| *Setter* | set_max_contacts_reported(value) |
+----------+----------------------------------+
| *Getter* | get_max_contacts_reported()      |
+----------+----------------------------------+

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

----

.. _class_RigidBody2D_property_continuous_cd:

- :ref:`CCDMode<enum_RigidBody2D_CCDMode>` **continuous_cd**

+----------+------------------------------------------------+
| *Setter* | set_continuous_collision_detection_mode(value) |
+----------+------------------------------------------------+
| *Getter* | get_continuous_collision_detection_mode()      |
+----------+------------------------------------------------+

Continuous collision detection mode. Default value: :ref:`CCD_MODE_DISABLED<class_RigidBody2D_constant_CCD_MODE_DISABLED>`.

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 :ref:`CCDMode<enum_RigidBody2D_CCDMode>` for details.

----

.. _class_RigidBody2D_property_custom_integrator:

- :ref:`bool<class_bool>` **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 :ref:`_integrate_forces<class_RigidBody2D_method__integrate_forces>` function.

----

.. _class_RigidBody2D_property_friction:

- :ref:`float<class_float>` **friction**

+----------+---------------------+
| *Setter* | set_friction(value) |
+----------+---------------------+
| *Getter* | get_friction()      |
+----------+---------------------+

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

----

.. _class_RigidBody2D_property_gravity_scale:

- :ref:`float<class_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 :ref:`Area2D<class_Area2D>`\ s. Default value: ``1``.

----

.. _class_RigidBody2D_property_inertia:

- :ref:`float<class_float>` **inertia**

+----------+--------------------+
| *Setter* | set_inertia(value) |
+----------+--------------------+
| *Getter* | get_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.

----

.. _class_RigidBody2D_property_linear_damp:

- :ref:`float<class_float>` **linear_damp**

+----------+------------------------+
| *Setter* | set_linear_damp(value) |
+----------+------------------------+
| *Getter* | get_linear_damp()      |
+----------+------------------------+

Damps the body's :ref:`linear_velocity<class_RigidBody2D_property_linear_velocity>`. If ``-1`` the body will use the "Default Linear Damp" in "Project > Project Settings > Physics > 2d". Default value: ``-1``.

----

.. _class_RigidBody2D_property_linear_velocity:

- :ref:`Vector2<class_Vector2>` **linear_velocity**

+----------+----------------------------+
| *Setter* | set_linear_velocity(value) |
+----------+----------------------------+
| *Getter* | get_linear_velocity()      |
+----------+----------------------------+

The body's linear velocity.

----

.. _class_RigidBody2D_property_mass:

- :ref:`float<class_float>` **mass**

+----------+-----------------+
| *Setter* | set_mass(value) |
+----------+-----------------+
| *Getter* | get_mass()      |
+----------+-----------------+

The body's mass. Default value: ``1``.

----

.. _class_RigidBody2D_property_mode:

- :ref:`Mode<enum_RigidBody2D_Mode>` **mode**

+----------+-----------------+
| *Setter* | set_mode(value) |
+----------+-----------------+
| *Getter* | get_mode()      |
+----------+-----------------+

The body's mode. See ``MODE_*`` constants. Default value: :ref:`MODE_RIGID<class_RigidBody2D_constant_MODE_RIGID>`.

----

.. _class_RigidBody2D_property_physics_material_override:

- :ref:`PhysicsMaterial<class_PhysicsMaterial>` **physics_material_override**

+----------+--------------------------------------+
| *Setter* | set_physics_material_override(value) |
+----------+--------------------------------------+
| *Getter* | get_physics_material_override()      |
+----------+--------------------------------------+

----

.. _class_RigidBody2D_property_sleeping:

- :ref:`bool<class_bool>` **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 :ref:`apply_impulse<class_RigidBody2D_method_apply_impulse>` or :ref:`add_force<class_RigidBody2D_method_add_force>`.

----

.. _class_RigidBody2D_property_weight:

- :ref:`float<class_float>` **weight**

+----------+-------------------+
| *Setter* | set_weight(value) |
+----------+-------------------+
| *Getter* | get_weight()      |
+----------+-------------------+

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

Method Descriptions
-------------------

.. _class_RigidBody2D_method__integrate_forces:

- void **_integrate_forces** **(** :ref:`Physics2DDirectBodyState<class_Physics2DDirectBodyState>` state **)** virtual

Allows you to read and safely modify the simulation state for the object. Use this instead of :ref:`Node._physics_process<class_Node_method__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 :ref:`custom_integrator<class_RigidBody2D_property_custom_integrator>` allows you to disable the default behavior and write custom force integration for a body.

----

.. _class_RigidBody2D_method_add_central_force:

- void **add_central_force** **(** :ref:`Vector2<class_Vector2>` force **)**

Adds a constant directional force without affecting rotation.

----

.. _class_RigidBody2D_method_add_force:

- void **add_force** **(** :ref:`Vector2<class_Vector2>` offset, :ref:`Vector2<class_Vector2>` force **)**

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

----

.. _class_RigidBody2D_method_add_torque:

- void **add_torque** **(** :ref:`float<class_float>` torque **)**

Adds a constant rotational force.

----

.. _class_RigidBody2D_method_apply_central_impulse:

- void **apply_central_impulse** **(** :ref:`Vector2<class_Vector2>` impulse **)**

Applies a directional impulse without affecting rotation.

----

.. _class_RigidBody2D_method_apply_impulse:

- void **apply_impulse** **(** :ref:`Vector2<class_Vector2>` offset, :ref:`Vector2<class_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.

----

.. _class_RigidBody2D_method_apply_torque_impulse:

- void **apply_torque_impulse** **(** :ref:`float<class_float>` torque **)**

Applies a rotational impulse to the body.

----

.. _class_RigidBody2D_method_get_colliding_bodies:

- :ref:`Array<class_Array>` **get_colliding_bodies** **(** **)** const

Returns a list of the bodies colliding with this one. Use :ref:`contacts_reported<class_RigidBody2D_property_contacts_reported>` to set the maximum number reported. You must also set :ref:`contact_monitor<class_RigidBody2D_property_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.

----

.. _class_RigidBody2D_method_set_axis_velocity:

- void **set_axis_velocity** **(** :ref:`Vector2<class_Vector2>` 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.

----

.. _class_RigidBody2D_method_test_motion:

- :ref:`bool<class_bool>` **test_motion** **(** :ref:`Vector2<class_Vector2>` motion, :ref:`bool<class_bool>` infinite_inertia=true, :ref:`float<class_float>` margin=0.08, :ref:`Physics2DTestMotionResult<class_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 :ref:`Physics2DTestMotionResult<class_Physics2DTestMotionResult>`, which contains additional information about the collision (should there be one).