Index · Object → RefCounted → KinematicCollision2D

KinematicCollision2D

Holds collision data from the movement of a PhysicsBody2D.

Class Description

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.

Methods

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

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

func get_collider() -> Object

Returns the colliding body's attached Object.

func get_collider_id() -> int

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

func get_collider_rid() -> RID

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

func get_collider_shape() -> Object

Returns the colliding body's shape.

func get_collider_shape_index() -> int

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

func get_collider_velocity() -> Vector2

Returns the colliding body's velocity.

func get_depth() -> float

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

func get_local_shape() -> Object

Returns the moving object's colliding shape.

func get_normal() -> Vector2

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

func get_position() -> Vector2

Returns the point of collision in global coordinates.

func get_remainder() -> Vector2

Returns the moving object's remaining movement vector.

func get_travel() -> Vector2

Returns the moving object's travel before collision.

Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Object (2)