| github_url: | hide |
|---|
Inherits: :ref:`Spatial<class_Spatial>` < :ref:`Node<class_Node>` < :ref:`Object<class_Object>`
Query the closest object intersecting a ray.
A RayCast represents a line from its origin to its destination position, cast_to. It is used to query the 3D space in order to find the closest object along the path of the ray.
RayCast can ignore some objects by adding them to the exception list via add_exception or by setting proper filtering with collision layers and masks.
RayCast can be configured to report collisions with :ref:`Area<class_Area>`s (:ref:`collide_with_areas<class_RayCast_property_collide_with_areas>`) and/or :ref:`PhysicsBody<class_PhysicsBody>`s (:ref:`collide_with_bodies<class_RayCast_property_collide_with_bodies>`).
Only enabled raycasts will be able to query the space and report collisions.
RayCast calculates intersection every physics frame (see :ref:`Node<class_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 :ref:`force_raycast_update<class_RayCast_method_force_raycast_update>` after adjusting the raycast.
- :ref:`Vector3<class_Vector3>` cast_to
| Default | Vector3( 0, -1, 0 ) |
| Setter | set_cast_to(value) |
| Getter | get_cast_to() |
The ray's destination point, relative to the RayCast's position.
- :ref:`bool<class_bool>` collide_with_areas
| Default | false |
| Setter | set_collide_with_areas(value) |
| Getter | is_collide_with_areas_enabled() |
If true, collision with :ref:`Area<class_Area>`s will be reported.
- :ref:`bool<class_bool>` collide_with_bodies
| Default | true |
| Setter | set_collide_with_bodies(value) |
| Getter | is_collide_with_bodies_enabled() |
If true, collision with :ref:`PhysicsBody<class_PhysicsBody>`s will be reported.
- :ref:`int<class_int>` collision_mask
| Default | 1 |
| 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.
- :ref:`bool<class_bool>` enabled
| Default | false |
| Setter | set_enabled(value) |
| Getter | is_enabled() |
If true, collisions will be reported.
- :ref:`bool<class_bool>` exclude_parent
| Default | true |
| Setter | set_exclude_parent_body(value) |
| Getter | get_exclude_parent_body() |
If true, collisions will be ignored for this RayCast's immediate parent.
- void add_exception ( :ref:`Object<class_Object>` node )
Adds a collision exception so the ray does not report collisions with the specified node.
- void add_exception_rid ( :ref:`RID<class_RID>` rid )
Adds a collision exception so the ray does not report collisions with the specified :ref:`RID<class_RID>`.
- void clear_exceptions ( )
Removes all collision exceptions for this ray.
- void force_raycast_update ( )
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.
- :ref:`Object<class_Object>` get_collider ( ) const
Returns the first object that the ray intersects, or null if no object is intersecting the ray (i.e. :ref:`is_colliding<class_RayCast_method_is_colliding>` returns false).
- :ref:`int<class_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. :ref:`is_colliding<class_RayCast_method_is_colliding>` returns false).
- :ref:`bool<class_bool>` get_collision_mask_bit ( :ref:`int<class_int>` bit ) const
Returns true if the bit index passed is turned on.
Note: Bit indices range from 0-19.
- :ref:`Vector3<class_Vector3>` get_collision_normal ( ) const
Returns the normal of the intersecting object's shape at the collision point.
- :ref:`Vector3<class_Vector3>` 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.
- :ref:`bool<class_bool>` is_colliding ( ) const
Returns whether any object is intersecting with the ray's vector (considering the vector length).
- void remove_exception ( :ref:`Object<class_Object>` node )
Removes a collision exception so the ray does report collisions with the specified node.
- void remove_exception_rid ( :ref:`RID<class_RID>` rid )
Removes a collision exception so the ray does report collisions with the specified :ref:`RID<class_RID>`.
- void set_collision_mask_bit ( :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value )
Sets the bit index passed to the value passed.
Note: Bit indexes range from 0-19.