KinematicCollision2D

Inherits: Reference < Object KinematicBody2D collisions.

Description

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.

Properties

Methods

Property Descriptions

  • Object collider The colliding body.
  • int collider_id Object.get_instance_id.
  • Variant collider_metadata Object.
  • RID collider_rid RID used by the Physics2DServer.
  • Object collider_shape The colliding body’s shape.
  • int collider_shape_index CollisionObject2D.
  • Vector2 collider_velocity The colliding object’s velocity.
  • Object local_shape The moving object’s colliding shape.
  • Vector2 normal The colliding body’s shape’s normal at the point of collision.
  • Vector2 position The point of collision, in global coordinates.
  • Vector2 remainder The moving object’s remaining movement vector.
  • Vector2 travel The distance the moving object traveled before collision.

    Method Descriptions

  • float get_angle ( Vector2 up_direction=Vector2( 0, -1 ) ) const up_direction, which is Vector2.UP by default. This value is always positive.