Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

RayCast2D

Inherits: Node2D < CanvasItem < Node < Object

A ray in 2D space, used to find the first CollisionObject2D it intersects.

Description

A raycast represents a ray from its origin to its target_position that finds the closest CollisionObject2D along its path, if it intersects any. This is useful for a lot of things, such as

RayCast2D can ignore some objects by adding them to an exception list, by making its detection reporting ignore Area2Ds (collide_with_areas) or PhysicsBody2Ds (collide_with_bodies), or by configuring physics layers.

RayCast2D calculates intersection every physics frame, and it holds the result until the next physics frame. For an immediate raycast, or if you want to configure a RayCast2D multiple times within the same physics frame, use force_raycast_update.

To sweep over a region of 2D space, you can approximate the region with multiple RayCast2Ds or use ShapeCast2D.

Tutorials

Properties

bool

collide_with_areas

false

bool

collide_with_bodies

true

int

collision_mask

1

bool

enabled

true

bool

exclude_parent

true

bool

hit_from_inside

false

Vector2

target_position

Vector2(0, 50)

Methods

void

add_exception ( CollisionObject2D node )

void

add_exception_rid ( RID rid )

void

clear_exceptions ( )

void

force_raycast_update ( )

Object

get_collider ( ) const

RID

get_collider_rid ( ) const

int

get_collider_shape ( ) const

bool

get_collision_mask_value ( int layer_number ) const

Vector2

get_collision_normal ( ) const

Vector2

get_collision_point ( ) const

bool

is_colliding ( ) const

void

remove_exception ( CollisionObject2D node )

void

remove_exception_rid ( RID rid )

void

set_collision_mask_value ( int layer_number, bool value )

Property Descriptions

bool collide_with_areas = false

  • void set_collide_with_areas ( bool value )

  • bool is_collide_with_areas_enabled ( )

If true, collisions with Area2Ds will be reported.

bool collide_with_bodies = true

  • void set_collide_with_bodies ( bool value )

  • bool is_collide_with_bodies_enabled ( )

If true, collisions with PhysicsBody2Ds will be reported.

int collision_mask = 1

  • void set_collision_mask ( int value )

  • int get_collision_mask ( )

The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. See Collision layers and masks in the documentation for more information.

bool enabled = true

  • void set_enabled ( bool value )

  • bool is_enabled ( )

If true, collisions will be reported.

bool exclude_parent = true

  • void set_exclude_parent_body ( bool value )

  • bool get_exclude_parent_body ( )

If true, the parent node will be excluded from collision detection.

bool hit_from_inside = false

  • void set_hit_from_inside ( bool value )

  • bool is_hit_from_inside_enabled ( )

If true, the ray will detect a hit when starting inside shapes. In this case the collision normal will be Vector2(0, 0). Does not affect concave polygon shapes.

Vector2 target_position = Vector2(0, 50)

  • void set_target_position ( Vector2 value )

  • Vector2 get_target_position ( )

The ray's destination point, relative to the RayCast's position.

Method Descriptions

void add_exception ( CollisionObject2D node )

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

void add_exception_rid ( RID rid )

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

void clear_exceptions ( )

Removes all collision exceptions for this ray.

void force_raycast_update ( )

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.

Object get_collider ( ) const

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

RID get_collider_rid ( ) const

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).

int get_collider_shape ( ) const

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).

bool get_collision_mask_value ( int layer_number ) const

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

Vector2 get_collision_normal ( ) const

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.

Vector2 get_collision_point ( ) const

Returns the collision point at which the ray intersects the closest object.

Note: This point is in the global coordinate system.

bool is_colliding ( )