KinematicCollision2D

Inherits: Reference < Object

Collision data for KinematicBody2D collisions.

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.

Methods

float

get_angle ( Vector2 up_direction=Vector2( 0, -1 ) ) const

Property Descriptions

Getter

get_collider()

The colliding body.


  • int collider_id

Default

0

Getter

get_collider_id()

The colliding body's unique instance ID. See Object.get_instance_id.


Getter

get_collider_metadata()

The colliding body's metadata. See Object.


  • RID collider_rid

Getter

get_collider_rid()

The colliding body's RID used by the Physics2DServer.


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, in global coordinates.


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.

Method Descriptions

  • float get_angle ( Vector2 up_direction=Vector2( 0, -1 ) ) const

The collision angle according to up_direction, which is Vector2.UP by default. This value is always positive.