KinematicCollision2D
Category: Core
Brief Description
Collision data for KinematicBody2D collisions.
Properties
Object | collider |
int | collider_id |
Variant | collider_metadata |
Object | collider_shape |
int | collider_shape_index |
Vector2 | collider_velocity |
Object | local_shape |
Vector2 | normal |
Vector2 | position |
Vector2 | remainder |
Vector2 | travel |
Description
Contains collision data for KinematicBody2D collisions. When a KinematicBody2D is moved using 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.
Property Descriptions
- Object collider
Getter | get_collider() |
The colliding body.
- int collider_id
Getter | get_collider_id() |
The colliding body’s unique RID.
- Variant collider_metadata
Getter | get_collider_metadata() |
The colliding body’s metadata. See Object.
- Object collider_shape
Getter | get_collider_shape() |
The colliding body’s shape.
- int collider_shape_index
Getter | get_collider_shape_index() |
The colliding shape’s index. See CollisionObject2D.
- Vector2 collider_velocity
Getter | get_collider_velocity() |
The colliding object’s velocity.
- Object local_shape
Getter | get_local_shape() |
The moving object’s colliding shape.
- Vector2 normal
Getter | get_normal() |
The colliding body’s shape’s normal at the point of collision.
- Vector2 position
Getter | get_position() |
The point of collision.
- Vector2 remainder
Getter | get_remainder() |
The moving object’s remaining movement vector.
- Vector2 travel
Getter | get_travel() |
The distance the moving object traveled before collision.