RayCast2D #

func add_exception(node: CollisionObject2D) -> void#

Adds a collision exception so the ray does not report collisions with the specified CollisionObject2D node.

func add_exception_rid(rid: RID) -> void#

Adds a collision exception so the ray does not report collisions with the specified RID.

func clear_exceptions() -> void#

Removes all collision exceptions for this ray.

func force_raycast_update() -> void#

Updates the collision information for the ray immediately, without waiting for the next _physics_process call. Use this method, for example, when the ray or its parent has changed state.

Note: enabled does not need to be true for this to work.

const func get_collider() -> Object#

Returns the first object that the ray intersects, or null if no object is intersecting the ray (i.e. is_colliding returns false).

const func get_collider_rid() -> RID#

Returns the RID of the first object that the ray intersects, or an empty RID if no object is intersecting the ray (i.e. is_colliding returns false).

const func get_collider_shape() -> int#

Returns the shape ID of the first object that the ray intersects, or 0 if no object is intersecting the ray (i.e. is_colliding returns false).

To get the intersected shape node, for a CollisionObject2D target, use:

GDScript

var target = get_collider() # A CollisionObject2D.
var shape_id = get_collider_shape() # The shape index in the collider.
var owner_id = target.shape_find_owner(shape_id) # The owner ID in the collider.
var shape = target.shape_owner_get_owner(owner_id)

C#

var target = (CollisionObject2D)GetCollider(); // A CollisionObject2D.
var shapeId = GetColliderShape(); // The shape index in the collider.
var ownerId = target.ShapeFindOwner(shapeId); // The owner ID in the collider.
var shape = target.ShapeOwnerGetOwner(ownerId);

const func get_collision_mask_value(layer_number: int) -> bool#

Returns whether or not the specified layer of the collision_mask is enabled, given a layer_number between 1 and 32.

const func get_collision_normal() -> Vector2#

Returns the normal of the intersecting object's shape at the collision point, or Vector2(0, 0) if the ray starts inside the shape and hit_from_inside is true.

Note: Check that is_colliding returns true before calling this method to ensure the returned normal is valid and up-to-date.

const func get_collision_point() -> Vector2#

Returns the collision point at which the ray intersects the closest object, in the global coordinate system. If hit_from_inside is true and the ray starts inside of a collision shape, this function will return the origin point of the ray.

Note: Check that is_colliding returns true before calling this method to ensure the returned point is valid and up-to-date.

const func is_colliding() -> bool#

Returns whether any object is intersecting with the ray's vector (considering the vector length).

func remove_exception(node: CollisionObject2D) -> void#

Removes a collision exception so the ray does report collisions with the specified CollisionObject2D node.

func remove_exception_rid(rid: RID) -> void#

Removes a collision exception so the ray does report collisions with the specified RID.

func set_collision_mask_value(value: bool) -> void#

Based on value, enables or disables the specified layer in the collision_mask, given a layer_number between 1 and 32.