RayCast2D

Inherits: Node2D < CanvasItem < Node < Object Query the closest object intersecting a ray.

Description

cast_to. It is used to query the 2D space in order to find the closest object along the path of the ray. add_exception, by setting proper filtering with collision layers, or by filtering object types with type masks. Area2Ds (collide_with_areas) and/or PhysicsBody2Ds (collide_with_bodies). Only enabled raycasts will be able to query the space and report collisions. Node), 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.

Tutorials

  • Ray-casting

    Properties

    Methods

    Property Descriptions

  • Vector2 cast_to position.
  • bool collide_with_areas true, collision with Area2Ds will be reported.
  • bool collide_with_bodies true, collision with PhysicsBody2Ds will be reported.
  • int collision_mask Collision layers and masks in the documentation for more information.
  • bool enabled true, collisions will be reported.
  • bool exclude_parent true, the parent node will be excluded from collision detection.

    Method Descriptions

  • add_exception ( Object node ) Adds a collision exception so the ray does not report collisions with the specified node.
  • add_exception_rid ( RID rid ) RID.
  • clear_exceptions ( ) Removes all collision exceptions for this ray.
  • force_raycast_update ( ) _physics_process call, for example if the ray or its parent has changed state. Note: enabled is not required for this to work.
  • Object get_collider ( ) const null if no object is intersecting the ray (i.e. is_colliding returns false).
  • int get_collider_shape ( ) const 0 if no object is intersecting the ray (i.e. is_colliding returns false).
  • bool get_collision_mask_bit ( int bit ) const Returns an individual bit on the collision mask.
  • Vector2 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.
  • bool is_colliding ( ) const Returns whether any object is intersecting with the ray’s vector (considering the vector length).
  • remove_exception ( Object node ) Removes a collision exception so the ray does report collisions with the specified node.
  • remove_exception_rid ( RID rid ) RID.
  • set_collision_mask_bit ( int bit, bool value ) Sets or clears individual bits on the collision mask. This makes selecting the areas scanned easier.