KinematicCollision2D

Inherits: Reference < Object

Category: Core

Brief Description

Collision data for KinematicBody2D collisions.

Properties

Object collider  
int collider_id 0
Variant collider_metadata  
Object collider_shape  
int collider_shape_index 0
Vector2 collider_velocity Vector2( 0, 0 )
Object local_shape  
Vector2 normal Vector2( 0, 0 )
Vector2 position Vector2( 0, 0 )
Vector2 remainder Vector2( 0, 0 )
Vector2 travel Vector2( 0, 0 )

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

Getter get_collider()

The colliding body.

  • int collider_id
Default 0
Getter get_collider_id()

The colliding body’s unique RID.

Getter get_collider_metadata()

The colliding body’s metadata. See Object.

Getter get_collider_shape()

The colliding body’s shape.

  • int collider_shape_index
Default 0
Getter get_collider_shape_index()

The colliding shape’s index. See CollisionObject2D.

Default Vector2( 0, 0 )
Getter get_collider_velocity()

The colliding object’s velocity.

Getter get_local_shape()

The moving object’s colliding shape.

Default Vector2( 0, 0 )
Getter get_normal()

The colliding body’s shape’s normal at the point of collision.

Default Vector2( 0, 0 )
Getter get_position()

The point of collision.

Default Vector2( 0, 0 )
Getter get_remainder()

The moving object’s remaining movement vector.

Default Vector2( 0, 0 )
Getter get_travel()

The distance the moving object traveled before collision.