2017-09-13 18:56:01 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2018-02-27 12:40:43 +00:00
<class name= "KinematicCollision2D" inherits= "Reference" category= "Core" version= "3.1" >
2017-09-13 18:56:01 +00:00
<brief_description >
2017-09-14 23:04:36 +00:00
Collision data for KinematicBody2D collisions.
2017-09-13 18:56:01 +00:00
</brief_description>
<description >
2017-09-14 23:04:36 +00:00
Contains collision data for KinematicBody2D collisions. When a [KinematicBody2D] is moved using [method 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.
2017-09-13 18:56:01 +00:00
</description>
<tutorials >
</tutorials>
<demos >
</demos>
<methods >
</methods>
<members >
<member name= "collider" type= "Object" setter= "" getter= "get_collider" >
2017-09-14 23:04:36 +00:00
The colliding body.
2017-09-13 18:56:01 +00:00
</member>
<member name= "collider_id" type= "int" setter= "" getter= "get_collider_id" >
2017-09-14 23:04:36 +00:00
The colliding body's unique [RID].
2017-09-13 18:56:01 +00:00
</member>
<member name= "collider_metadata" type= "Variant" setter= "" getter= "get_collider_metadata" >
2017-09-14 23:04:36 +00:00
The colliding body's metadata. See [Object].
2017-09-13 18:56:01 +00:00
</member>
<member name= "collider_shape" type= "Object" setter= "" getter= "get_collider_shape" >
2017-09-14 23:04:36 +00:00
The colliding body's shape.
2017-09-13 18:56:01 +00:00
</member>
<member name= "collider_shape_index" type= "int" setter= "" getter= "get_collider_shape_index" >
2017-09-14 23:04:36 +00:00
The colliding shape's index. See [CollisionObject2D].
2017-09-13 18:56:01 +00:00
</member>
<member name= "collider_velocity" type= "Vector2" setter= "" getter= "get_collider_velocity" >
2017-09-14 23:04:36 +00:00
The colliding object's velocity.
2017-09-13 18:56:01 +00:00
</member>
<member name= "local_shape" type= "Object" setter= "" getter= "get_local_shape" >
2017-09-14 23:04:36 +00:00
The moving object's colliding shape.
2017-09-13 18:56:01 +00:00
</member>
<member name= "normal" type= "Vector2" setter= "" getter= "get_normal" >
2017-09-14 23:04:36 +00:00
The colliding body's shape's normal at the point of collision.
2017-09-13 18:56:01 +00:00
</member>
<member name= "position" type= "Vector2" setter= "" getter= "get_position" >
2017-09-14 23:04:36 +00:00
The point of collision.
2017-09-13 18:56:01 +00:00
</member>
<member name= "remainder" type= "Vector2" setter= "" getter= "get_remainder" >
2017-09-14 23:04:36 +00:00
The moving object's remaining movement vector.
2017-09-13 18:56:01 +00:00
</member>
<member name= "travel" type= "Vector2" setter= "" getter= "get_travel" >
2017-09-14 23:04:36 +00:00
The distance the moving object traveled before collision.
2017-09-13 18:56:01 +00:00
</member>
</members>
<constants >
</constants>
</class>
