mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
182 lines
7.5 KiB
ReStructuredText
182 lines
7.5 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/makerst.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:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Collision data for :ref:`KinematicBody2D<class_KinematicBody2D>` collisions.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------------+---------------------------------------------------------------------------------------+-----------------+
|
|
| :ref:`Object<class_Object>` | :ref:`collider<class_KinematicCollision2D_property_collider>` | |
|
|
+-------------------------------+---------------------------------------------------------------------------------------+-----------------+
|
|
| :ref:`int<class_int>` | :ref:`collider_id<class_KinematicCollision2D_property_collider_id>` | 0 |
|
|
+-------------------------------+---------------------------------------------------------------------------------------+-----------------+
|
|
| :ref:`Variant<class_Variant>` | :ref:`collider_metadata<class_KinematicCollision2D_property_collider_metadata>` | |
|
|
+-------------------------------+---------------------------------------------------------------------------------------+-----------------+
|
|
| :ref:`Object<class_Object>` | :ref:`collider_shape<class_KinematicCollision2D_property_collider_shape>` | |
|
|
+-------------------------------+---------------------------------------------------------------------------------------+-----------------+
|
|
| :ref:`int<class_int>` | :ref:`collider_shape_index<class_KinematicCollision2D_property_collider_shape_index>` | 0 |
|
|
+-------------------------------+---------------------------------------------------------------------------------------+-----------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`collider_velocity<class_KinematicCollision2D_property_collider_velocity>` | Vector2( 0, 0 ) |
|
|
+-------------------------------+---------------------------------------------------------------------------------------+-----------------+
|
|
| :ref:`Object<class_Object>` | :ref:`local_shape<class_KinematicCollision2D_property_local_shape>` | |
|
|
+-------------------------------+---------------------------------------------------------------------------------------+-----------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`normal<class_KinematicCollision2D_property_normal>` | Vector2( 0, 0 ) |
|
|
+-------------------------------+---------------------------------------------------------------------------------------+-----------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`position<class_KinematicCollision2D_property_position>` | Vector2( 0, 0 ) |
|
|
+-------------------------------+---------------------------------------------------------------------------------------+-----------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`remainder<class_KinematicCollision2D_property_remainder>` | Vector2( 0, 0 ) |
|
|
+-------------------------------+---------------------------------------------------------------------------------------+-----------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`travel<class_KinematicCollision2D_property_travel>` | Vector2( 0, 0 ) |
|
|
+-------------------------------+---------------------------------------------------------------------------------------+-----------------+
|
|
|
|
Description
|
|
-----------
|
|
|
|
Contains collision data for :ref:`KinematicBody2D<class_KinematicBody2D>` collisions. When a :ref:`KinematicBody2D<class_KinematicBody2D>` is moved using :ref:`KinematicBody2D.move_and_collide<class_KinematicBody2D_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.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_KinematicCollision2D_property_collider:
|
|
|
|
- :ref:`Object<class_Object>` **collider**
|
|
|
|
+----------+----------------+
|
|
| *Getter* | get_collider() |
|
|
+----------+----------------+
|
|
|
|
The colliding body.
|
|
|
|
.. _class_KinematicCollision2D_property_collider_id:
|
|
|
|
- :ref:`int<class_int>` **collider_id**
|
|
|
|
+-----------+-------------------+
|
|
| *Default* | 0 |
|
|
+-----------+-------------------+
|
|
| *Getter* | get_collider_id() |
|
|
+-----------+-------------------+
|
|
|
|
The colliding body's unique :ref:`RID<class_RID>`.
|
|
|
|
.. _class_KinematicCollision2D_property_collider_metadata:
|
|
|
|
- :ref:`Variant<class_Variant>` **collider_metadata**
|
|
|
|
+----------+-------------------------+
|
|
| *Getter* | get_collider_metadata() |
|
|
+----------+-------------------------+
|
|
|
|
The colliding body's metadata. See :ref:`Object<class_Object>`.
|
|
|
|
.. _class_KinematicCollision2D_property_collider_shape:
|
|
|
|
- :ref:`Object<class_Object>` **collider_shape**
|
|
|
|
+----------+----------------------+
|
|
| *Getter* | get_collider_shape() |
|
|
+----------+----------------------+
|
|
|
|
The colliding body's shape.
|
|
|
|
.. _class_KinematicCollision2D_property_collider_shape_index:
|
|
|
|
- :ref:`int<class_int>` **collider_shape_index**
|
|
|
|
+-----------+----------------------------+
|
|
| *Default* | 0 |
|
|
+-----------+----------------------------+
|
|
| *Getter* | get_collider_shape_index() |
|
|
+-----------+----------------------------+
|
|
|
|
The colliding shape's index. See :ref:`CollisionObject2D<class_CollisionObject2D>`.
|
|
|
|
.. _class_KinematicCollision2D_property_collider_velocity:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **collider_velocity**
|
|
|
|
+-----------+-------------------------+
|
|
| *Default* | Vector2( 0, 0 ) |
|
|
+-----------+-------------------------+
|
|
| *Getter* | get_collider_velocity() |
|
|
+-----------+-------------------------+
|
|
|
|
The colliding object's velocity.
|
|
|
|
.. _class_KinematicCollision2D_property_local_shape:
|
|
|
|
- :ref:`Object<class_Object>` **local_shape**
|
|
|
|
+----------+-------------------+
|
|
| *Getter* | get_local_shape() |
|
|
+----------+-------------------+
|
|
|
|
The moving object's colliding shape.
|
|
|
|
.. _class_KinematicCollision2D_property_normal:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **normal**
|
|
|
|
+-----------+-----------------+
|
|
| *Default* | Vector2( 0, 0 ) |
|
|
+-----------+-----------------+
|
|
| *Getter* | get_normal() |
|
|
+-----------+-----------------+
|
|
|
|
The colliding body's shape's normal at the point of collision.
|
|
|
|
.. _class_KinematicCollision2D_property_position:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **position**
|
|
|
|
+-----------+-----------------+
|
|
| *Default* | Vector2( 0, 0 ) |
|
|
+-----------+-----------------+
|
|
| *Getter* | get_position() |
|
|
+-----------+-----------------+
|
|
|
|
The point of collision.
|
|
|
|
.. _class_KinematicCollision2D_property_remainder:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **remainder**
|
|
|
|
+-----------+-----------------+
|
|
| *Default* | Vector2( 0, 0 ) |
|
|
+-----------+-----------------+
|
|
| *Getter* | get_remainder() |
|
|
+-----------+-----------------+
|
|
|
|
The moving object's remaining movement vector.
|
|
|
|
.. _class_KinematicCollision2D_property_travel:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **travel**
|
|
|
|
+-----------+-----------------+
|
|
| *Default* | Vector2( 0, 0 ) |
|
|
+-----------+-----------------+
|
|
| *Getter* | get_travel() |
|
|
+-----------+-----------------+
|
|
|
|
The distance the moving object traveled before collision.
|
|
|