godot-docs/classes/class_kinematiccollision2d.rst

:github_url: hide

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

.. _class_KinematicCollision2D:

KinematicCollision2D
====================

**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

Collision data for :ref:`PhysicsBody2D.move_and_collide<class_PhysicsBody2D_method_move_and_collide>` collisions.

Description
-----------

Contains collision data for :ref:`PhysicsBody2D.move_and_collide<class_PhysicsBody2D_method_move_and_collide>` collisions. When a :ref:`PhysicsBody2D<class_PhysicsBody2D>` is moved using :ref:`PhysicsBody2D.move_and_collide<class_PhysicsBody2D_method_move_and_collide>`, it stops if it detects a collision with another body. If a collision is detected, a ``KinematicCollision2D`` object is returned.

This object contains information about the collision, including the colliding object, the remaining motion, and the collision position. This information can be used to calculate a collision response.

Methods
-------

+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`     | :ref:`get_angle<class_KinematicCollision2D_method_get_angle>` **(** :ref:`Vector2<class_Vector2>` up_direction=Vector2(0, -1) **)** |const| |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_Object>`   | :ref:`get_collider<class_KinematicCollision2D_method_get_collider>` **(** **)** |const|                                                     |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`         | :ref:`get_collider_id<class_KinematicCollision2D_method_get_collider_id>` **(** **)** |const|                                               |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_RID>`         | :ref:`get_collider_rid<class_KinematicCollision2D_method_get_collider_rid>` **(** **)** |const|                                             |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_Object>`   | :ref:`get_collider_shape<class_KinematicCollision2D_method_get_collider_shape>` **(** **)** |const|                                         |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`         | :ref:`get_collider_shape_index<class_KinematicCollision2D_method_get_collider_shape_index>` **(** **)** |const|                             |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_collider_velocity<class_KinematicCollision2D_method_get_collider_velocity>` **(** **)** |const|                                   |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_Object>`   | :ref:`get_local_shape<class_KinematicCollision2D_method_get_local_shape>` **(** **)** |const|                                               |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_normal<class_KinematicCollision2D_method_get_normal>` **(** **)** |const|                                                         |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_position<class_KinematicCollision2D_method_get_position>` **(** **)** |const|                                                     |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_remainder<class_KinematicCollision2D_method_get_remainder>` **(** **)** |const|                                                   |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_travel<class_KinematicCollision2D_method_get_travel>` **(** **)** |const|                                                         |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+

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

.. _class_KinematicCollision2D_method_get_angle:

- :ref:`float<class_float>` **get_angle** **(** :ref:`Vector2<class_Vector2>` up_direction=Vector2(0, -1) **)** |const|

Returns the collision angle according to ``up_direction``, which is ``Vector2.UP`` by default. This value is always positive.

----

.. _class_KinematicCollision2D_method_get_collider:

- :ref:`Object<class_Object>` **get_collider** **(** **)** |const|

Returns the colliding body's attached :ref:`Object<class_Object>`.

----

.. _class_KinematicCollision2D_method_get_collider_id:

- :ref:`int<class_int>` **get_collider_id** **(** **)** |const|

Returns the unique instance ID of the colliding body's attached :ref:`Object<class_Object>`. See :ref:`Object.get_instance_id<class_Object_method_get_instance_id>`.

----

.. _class_KinematicCollision2D_method_get_collider_rid:

- :ref:`RID<class_RID>` **get_collider_rid** **(** **)** |const|

Returns the colliding body's :ref:`RID<class_RID>` used by the :ref:`PhysicsServer2D<class_PhysicsServer2D>`.

----

.. _class_KinematicCollision2D_method_get_collider_shape:

- :ref:`Object<class_Object>` **get_collider_shape** **(** **)** |const|

Returns the colliding body's shape.

----

.. _class_KinematicCollision2D_method_get_collider_shape_index:

- :ref:`int<class_int>` **get_collider_shape_index** **(** **)** |const|

Returns the colliding body's shape index. See :ref:`CollisionObject2D<class_CollisionObject2D>`.

----

.. _class_KinematicCollision2D_method_get_collider_velocity:

- :ref:`Vector2<class_Vector2>` **get_collider_velocity** **(** **)** |const|

Returns the colliding body's velocity.

----

.. _class_KinematicCollision2D_method_get_local_shape:

- :ref:`Object<class_Object>` **get_local_shape** **(** **)** |const|

Returns the moving object's colliding shape.

----

.. _class_KinematicCollision2D_method_get_normal:

- :ref:`Vector2<class_Vector2>` **get_normal** **(** **)** |const|

Returns the colliding body's shape's normal at the point of collision.

----

.. _class_KinematicCollision2D_method_get_position:

- :ref:`Vector2<class_Vector2>` **get_position** **(** **)** |const|

Returns the point of collision in global coordinates.

----

.. _class_KinematicCollision2D_method_get_remainder:

- :ref:`Vector2<class_Vector2>` **get_remainder** **(** **)** |const|

Returns the moving object's remaining movement vector.

----

.. _class_KinematicCollision2D_method_get_travel:

- :ref:`Vector2<class_Vector2>` **get_travel** **(** **)** |const|

Returns the moving object's travel before collision.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`