:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/KinematicCollision3D.xml. .. _class_KinematicCollision3D: KinematicCollision3D ==================== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` Holds collision data from the movement of a :ref:`PhysicsBody3D`. .. rst-class:: classref-introduction-group Description ----------- Holds collision data from the movement of a :ref:`PhysicsBody3D`, usually from :ref:`PhysicsBody3D.move_and_collide()`. When a :ref:`PhysicsBody3D` is moved, it stops if it detects a collision with another body. If a collision is detected, a **KinematicCollision3D** object is returned. The collision data includes the colliding object, the remaining motion, and the collision position. This data can be used to determine a custom response to the collision. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_angle`\ (\ collision_index\: :ref:`int` = 0, up_direction\: :ref:`Vector3` = Vector3(0, 1, 0)\ ) |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_collider`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collider_id`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_collider_rid`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_collider_shape`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collider_shape_index`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_collider_velocity`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collision_count`\ (\ ) |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_depth`\ (\ ) |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_local_shape`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_normal`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_position`\ (\ collision_index\: :ref:`int` = 0\ ) |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_remainder`\ (\ ) |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_travel`\ (\ ) |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_KinematicCollision3D_method_get_angle: .. rst-class:: classref-method :ref:`float` **get_angle**\ (\ collision_index\: :ref:`int` = 0, up_direction\: :ref:`Vector3` = Vector3(0, 1, 0)\ ) |const| :ref:`🔗` Returns the collision angle according to ``up_direction``, which is :ref:`Vector3.UP` by default. This value is always positive. .. rst-class:: classref-item-separator ---- .. _class_KinematicCollision3D_method_get_collider: .. rst-class:: classref-method :ref:`Object` **get_collider**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the colliding body's attached :ref:`Object` given a collision index (the deepest collision by default). .. rst-class:: classref-item-separator ---- .. _class_KinematicCollision3D_method_get_collider_id: .. rst-class:: classref-method :ref:`int` **get_collider_id**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the unique instance ID of the colliding body's attached :ref:`Object` given a collision index (the deepest collision by default). See :ref:`Object.get_instance_id()`. .. rst-class:: classref-item-separator ---- .. _class_KinematicCollision3D_method_get_collider_rid: .. rst-class:: classref-method :ref:`RID` **get_collider_rid**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the colliding body's :ref:`RID` used by the :ref:`PhysicsServer3D` given a collision index (the deepest collision by default). .. rst-class:: classref-item-separator ---- .. _class_KinematicCollision3D_method_get_collider_shape: .. rst-class:: classref-method :ref:`Object` **get_collider_shape**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the colliding body's shape given a collision index (the deepest collision by default). .. rst-class:: classref-item-separator ---- .. _class_KinematicCollision3D_method_get_collider_shape_index: .. rst-class:: classref-method :ref:`int` **get_collider_shape_index**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the colliding body's shape index given a collision index (the deepest collision by default). See :ref:`CollisionObject3D`. .. rst-class:: classref-item-separator ---- .. _class_KinematicCollision3D_method_get_collider_velocity: .. rst-class:: classref-method :ref:`Vector3` **get_collider_velocity**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the colliding body's velocity given a collision index (the deepest collision by default). .. rst-class:: classref-item-separator ---- .. _class_KinematicCollision3D_method_get_collision_count: .. rst-class:: classref-method :ref:`int` **get_collision_count**\ (\ ) |const| :ref:`🔗` Returns the number of detected collisions. .. rst-class:: classref-item-separator ---- .. _class_KinematicCollision3D_method_get_depth: .. rst-class:: classref-method :ref:`float` **get_depth**\ (\ ) |const| :ref:`🔗` Returns the colliding body's length of overlap along the collision normal. .. rst-class:: classref-item-separator ---- .. _class_KinematicCollision3D_method_get_local_shape: .. rst-class:: classref-method :ref:`Object` **get_local_shape**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the moving object's colliding shape given a collision index (the deepest collision by default). .. rst-class:: classref-item-separator ---- .. _class_KinematicCollision3D_method_get_normal: .. rst-class:: classref-method :ref:`Vector3` **get_normal**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the colliding body's shape's normal at the point of collision given a collision index (the deepest collision by default). .. rst-class:: classref-item-separator ---- .. _class_KinematicCollision3D_method_get_position: .. rst-class:: classref-method :ref:`Vector3` **get_position**\ (\ collision_index\: :ref:`int` = 0\ ) |const| :ref:`🔗` Returns the point of collision in global coordinates given a collision index (the deepest collision by default). .. rst-class:: classref-item-separator ---- .. _class_KinematicCollision3D_method_get_remainder: .. rst-class:: classref-method :ref:`Vector3` **get_remainder**\ (\ ) |const| :ref:`🔗` Returns the moving object's remaining movement vector. .. rst-class:: classref-item-separator ---- .. _class_KinematicCollision3D_method_get_travel: .. rst-class:: classref-method :ref:`Vector3` **get_travel**\ (\ ) |const| :ref:`🔗` 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.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`