Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165
							.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.

.. _class_RayCast2D:

RayCast2D
=========

**Inherits:** :ref:`Node2D<class_node2d>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------

Query the closest object intersecting a ray

Member Functions
----------------

+--------------------------------+-----------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_enabled<class_RayCast2D_set_enabled>`  **(** :ref:`bool<class_bool>` enabled  **)**             |
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`is_enabled<class_RayCast2D_is_enabled>`  **(** **)** const                                          |
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_cast_to<class_RayCast2D_set_cast_to>`  **(** :ref:`Vector2<class_vector2>` local_point  **)**   |
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`  | :ref:`get_cast_to<class_RayCast2D_get_cast_to>`  **(** **)** const                                        |
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`is_colliding<class_RayCast2D_is_colliding>`  **(** **)** const                                      |
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>`    | :ref:`get_collider<class_RayCast2D_get_collider>`  **(** **)** const                                      |
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_collider_shape<class_RayCast2D_get_collider_shape>`  **(** **)** const                          |
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`  | :ref:`get_collision_point<class_RayCast2D_get_collision_point>`  **(** **)** const                        |
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`  | :ref:`get_collision_normal<class_RayCast2D_get_collision_normal>`  **(** **)** const                      |
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
| void                           | :ref:`add_exception_rid<class_RayCast2D_add_exception_rid>`  **(** :ref:`RID<class_rid>` rid  **)**       |
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
| void                           | :ref:`add_exception<class_RayCast2D_add_exception>`  **(** :ref:`Object<class_object>` node  **)**        |
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
| void                           | :ref:`remove_exception_rid<class_RayCast2D_remove_exception_rid>`  **(** :ref:`RID<class_rid>` rid  **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
| void                           | :ref:`remove_exception<class_RayCast2D_remove_exception>`  **(** :ref:`Object<class_object>` node  **)**  |
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
| void                           | :ref:`clear_exceptions<class_RayCast2D_clear_exceptions>`  **(** **)**                                    |
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_layer_mask<class_RayCast2D_set_layer_mask>`  **(** :ref:`int<class_int>` mask  **)**            |
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_layer_mask<class_RayCast2D_get_layer_mask>`  **(** **)** const                                  |
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_type_mask<class_RayCast2D_set_type_mask>`  **(** :ref:`int<class_int>` mask  **)**              |
+--------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_type_mask<class_RayCast2D_get_type_mask>`  **(** **)** const                                    |
+--------------------------------+-----------------------------------------------------------------------------------------------------------+

Description
-----------

A RayCast2D represents a line from its origin to its destination position ``cast_to``, it is used to query the 2D space in order to find the closest object intersecting with the ray.

Member Function Description
---------------------------

.. _class_RayCast2D_set_enabled:

- void  **set_enabled**  **(** :ref:`bool<class_bool>` enabled  **)**

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

.. _class_RayCast2D_is_enabled:

- :ref:`bool<class_bool>`  **is_enabled**  **(** **)** const

Returns whether this raycast is enabled or not

.. _class_RayCast2D_set_cast_to:

- void  **set_cast_to**  **(** :ref:`Vector2<class_vector2>` local_point  **)**

Sets the ray destination point, so that the ray will test from the ray's origin to ``local_point``

.. _class_RayCast2D_get_cast_to:

- :ref:`Vector2<class_vector2>`  **get_cast_to**  **(** **)** const

Return the destination point of this ray object

.. _class_RayCast2D_is_colliding:

- :ref:`bool<class_bool>`  **is_colliding**  **(** **)** const

Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length).

.. _class_RayCast2D_get_collider:

- :ref:`Object<class_object>`  **get_collider**  **(** **)** const

Return the closest object the ray is pointing to. Note that this does not consider the length of the vector, so you must also use :ref:`is_colliding<class_RayCast2D_is_colliding>` to check if the object returned is actually colliding with the ray.

.. _class_RayCast2D_get_collider_shape:

- :ref:`int<class_int>`  **get_collider_shape**  **(** **)** const

Returns the collision shape of the closest object the ray is pointing to.

.. _class_RayCast2D_get_collision_point:

- :ref:`Vector2<class_vector2>`  **get_collision_point**  **(** **)** const

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

.. _class_RayCast2D_get_collision_normal:

- :ref:`Vector2<class_vector2>`  **get_collision_normal**  **(** **)** const

Returns the normal of the intersecting object shape face containing the collision point.

.. _class_RayCast2D_add_exception_rid:

- void  **add_exception_rid**  **(** :ref:`RID<class_rid>` rid  **)**

.. _class_RayCast2D_add_exception:

- void  **add_exception**  **(** :ref:`Object<class_object>` node  **)**

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

.. _class_RayCast2D_remove_exception_rid:

- void  **remove_exception_rid**  **(** :ref:`RID<class_rid>` rid  **)**

.. _class_RayCast2D_remove_exception:

- void  **remove_exception**  **(** :ref:`Object<class_object>` node  **)**

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

.. _class_RayCast2D_clear_exceptions:

- void  **clear_exceptions**  **(** **)**

Removes all collision exception for this ray.

.. _class_RayCast2D_set_layer_mask:

- void  **set_layer_mask**  **(** :ref:`int<class_int>` mask  **)**

.. _class_RayCast2D_get_layer_mask:

- :ref:`int<class_int>`  **get_layer_mask**  **(** **)** const

Returns the layer mask for this ray.

.. _class_RayCast2D_set_type_mask:

- void  **set_type_mask**  **(** :ref:`int<class_int>` mask  **)**

.. _class_RayCast2D_get_type_mask:

- :ref:`int<class_int>`  **get_type_mask**  **(** **)** const