RayCast2D

Category: Core

Query the closest object intersecting a ray.

Properties

void	( Object node )
void	( RID rid )
void	( )
void	force_raycast_update ( )
	get_collider ( ) const
	get_collider_shape ( ) const
	get_collision_mask_bit ( bit ) const
Vector2	( ) const
Vector2	( ) const
bool	( ) const
void	remove_exception ( node )
void	remove_exception_rid ( rid )
void	set_collision_mask_bit ( bit, bool value )

Description

A RayCast represents a line from its origin to its destination position, . It is used to query the 2D space in order to find the closest object along the path of the ray.

RayCast2D can ignore some objects by adding them to the exception list via add_exception, by setting proper filtering with collision layers, or by filtering object types with type masks.

RayCast2D can be configured to report collisions with s (collide_with_areas) and/or s (collide_with_bodies).

Only enabled raycasts will be able to query the space and report collisions.

RayCast2D calculates intersection every physics frame (see ), and the result is cached so it can be used later until the next frame. If multiple queries are required between physics frames (or during the same frame) use force_raycast_update after adjusting the raycast.

cast_to

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

Setter	set_collide_with_areas(value)
Getter	is_collide_with_areas_enabled()

bool collide_with_bodies

If , collision with s will be reported. Default value: true.

int collision_mask

Setter	set_collision_mask(value)
Getter	get_collision_mask()

The ray’s collision mask. Only objects in at least one collision layer enabled in the mask will be detected.

enabled

If true, collisions will be reported. Default value: false.

bool exclude_parent

Setter	set_exclude_parent_body(value)
Getter	get_exclude_parent_body()

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

Method Descriptions

void add_exception ( node )

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

void add_exception_rid ( RID rid )

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

void clear_exceptions ( )

Removes all collision exceptions for this ray.

Updates the collision information for the ray. Use this method to update the collision information immediately instead of waiting for the next _physics_process call, for example if the ray or its parent has changed state. Note: enabled == true is not required for this to work.

Object get_collider ( ) const

get_collider_shape ( ) const

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

get_collision_mask_bit ( int bit ) const

Returns an individual bit on the collision mask.

get_collision_normal ( ) const

Returns the normal of the intersecting object’s shape at the collision point.

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.

is_colliding ( ) const

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

void remove_exception ( Object node )

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

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

void set_collision_mask_bit ( int bit, value )

Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier.