Index · Object → RefCounted → KinematicCollision3D

KinematicCollision3D

Holds collision data from the movement of a PhysicsBody3D.

Class Description

Holds collision data from the movement of a PhysicsBody3D, usually from PhysicsBody3D.move_and_collide(). When a PhysicsBody3D is moved, it stops if it detects a collision with another body. If a collision is detected, a KinematicCollision3D 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(collision_index: int = 0, up_direction: Vector3 = Vector3(0, 1, 0)) -> float

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

func get_collider(collision_index: int = 0) -> Object

Returns the colliding body's attached Object given a collision index (the deepest collision by default).

func get_collider_id(collision_index: int = 0) -> int

Returns the unique instance ID of the colliding body's attached Object given a collision index (the deepest collision by default). See Object.get_instance_id().

func get_collider_rid(collision_index: int = 0) -> RID

Returns the colliding body's RID used by the PhysicsServer3D given a collision index (the deepest collision by default).

func get_collider_shape(collision_index: int = 0) -> Object

Returns the colliding body's shape given a collision index (the deepest collision by default).

func get_collider_shape_index(collision_index: int = 0) -> int

Returns the colliding body's shape index given a collision index (the deepest collision by default). See CollisionObject3D.

func get_collider_velocity(collision_index: int = 0) -> Vector3

Returns the colliding body's velocity given a collision index (the deepest collision by default).

func get_collision_count() -> int

Returns the number of detected collisions.

func get_depth() -> float

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

func get_local_shape(collision_index: int = 0) -> Object

Returns the moving object's colliding shape given a collision index (the deepest collision by default).

func get_normal(collision_index: int = 0) -> Vector3

Returns the colliding body's shape's normal at the point of collision given a collision index (the deepest collision by default).

func get_position(collision_index: int = 0) -> Vector3

Returns the point of collision in global coordinates given a collision index (the deepest collision by default).

func get_remainder() -> Vector3

Returns the moving object's remaining movement vector.

func get_travel() -> Vector3

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)