|
|
@@ -1,8 +1,11 @@
|
|
|
<?xml version="1.0" encoding="UTF-8" ?>
|
|
|
<class name="KinematicCollision" inherits="Reference" category="Core" version="3.0.alpha.custom_build">
|
|
|
<brief_description>
|
|
|
+ Collision data for KinematicBody2D collisions.
|
|
|
</brief_description>
|
|
|
<description>
|
|
|
+ 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.
|
|
|
</description>
|
|
|
<tutorials>
|
|
|
</tutorials>
|
|
|
@@ -78,26 +81,37 @@
|
|
|
</methods>
|
|
|
<members>
|
|
|
<member name="collider" type="Object" setter="" getter="get_collider">
|
|
|
+ The colliding body.
|
|
|
</member>
|
|
|
<member name="collider_id" type="int" setter="" getter="get_collider_id">
|
|
|
+ The colliding body's unique [RID].
|
|
|
</member>
|
|
|
<member name="collider_metadata" type="Variant" setter="" getter="get_collider_metadata">
|
|
|
+ The colliding body's metadata. See [Object].
|
|
|
</member>
|
|
|
<member name="collider_shape" type="Object" setter="" getter="get_collider_shape">
|
|
|
+ The colliding body's shape.
|
|
|
</member>
|
|
|
<member name="collider_shape_index" type="int" setter="" getter="get_collider_shape_index">
|
|
|
+ The colliding shape's index. See [CollisionObject].
|
|
|
</member>
|
|
|
<member name="collider_velocity" type="Vector3" setter="" getter="get_collider_velocity">
|
|
|
+ The colliding object's velocity.
|
|
|
</member>
|
|
|
<member name="local_shape" type="Object" setter="" getter="get_local_shape">
|
|
|
+ The moving object's colliding shape.
|
|
|
</member>
|
|
|
<member name="normal" type="Vector3" setter="" getter="get_normal">
|
|
|
+ The colliding body's shape's normal at the point of collision.
|
|
|
</member>
|
|
|
<member name="position" type="Vector3" setter="" getter="get_position">
|
|
|
+ The point of collision.
|
|
|
</member>
|
|
|
<member name="remainder" type="Vector3" setter="" getter="get_remainder">
|
|
|
+ The moving object's remaining movement vector.
|
|
|
</member>
|
|
|
<member name="travel" type="Vector3" setter="" getter="get_travel">
|
|
|
+ The distance the moving object traveled before collision.
|
|
|
</member>
|
|
|
</members>
|
|
|
<constants>
|
Rémi Verschelde