diff --git a/doc/classes/KinematicCollision.xml b/doc/classes/KinematicCollision.xml index 5e5b125654e..b7269a646ee 100644 --- a/doc/classes/KinematicCollision.xml +++ b/doc/classes/KinematicCollision.xml @@ -1,8 +1,11 @@ + Collision data for KinematicBody2D collisions. + Contains collision data for KinematicBody collisions. When a [KinematicBody] is moved using [method KinematicBody.move_and_collide], it stops if it detects a collision with another body. If a collision is detected, a KinematicCollision 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. @@ -78,26 +81,37 @@ + The colliding body. + The colliding body's unique [RID]. + The colliding body's metadata. See [Object]. + The colliding body's shape. + The colliding shape's index. See [CollisionObject]. + The colliding object's velocity. + The moving object's colliding shape. + The colliding body's shape's normal at the point of collision. + The point of collision. + The moving object's remaining movement vector. + The distance the moving object traveled before collision.