mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
373 lines
16 KiB
ReStructuredText
373 lines
16 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/RayCast2D.xml.
|
|
|
|
.. _class_RayCast2D:
|
|
|
|
RayCast2D
|
|
=========
|
|
|
|
**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
Query the closest object intersecting a ray.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
A RayCast 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 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 :ref:`Area2D<class_Area2D>`\ s (:ref:`collide_with_areas<class_RayCast2D_property_collide_with_areas>`) and/or :ref:`PhysicsBody2D<class_PhysicsBody2D>`\ s (:ref:`collide_with_bodies<class_RayCast2D_property_collide_with_bodies>`).
|
|
|
|
Only enabled raycasts will be able to query the space and report collisions.
|
|
|
|
RayCast2D 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_RayCast2D_method_force_raycast_update>` after adjusting the raycast.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`../tutorials/physics/ray-casting`
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-------------------------------+--------------------------------------------------------------------------+----------------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`cast_to<class_RayCast2D_property_cast_to>` | ``Vector2( 0, 50 )`` |
|
|
+-------------------------------+--------------------------------------------------------------------------+----------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`collide_with_areas<class_RayCast2D_property_collide_with_areas>` | ``false`` |
|
|
+-------------------------------+--------------------------------------------------------------------------+----------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`collide_with_bodies<class_RayCast2D_property_collide_with_bodies>` | ``true`` |
|
|
+-------------------------------+--------------------------------------------------------------------------+----------------------+
|
|
| :ref:`int<class_int>` | :ref:`collision_mask<class_RayCast2D_property_collision_mask>` | ``1`` |
|
|
+-------------------------------+--------------------------------------------------------------------------+----------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`enabled<class_RayCast2D_property_enabled>` | ``false`` |
|
|
+-------------------------------+--------------------------------------------------------------------------+----------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`exclude_parent<class_RayCast2D_property_exclude_parent>` | ``true`` |
|
|
+-------------------------------+--------------------------------------------------------------------------+----------------------+
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Methods
|
|
-------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`add_exception<class_RayCast2D_method_add_exception>` **(** :ref:`Object<class_Object>` node **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`add_exception_rid<class_RayCast2D_method_add_exception_rid>` **(** :ref:`RID<class_RID>` rid **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`clear_exceptions<class_RayCast2D_method_clear_exceptions>` **(** **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`force_raycast_update<class_RayCast2D_method_force_raycast_update>` **(** **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Object<class_Object>` | :ref:`get_collider<class_RayCast2D_method_get_collider>` **(** **)** |const| |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_collider_shape<class_RayCast2D_method_get_collider_shape>` **(** **)** |const| |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_RayCast2D_method_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** |const| |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`get_collision_normal<class_RayCast2D_method_get_collision_normal>` **(** **)** |const| |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`get_collision_point<class_RayCast2D_method_get_collision_point>` **(** **)** |const| |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_colliding<class_RayCast2D_method_is_colliding>` **(** **)** |const| |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`remove_exception<class_RayCast2D_method_remove_exception>` **(** :ref:`Object<class_Object>` node **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`remove_exception_rid<class_RayCast2D_method_remove_exception_rid>` **(** :ref:`RID<class_RID>` rid **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_collision_mask_bit<class_RayCast2D_method_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_RayCast2D_property_cast_to:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Vector2<class_Vector2>` **cast_to** = ``Vector2( 0, 50 )``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_cast_to** **(** :ref:`Vector2<class_Vector2>` value **)**
|
|
- :ref:`Vector2<class_Vector2>` **get_cast_to** **(** **)**
|
|
|
|
The ray's destination point, relative to the RayCast's ``position``.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RayCast2D_property_collide_with_areas:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **collide_with_areas** = ``false``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_collide_with_areas** **(** :ref:`bool<class_bool>` value **)**
|
|
- :ref:`bool<class_bool>` **is_collide_with_areas_enabled** **(** **)**
|
|
|
|
If ``true``, collision with :ref:`Area2D<class_Area2D>`\ s will be reported.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RayCast2D_property_collide_with_bodies:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **collide_with_bodies** = ``true``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_collide_with_bodies** **(** :ref:`bool<class_bool>` value **)**
|
|
- :ref:`bool<class_bool>` **is_collide_with_bodies_enabled** **(** **)**
|
|
|
|
If ``true``, collision with :ref:`PhysicsBody2D<class_PhysicsBody2D>`\ s will be reported.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RayCast2D_property_collision_mask:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **collision_mask** = ``1``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_collision_mask** **(** :ref:`int<class_int>` value **)**
|
|
- :ref:`int<class_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 <../tutorials/physics/physics_introduction.html#collision-layers-and-masks>`__ in the documentation for more information.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RayCast2D_property_enabled:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **enabled** = ``false``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_enabled** **(** :ref:`bool<class_bool>` value **)**
|
|
- :ref:`bool<class_bool>` **is_enabled** **(** **)**
|
|
|
|
If ``true``, collisions will be reported.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RayCast2D_property_exclude_parent:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **exclude_parent** = ``true``
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- void **set_exclude_parent_body** **(** :ref:`bool<class_bool>` value **)**
|
|
- :ref:`bool<class_bool>` **get_exclude_parent_body** **(** **)**
|
|
|
|
If ``true``, the parent node will be excluded from collision detection.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_RayCast2D_method_add_exception:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
void **add_exception** **(** :ref:`Object<class_Object>` node **)**
|
|
|
|
Adds a collision exception so the ray does not report collisions with the specified node.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RayCast2D_method_add_exception_rid:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
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>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RayCast2D_method_clear_exceptions:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
void **clear_exceptions** **(** **)**
|
|
|
|
Removes all collision exceptions for this ray.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RayCast2D_method_force_raycast_update:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
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`` is not required for this to work.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RayCast2D_method_get_collider:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
: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_RayCast2D_method_is_colliding>` returns ``false``).
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RayCast2D_method_get_collider_shape:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
: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_RayCast2D_method_is_colliding>` returns ``false``).
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RayCast2D_method_get_collision_mask_bit:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** |const|
|
|
|
|
Returns an individual bit on the collision mask.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RayCast2D_method_get_collision_normal:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`Vector2<class_Vector2>` **get_collision_normal** **(** **)** |const|
|
|
|
|
Returns the normal of the intersecting object's shape at the collision point.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RayCast2D_method_get_collision_point:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`Vector2<class_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.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RayCast2D_method_is_colliding:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`bool<class_bool>` **is_colliding** **(** **)** |const|
|
|
|
|
Returns whether any object is intersecting with the ray's vector (considering the vector length).
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RayCast2D_method_remove_exception:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
void **remove_exception** **(** :ref:`Object<class_Object>` node **)**
|
|
|
|
Removes a collision exception so the ray does report collisions with the specified node.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RayCast2D_method_remove_exception_rid:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
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>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_RayCast2D_method_set_collision_mask_bit:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
|
|
|
|
Sets or clears individual bits on the collision mask. This makes selecting the areas scanned easier.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|