mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
149 lines
7.1 KiB
ReStructuredText
149 lines
7.1 KiB
ReStructuredText
.. 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 KinematicBody2D collisions.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Object<class_object>` | :ref:`get_collider<class_KinematicCollision2D_get_collider>` **(** **)** const |
|
|
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_collider_id<class_KinematicCollision2D_get_collider_id>` **(** **)** const |
|
|
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Variant<class_variant>` | :ref:`get_collider_metadata<class_KinematicCollision2D_get_collider_metadata>` **(** **)** const |
|
|
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Object<class_object>` | :ref:`get_collider_shape<class_KinematicCollision2D_get_collider_shape>` **(** **)** const |
|
|
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_collider_shape_index<class_KinematicCollision2D_get_collider_shape_index>` **(** **)** const |
|
|
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector2<class_vector2>` | :ref:`get_collider_velocity<class_KinematicCollision2D_get_collider_velocity>` **(** **)** const |
|
|
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Object<class_object>` | :ref:`get_local_shape<class_KinematicCollision2D_get_local_shape>` **(** **)** const |
|
|
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector2<class_vector2>` | :ref:`get_normal<class_KinematicCollision2D_get_normal>` **(** **)** const |
|
|
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector2<class_vector2>` | :ref:`get_position<class_KinematicCollision2D_get_position>` **(** **)** const |
|
|
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector2<class_vector2>` | :ref:`get_remainder<class_KinematicCollision2D_get_remainder>` **(** **)** const |
|
|
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector2<class_vector2>` | :ref:`get_travel<class_KinematicCollision2D_get_travel>` **(** **)** const |
|
|
+--------------------------------+--------------------------------------------------------------------------------------------------------+
|
|
|
|
Member Variables
|
|
----------------
|
|
|
|
.. _class_KinematicCollision2D_collider:
|
|
|
|
- :ref:`Object<class_object>` **collider** - The colliding body.
|
|
|
|
.. _class_KinematicCollision2D_collider_id:
|
|
|
|
- :ref:`int<class_int>` **collider_id** - The colliding body's unique :ref:`RID<class_rid>`.
|
|
|
|
.. _class_KinematicCollision2D_collider_metadata:
|
|
|
|
- :ref:`Variant<class_variant>` **collider_metadata** - The colliding body's metadata. See :ref:`Object<class_object>`.
|
|
|
|
.. _class_KinematicCollision2D_collider_shape:
|
|
|
|
- :ref:`Object<class_object>` **collider_shape** - The colliding body's shape.
|
|
|
|
.. _class_KinematicCollision2D_collider_shape_index:
|
|
|
|
- :ref:`int<class_int>` **collider_shape_index** - The colliding shape's index. See :ref:`CollisionObject2D<class_collisionobject2d>`.
|
|
|
|
.. _class_KinematicCollision2D_collider_velocity:
|
|
|
|
- :ref:`Vector2<class_vector2>` **collider_velocity** - The colliding object's velocity.
|
|
|
|
.. _class_KinematicCollision2D_local_shape:
|
|
|
|
- :ref:`Object<class_object>` **local_shape** - The moving object's colliding shape.
|
|
|
|
.. _class_KinematicCollision2D_normal:
|
|
|
|
- :ref:`Vector2<class_vector2>` **normal** - The colliding body's shape's normal at the point of collision.
|
|
|
|
.. _class_KinematicCollision2D_position:
|
|
|
|
- :ref:`Vector2<class_vector2>` **position** - The point of collision.
|
|
|
|
.. _class_KinematicCollision2D_remainder:
|
|
|
|
- :ref:`Vector2<class_vector2>` **remainder** - The moving object's remaining movement vector.
|
|
|
|
.. _class_KinematicCollision2D_travel:
|
|
|
|
- :ref:`Vector2<class_vector2>` **travel** - The distance the moving object traveled before collision.
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
Contains collision data for KinematicBody2D collisions. When a :ref:`KinematicBody2D<class_kinematicbody2d>` is moved using :ref:`KinematicBody2D.move_and_collide<class_KinematicBody2D_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.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_KinematicCollision2D_get_collider:
|
|
|
|
- :ref:`Object<class_object>` **get_collider** **(** **)** const
|
|
|
|
.. _class_KinematicCollision2D_get_collider_id:
|
|
|
|
- :ref:`int<class_int>` **get_collider_id** **(** **)** const
|
|
|
|
.. _class_KinematicCollision2D_get_collider_metadata:
|
|
|
|
- :ref:`Variant<class_variant>` **get_collider_metadata** **(** **)** const
|
|
|
|
.. _class_KinematicCollision2D_get_collider_shape:
|
|
|
|
- :ref:`Object<class_object>` **get_collider_shape** **(** **)** const
|
|
|
|
.. _class_KinematicCollision2D_get_collider_shape_index:
|
|
|
|
- :ref:`int<class_int>` **get_collider_shape_index** **(** **)** const
|
|
|
|
.. _class_KinematicCollision2D_get_collider_velocity:
|
|
|
|
- :ref:`Vector2<class_vector2>` **get_collider_velocity** **(** **)** const
|
|
|
|
.. _class_KinematicCollision2D_get_local_shape:
|
|
|
|
- :ref:`Object<class_object>` **get_local_shape** **(** **)** const
|
|
|
|
.. _class_KinematicCollision2D_get_normal:
|
|
|
|
- :ref:`Vector2<class_vector2>` **get_normal** **(** **)** const
|
|
|
|
.. _class_KinematicCollision2D_get_position:
|
|
|
|
- :ref:`Vector2<class_vector2>` **get_position** **(** **)** const
|
|
|
|
.. _class_KinematicCollision2D_get_remainder:
|
|
|
|
- :ref:`Vector2<class_vector2>` **get_remainder** **(** **)** const
|
|
|
|
.. _class_KinematicCollision2D_get_travel:
|
|
|
|
- :ref:`Vector2<class_vector2>` **get_travel** **(** **)** const
|
|
|
|
|