KinematicCollision2D

继承: RefCounted < Object

Holds collision data from the movement of a PhysicsBody2D.

描述

Holds collision data from the movement of a PhysicsBody2D, usually from PhysicsBody2D.move_and_collide. When a PhysicsBody2D is moved, it stops if it detects a collision with another body. If a collision is detected, a KinematicCollision2D object is returned.

The collision data includes the colliding object, the remaining motion, and the collision position. This data can be used to determine a custom response to the collision.

方法


方法说明

float get_angle ( up_direction: Vector2 = Vector2(0, -1) ) const1

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


Object get_collider ( ) const1

Returns the colliding body's attached Object.


int get_collider_id ( ) const1

Returns the unique instance ID of the colliding body's attached Object. See Object.get_instance_id.


RID get_collider_rid ( ) const1

Returns the colliding body's RID used by the PhysicsServer2D.


Object get_collider_shape ( ) const1

Returns the colliding body's shape.


int get_collider_shape_index ( ) const1

Returns the colliding body's shape index. See CollisionObject2D.


Vector2 get_collider_velocity ( ) const1

Returns the colliding body's velocity.


float get_depth ( ) const1

Returns the colliding body's length of overlap along the collision normal.


Object get_local_shape ( ) const1

Returns the moving object's colliding shape.


Vector2 get_normal ( ) const1

Returns the colliding body's shape's normal at the point of collision.


Vector2 get_position ( ) const1

Returns the point of collision in global coordinates.


Vector2 get_remainder ( ) const1

Returns the moving object's remaining movement vector.


Vector2 get_travel ( ) const1

Returns the moving object's travel before collision.

2

本方法通常需要用户覆盖才能生效。

1

本方法无副作用,不会修改该实例的任何成员变量。

3

本方法除了能接受在此处描述的参数外,还能够继续接受任意数量的参数。

4

本方法用于构造某个类型。

5

调用本方法无需实例,可直接使用类名进行调用。

6

本方法描述的是使用本类型作为左操作数的有效运算符。

7

这个值是由下列位标志构成位掩码的整数。

8

无返回值。