godot-docs/classes/class_shapecast2d.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ShapeCast2D.xml.

.. _class_ShapeCast2D:

ShapeCast2D
===========

**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

Node for physics collision sweep and immediate overlap queries. Similar to the :ref:`RayCast2D<class_RayCast2D>` node.

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

Shape casting allows to detect collision objects by sweeping the :ref:`shape<class_ShapeCast2D_property_shape>` along the cast direction determined by :ref:`target_position<class_ShapeCast2D_property_target_position>` (useful for things like beam weapons).

Immediate collision overlaps can be done with the :ref:`target_position<class_ShapeCast2D_property_target_position>` set to ``Vector2(0, 0)`` and by calling :ref:`force_shapecast_update<class_ShapeCast2D_method_force_shapecast_update>` within the same **physics_frame**. This also helps to overcome some limitations of :ref:`Area2D<class_Area2D>` when used as a continuous detection area, often requiring waiting a couple of frames before collision information is available to :ref:`Area2D<class_Area2D>` nodes, and when using the signals creates unnecessary complexity.

The node can detect multiple collision objects, but usually the first detected collision

\ **Note:** shape casting is more computationally expensive compared to ray casting.

Properties
----------

+-------------------------------+----------------------------------------------------------------------------+--------------------+
| :ref:`bool<class_bool>`       | :ref:`collide_with_areas<class_ShapeCast2D_property_collide_with_areas>`   | ``false``          |
+-------------------------------+----------------------------------------------------------------------------+--------------------+
| :ref:`bool<class_bool>`       | :ref:`collide_with_bodies<class_ShapeCast2D_property_collide_with_bodies>` | ``true``           |
+-------------------------------+----------------------------------------------------------------------------+--------------------+
| :ref:`int<class_int>`         | :ref:`collision_mask<class_ShapeCast2D_property_collision_mask>`           | ``1``              |
+-------------------------------+----------------------------------------------------------------------------+--------------------+
| :ref:`Array<class_Array>`     | :ref:`collision_result<class_ShapeCast2D_property_collision_result>`       | ``[]``             |
+-------------------------------+----------------------------------------------------------------------------+--------------------+
| :ref:`bool<class_bool>`       | :ref:`enabled<class_ShapeCast2D_property_enabled>`                         | ``true``           |
+-------------------------------+----------------------------------------------------------------------------+--------------------+
| :ref:`bool<class_bool>`       | :ref:`exclude_parent<class_ShapeCast2D_property_exclude_parent>`           | ``true``           |
+-------------------------------+----------------------------------------------------------------------------+--------------------+
| :ref:`float<class_float>`     | :ref:`margin<class_ShapeCast2D_property_margin>`                           | ``0.0``            |
+-------------------------------+----------------------------------------------------------------------------+--------------------+
| :ref:`int<class_int>`         | :ref:`max_results<class_ShapeCast2D_property_max_results>`                 | ``32``             |
+-------------------------------+----------------------------------------------------------------------------+--------------------+
| :ref:`Shape2D<class_Shape2D>` | :ref:`shape<class_ShapeCast2D_property_shape>`                             |                    |
+-------------------------------+----------------------------------------------------------------------------+--------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`target_position<class_ShapeCast2D_property_target_position>`         | ``Vector2(0, 50)`` |
+-------------------------------+----------------------------------------------------------------------------+--------------------+

Methods
-------

+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                          | :ref:`add_exception<class_ShapeCast2D_method_add_exception>` **(** :ref:`CollisionObject2D<class_CollisionObject2D>` node **)**                                  |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                          | :ref:`add_exception_rid<class_ShapeCast2D_method_add_exception_rid>` **(** :ref:`RID<class_RID>` rid **)**                                                       |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                          | :ref:`clear_exceptions<class_ShapeCast2D_method_clear_exceptions>` **(** **)**                                                                                   |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                          | :ref:`force_shapecast_update<class_ShapeCast2D_method_force_shapecast_update>` **(** **)**                                                                       |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`     | :ref:`get_closest_collision_safe_fraction<class_ShapeCast2D_method_get_closest_collision_safe_fraction>` **(** **)** |const|                                     |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`     | :ref:`get_closest_collision_unsafe_fraction<class_ShapeCast2D_method_get_closest_collision_unsafe_fraction>` **(** **)** |const|                                 |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_Object>`   | :ref:`get_collider<class_ShapeCast2D_method_get_collider>` **(** :ref:`int<class_int>` index **)** |const|                                                       |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`         | :ref:`get_collider_shape<class_ShapeCast2D_method_get_collider_shape>` **(** :ref:`int<class_int>` index **)** |const|                                           |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`         | :ref:`get_collision_count<class_ShapeCast2D_method_get_collision_count>` **(** **)** |const|                                                                     |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`       | :ref:`get_collision_mask_value<class_ShapeCast2D_method_get_collision_mask_value>` **(** :ref:`int<class_int>` layer_number **)** |const|                        |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_collision_normal<class_ShapeCast2D_method_get_collision_normal>` **(** :ref:`int<class_int>` index **)** |const|                                       |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_collision_point<class_ShapeCast2D_method_get_collision_point>` **(** :ref:`int<class_int>` index **)** |const|                                         |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`       | :ref:`is_colliding<class_ShapeCast2D_method_is_colliding>` **(** **)** |const|                                                                                   |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                          | :ref:`remove_exception<class_ShapeCast2D_method_remove_exception>` **(** :ref:`CollisionObject2D<class_CollisionObject2D>` node **)**                            |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                          | :ref:`remove_exception_rid<class_ShapeCast2D_method_remove_exception_rid>` **(** :ref:`RID<class_RID>` rid **)**                                                 |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                          | :ref:`set_collision_mask_value<class_ShapeCast2D_method_set_collision_mask_value>` **(** :ref:`int<class_int>` layer_number, :ref:`bool<class_bool>` value **)** |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Property Descriptions
---------------------

.. _class_ShapeCast2D_property_collide_with_areas:

- :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:`Area2D<class_Area2D>`\ s will be reported.

----

.. _class_ShapeCast2D_property_collide_with_bodies:

- :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:`PhysicsBody2D<class_PhysicsBody2D>`\ s will be reported.

----

.. _class_ShapeCast2D_property_collision_mask:

- :ref:`int<class_int>` **collision_mask**

+-----------+---------------------------+
| *Default* | ``1``                     |
+-----------+---------------------------+
| *Setter*  | set_collision_mask(value) |
+-----------+---------------------------+
| *Getter*  | get_collision_mask()      |
+-----------+---------------------------+

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

----

.. _class_ShapeCast2D_property_collision_result:

- :ref:`Array<class_Array>` **collision_result**

+-----------+--------+
| *Default* | ``[]`` |
+-----------+--------+

A complete collision information. The data returned is the same as in the :ref:`PhysicsDirectSpaceState2D.get_rest_info<class_PhysicsDirectSpaceState2D_method_get_rest_info>` method.

----

.. _class_ShapeCast2D_property_enabled:

- :ref:`bool<class_bool>` **enabled**

+-----------+--------------------+
| *Default* | ``true``           |
+-----------+--------------------+
| *Setter*  | set_enabled(value) |
+-----------+--------------------+
| *Getter*  | is_enabled()       |
+-----------+--------------------+

If ``true``, collisions will be reported.

----

.. _class_ShapeCast2D_property_exclude_parent:

- :ref:`bool<class_bool>` **exclude_parent**

+-----------+--------------------------------+
| *Default* | ``true``                       |
+-----------+--------------------------------+
| *Setter*  | set_exclude_parent_body(value) |
+-----------+--------------------------------+
| *Getter*  | get_exclude_parent_body()      |
+-----------+--------------------------------+

If ``true``, the parent node will be excluded from collision detection.

----

.. _class_ShapeCast2D_property_margin:

- :ref:`float<class_float>` **margin**

+-----------+-------------------+
| *Default* | ``0.0``           |
+-----------+-------------------+
| *Setter*  | set_margin(value) |
+-----------+-------------------+
| *Getter*  | get_margin()      |
+-----------+-------------------+

The collision margin for the shape. A larger margin helps detecting collisions more consistently, at the cost of precision.

----

.. _class_ShapeCast2D_property_max_results:

- :ref:`int<class_int>` **max_results**

+-----------+------------------------+
| *Default* | ``32``                 |
+-----------+------------------------+
| *Setter*  | set_max_results(value) |
+-----------+------------------------+
| *Getter*  | get_max_results()      |
+-----------+------------------------+

The number of intersections can be limited with this parameter, to reduce the processing time.

----

.. _class_ShapeCast2D_property_shape:

- :ref:`Shape2D<class_Shape2D>` **shape**

+----------+------------------+
| *Setter* | set_shape(value) |
+----------+------------------+
| *Getter* | get_shape()      |
+----------+------------------+

Any :ref:`Shape2D<class_Shape2D>` derived shape used for collision queries.

----

.. _class_ShapeCast2D_property_target_position:

- :ref:`Vector2<class_Vector2>` **target_position**

+-----------+----------------------------+
| *Default* | ``Vector2(0, 50)``         |
+-----------+----------------------------+
| *Setter*  | set_target_position(value) |
+-----------+----------------------------+
| *Getter*  | get_target_position()      |
+-----------+----------------------------+

The shape's destination point, relative to this node's ``position``.

Method Descriptions
-------------------

.. _class_ShapeCast2D_method_add_exception:

- void **add_exception** **(** :ref:`CollisionObject2D<class_CollisionObject2D>` node **)**

Adds a collision exception so the shape does not report collisions with the specified :ref:`CollisionObject2D<class_CollisionObject2D>` node.

----

.. _class_ShapeCast2D_method_add_exception_rid:

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

Adds a collision exception so the shape does not report collisions with the specified :ref:`RID<class_RID>`.

----

.. _class_ShapeCast2D_method_clear_exceptions:

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

Removes all collision exceptions for this shape.

----

.. _class_ShapeCast2D_method_force_shapecast_update:

- void **force_shapecast_update** **(** **)**

Updates the collision information for the shape. Use this method to update the collision information immediately instead of waiting for the next ``_physics_process`` call, for example if the shape or its parent has changed state.

\ **Note:** ``enabled == true`` is not required for this to work.

----

.. _class_ShapeCast2D_method_get_closest_collision_safe_fraction:

- :ref:`float<class_float>` **get_closest_collision_safe_fraction** **(** **)** |const|

The fraction of the motion (between 0 and 1) of how far the shape can move without triggering a collision. The motion is determined by :ref:`target_position<class_ShapeCast2D_property_target_position>`.

----

.. _class_ShapeCast2D_method_get_closest_collision_unsafe_fraction:

- :ref:`float<class_float>` **get_closest_collision_unsafe_fraction** **(** **)** |const|

The fraction of the motion (between 0 and 1) when the shape triggers a collision. The motion is determined by :ref:`target_position<class_ShapeCast2D_property_target_position>`.

----

.. _class_ShapeCast2D_method_get_collider:

- :ref:`Object<class_Object>` **get_collider** **(** :ref:`int<class_int>` index **)** |const|

Returns the :ref:`Object<class_Object>` of one of the multiple collisions at ``index``, or ``null`` if no object is intersecting the shape (i.e. :ref:`is_colliding<class_ShapeCast2D_method_is_colliding>` returns ``false``).

----

.. _class_ShapeCast2D_method_get_collider_shape:

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

Returns the shape ID of one of the multiple collisions at ``index`` that the shape intersects, or ``0`` if no object is intersecting the shape (i.e. :ref:`is_colliding<class_ShapeCast2D_method_is_colliding>` returns ``false``).

----

.. _class_ShapeCast2D_method_get_collision_count:

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

The number of collisions detected at the point of impact. Use this to iterate over multiple collisions as provided by :ref:`get_collider<class_ShapeCast2D_method_get_collider>`, :ref:`get_collider_shape<class_ShapeCast2D_method_get_collider_shape>`, :ref:`get_collision_point<class_ShapeCast2D_method_get_collision_point>`, and :ref:`get_collision_normal<class_ShapeCast2D_method_get_collision_normal>` methods.

----

.. _class_ShapeCast2D_method_get_collision_mask_value:

- :ref:`bool<class_bool>` **get_collision_mask_value** **(** :ref:`int<class_int>` layer_number **)** |const|

Returns whether or not the specified layer of the :ref:`collision_mask<class_ShapeCast2D_property_collision_mask>` is enabled, given a ``layer_number`` between 1 and 32.

----

.. _class_ShapeCast2D_method_get_collision_normal:

- :ref:`Vector2<class_Vector2>` **get_collision_normal** **(** :ref:`int<class_int>` index **)** |const|

Returns the normal containing one of the multiple collisions at ``index`` of the intersecting object.

----

.. _class_ShapeCast2D_method_get_collision_point:

- :ref:`Vector2<class_Vector2>` **get_collision_point** **(** :ref:`int<class_int>` index **)** |const|

Returns the collision point containing one of the multiple collisions at ``index`` at which the shape intersects the object.

\ **Note:** this point is in the **global** coordinate system.

----

.. _class_ShapeCast2D_method_is_colliding:

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

Returns whether any object is intersecting with the shape's vector (considering the vector length).

----

.. _class_ShapeCast2D_method_remove_exception:

- void **remove_exception** **(** :ref:`CollisionObject2D<class_CollisionObject2D>` node **)**

Removes a collision exception so the shape does report collisions with the specified :ref:`CollisionObject2D<class_CollisionObject2D>` node.

----

.. _class_ShapeCast2D_method_remove_exception_rid:

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

Removes a collision exception so the shape does report collisions with the specified :ref:`RID<class_RID>`.

----

.. _class_ShapeCast2D_method_set_collision_mask_value:

- void **set_collision_mask_value** **(** :ref:`int<class_int>` layer_number, :ref:`bool<class_bool>` value **)**

Based on ``value``, enables or disables the specified layer in the :ref:`collision_mask<class_ShapeCast2D_property_collision_mask>`, given a ``layer_number`` between 1 and 32.

.. |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.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`